Compare commits

..
56 Commits
Author SHA1 Message Date
Harsha CherukuriandGitHub 0ab4b88d27 Merge pull request #454 from Maestro157/fix/quarkus_flags_molecule
molecule: fix quarkus_flags role lookup and keycloak.conf path
2026-11-20 11:10:18 -05:00
Stefan Krempel 33e7ed3a7e molecule: fix quarkus_flags role lookup and keycloak.conf path
The quarkus_flags scenario added in #445 is the only role-based
scenario without the roles -> ../../roles symlink, so in CI its
converge stops with "the role 'keycloak_quarkus' was not found".

Once the role is found, verify fails next: it reads
/opt/keycloak/keycloak-26.7.3/conf/keycloak.conf, but the scenario
installs the role's default version, which is no longer 26.7.3.

Add the roles symlink the other scenarios use and read keycloak.conf
through the /opt/keycloak/keycloak-*/ glob already used in
molecule/quarkus/verify.yml, so the check does not depend on the
installed version. The assertions are unchanged.
2026-11-20 13:10:15 +01:00
Ranabir ChakrabortyandGitHub 901c21e87e Merge pull request #445 from cihlamar/AMW-653
Add quarkus_flags molecule scenario for untested flag toggles
2026-11-13 18:51:01 +05:30
Ranabir ChakrabortyandGitHub cacc7a2407 Merge pull request #452 from Maestro157/bump/keycloak-26.8.1
Bump Keycloak to 26.8.1 and RHBK to 26.6.7
2026-11-04 20:47:27 +05:30
Stefan Krempel 33c0bfbdec Bump Keycloak to 26.8.1 and RHBK to 26.6.7
Update the keycloak_quarkus role defaults, argument specs, README and
molecule scenarios to the current upstream releases. Keycloak 26.7.4,
26.7.5, 26.8.0 and 26.8.1 together fix more than 40 CVEs, among them
CVE-2026-17526 (impersonation role can impersonate a realm admin) and
CVE-2026-94000 (manage-users delegated admin can become realm-admin).

The RHBK default moves from the 26.4 to the 26.6 stream. RHBK 26.6.7
(RHSA-2026:68278) fixes 28 CVEs; 26.4.16, the latest 26.4 release
from the same day, fixes 7 of them.

- keycloak_quarkus_version: 26.7.3 -> 26.8.1
- rhbk_version: 26.4.15 -> 26.6.7
- molecule/quarkus: SPID provider 26.7.1 -> 26.8.1 (new sha256),
  keycloak-kerberos-federation 26.7.3 -> 26.8.1
- molecule/quarkus_upgrade: prepare on 26.7.3, converge to 26.8.1

JDBC driver defaults are left unchanged; they still match the versions
listed in Red Hat article 7033107 referenced from the defaults file.
2026-11-03 21:41:13 +01:00
Stefan Krempel 731169d452 keycloak_organization: keep unmanaged domain fields when comparing
Keycloak 26.8 added an autoRedirect field to the organization domain
representation. The module compared its own {name, verified} domain
list with the server's {autoRedirect, name, verified} list, so on 26.8
it reported changed on every run, re-sent the organization each time
and reset an autoRedirect value set outside the module.

Overlay the requested domain settings on the domains returned by the
server before comparing. Fields the module does not manage are now kept
as they are, both for the comparison and for the update request.
Behaviour against Keycloak 26.7 and earlier is unchanged.
2026-11-03 21:02:25 +01:00
Martin Cihlar e871df11a1 AMW-653 Add quarkus_flags molecule scenario for untested flag toggles 2026-11-03 18:55:30 +01:00
Ranabir ChakrabortyandGitHub 266e55b92e Merge pull request #448 from mangin/userprofile-required-scopes
keycloak_userprofile: support required.scopes
2026-11-03 12:06:17 +05:30
Aleksandr Mangin 2a7834c5e4 keycloak_userprofile: support required.scopes
Keycloak can require a user profile attribute only when one of the given
client scopes is requested, but the module's argument spec only accepted
required.roles and rejected required.scopes.
2026-11-02 20:21:31 +01:00
Ranabir ChakrabortyandGitHub d172eb9236 Merge pull request #451 from mangin/fix-molecule-containerized-runners
molecule: make scenarios work on containerized CI runners
2026-11-02 23:51:19 +05:30
Aleksandr ManginandClaude Opus 5.5 fa594a57de molecule: address review on containerized CI runners
- drop the debian scenario from CI: the Debian mirrors are blocked on
  the CI network
- quarkus_upgrade, https_revproxy: drop unused fixed published_ports
- debian: fetch the openid configuration from the instance with
  ansible.builtin.uri instead of curl | jq on the controller

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 13:14:36 +01:00
Aleksandr ManginandClaude Opus 5.5 68a1f3d28b molecule: make scenarios work on containerized CI runners
Since the molecule jobs moved to self-hosted container runners, molecule
talks to a Docker daemon that does not share the runner's filesystem or
network namespace:

- quarkus_ha*: drop the postgresql.conf bind mount (the workspace path
  does not exist on the daemon side) and pass listen_addresses via -c
- quarkus, quarkus_devmode: fetch the openid configuration from the
  instance with ansible.builtin.uri instead of curl | jq on the runner,
  and drop the fixed host published_ports that are no longer needed
- quarkus_nohost: add the missing roles symlink

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 09:44:24 +01:00
Ranabir ChakrabortyandGitHub 9c5f03b8be Merge pull request #446 from cihlamar/AMW-578
Fix INJECT_FACTS_AS_VARS deprecation in molecule prepare files
2026-11-01 19:29:20 +05:30
Ranabir ChakrabortyandGitHub 2d01c78590 Merge pull request #444 from FilipeCapela98/fix/442-keycloak-user-check-mode-groups
keycloak_user: fix check mode reporting changed=True for every existing user
2026-11-01 19:24:24 +05:30
Ranabir ChakrabortyandGitHub e7a641cf62 Merge pull request #450 from sarankumar1325/fix-realm-check-mode-changed
keycloak_realm: fix check mode always reporting changed
2026-11-01 19:10:14 +05:30
Ranabir ChakrabortyandGitHub 373b780a5d Merge pull request #440 from ansible-middleware/dependabot/github_actions/ansible-collections/partner-certification-checker/dot-github/workflows/certification-reusable.yml-6.0.0
Bump ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml from 5.0.0 to 6.0.0
2026-11-01 19:04:30 +05:30
sarankumar1325 dc8a6cb02d keycloak_realm: fix check mode always reporting changed
Check mode compared the realm returned by Keycloak with a plain
dict.update() of the module parameters. Keycloak stores attributes,
browserSecurityHeaders and smtpServer as string maps, merges attributes
and browserSecurityHeaders into the existing values and masks the SMTP
password, so the comparison never matched and check mode always
reported a change while a live run reported ok.

Predict the realm Keycloak would return for those maps in check mode
and add molecule checks for unchanged and changed settings.

Fixes #447

Signed-off-by: sarankumar1325 <120080287+sarankumar1325@users.noreply.github.com>
2026-10-30 13:12:39 +00:00
Martin Cihlar 0891945924 AMW-578 Fix INJECT_FACTS_AS_VARS deprecation in molecule prepare files 2026-10-19 17:45:10 +02:00
Ranabir ChakrabortyandGitHub 1ea6285f95 Merge pull request #439 from RanabirChakraborty/AMW-654
AMW-654 keycloak_realms doesn't update default or optional default client scopes
2026-10-16 18:51:07 +05:30
Ranabir Chakraborty a3bd55327d AMW-654 keycloak_realms doesn't update default or optional default client scopes 2026-10-16 02:35:18 +05:30
Filipe Rosa Capela 07438ad4af keycloak_user: fix check mode reporting changed=True for every existing user
In check mode, the desired group memberships were built as a set and
compared with the stored memberships, a list, through is_struct_included().
It has no branch for sets and falls back to comparing their string forms,
which never match, so check mode reported a change for every existing user,
with or without groups.

Check mode now decides like normal mode: a group given by name or by path
counts as joined when the user is already a member. That rule moves from
update_user_groups_membership() into
filter_groups_to_add_to_and_remove_from_user(), which both modes use, and
the groups reported in check mode no longer list a group given by path
twice. Add check mode tests, including groups given by path.

Fixes #442

Signed-off-by: Filipe Rosa Capela <Filipe.Capela-CIC.Netherlands1@ibm.com>
2026-10-13 18:23:51 +02:00
dependabot[bot]andGitHub cd56d694f9 Bump ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml
Bumps [ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml](https://github.com/ansible-collections/partner-certification-checker) from 5.0.0 to 6.0.0.
- [Release notes](https://github.com/ansible-collections/partner-certification-checker/releases)
- [Changelog](https://github.com/ansible-collections/partner-certification-checker/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/ansible-collections/partner-certification-checker/compare/fefb6b967e99964b55665b66ef0d8e4148d84aca...0b3575fff9a50e8057134e01862c52450648c3fc)

---
updated-dependencies:
- dependency-name: ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml
  dependency-version: 6.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-10-13 11:21:00 +00:00
Harsha CherukuriandGitHub 0b6b926b96 Merge pull request #438 from ansible-middleware/bump/3.1.3
Bump version to 3.1.3
2026-10-09 11:00:03 -04:00
ansible-middleware-core 3e4587ec69 Bump version to 3.1.3 2026-10-09 14:58:26 +00:00
Harsha CherukuriandGitHub 7793ecd381 Merge pull request #437 from ansible-middleware/changelog/3.1.2
Update changelog for release 3.1.2
2026-10-09 10:56:59 -04:00
ansible-middleware-core 5cd7f3d147 Update changelog for release 3.1.2
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-10-09 14:40:59 +00:00
Harsha CherukuriandGitHub 39721dff35 Merge pull request #436 from cihlamar/AMW-649
Add missing protocolMappers alias to keycloak_client_scope mo…
2026-10-09 10:39:29 -04:00
Harsha CherukuriandGitHub 6c2ab1e4b9 Merge pull request #409 from cihlamar/AMW-616
Port integration tests from community.general
2026-10-09 10:38:58 -04:00
Martin Cihlar 3218326ac3 AMW-649 Add missing protocolMappers alias to keycloak_client_scope module
The keycloak_client module accepts protocolMappers as an alias for
protocol_mappers, but keycloak_client_scope was missing it.

Fixes #435
2026-10-09 10:53:47 +02:00
Martin Cihlar c51f290d64 AMW-616 Port 24 community.general keycloak integration tests to molecule
Port integration tests from community.general keycloak modules into
the keycloak collection molecule test framework (keycloak_modules
scenario), adapting for KC 26.x behavioral changes and middleware
module differences.

Ported modules: keycloak_authentication, keycloak_authz_authorization_scope,
keycloak_authz_permission, keycloak_client, keycloak_client_rolescope,
keycloak_client_scope_rolemappings, keycloak_client_scope_type,
keycloak_clientsecret_info, keycloak_clientsecret_regenerate,
keycloak_component_info, keycloak_group, keycloak_group_rolemapping,
keycloak_identity_provider, keycloak_modules_authentication,
keycloak_realm, keycloak_realm_key, keycloak_realm_users_info,
keycloak_role, keycloak_user, keycloak_user_federation,
keycloak_user_rolemapping, keycloak_userprofile.

KC 26.x adaptations:
- serviceAccountsEnabled defaults to true on new clients
- Default Policy/Resource no longer auto-created for authz clients
- Built-in admin role rejects PUT updates (403)
- Invalid credentials return HTTP 400 instead of 401
- LDAP federation no longer auto-creates mappers

Other fixes:
- Variable collision avoidance (role/group/client register overwriting
  play-level vars via include_vars)
- Ansible 2.19+ native Jinja dict handling (endpoint combine filter)
- Jinja embedded template warnings in assert expressions
- Auth fallback prevention in invalid-token tests
2026-10-08 20:48:09 +02:00
Ranabir ChakrabortyandGitHub bcddd1b95b Merge pull request #434 from cihlamar/AMW-641 2026-10-06 16:58:52 +05:30
Martin Cihlar e43dcafa9d AMW-641 Clarify health_check_url_path description per review 2026-10-06 10:42:18 +02:00
Harsha CherukuriandGitHub 3f620aaeba Merge pull request #429 from cihlamar/AMW-641
Fix health check URL to use localhost with protocol and port
2026-10-05 19:22:06 -04:00
Harsha CherukuriandGitHub e070def764 Merge pull request #433 from RanabirChakraborty/AMW-644
AMW-644 keycloak_user_federation module always reports task as changed in check mode
2026-10-05 19:18:50 -04:00
Ranabir Chakraborty ed99d28b5d AMW-644 keycloak_user_federation module always reports task as changed in check mode 2026-10-05 19:40:06 +05:30
Martin Cihlar 3e82ac6461 AMW-641 Fix health check URL to use localhost instead of public hostname
Replace hostname-based health check URL with localhost. The health check
runs on the managed host itself, so it should always target localhost
rather than the public-facing keycloak_quarkus_hostname which can be
empty or a domain name behind a load balancer.

Compose the URL directly from existing production variables
(keycloak_quarkus_http_enabled, keycloak_quarkus_http_port,
keycloak_quarkus_https_port, keycloak_quarkus_http_relative_path)
without introducing intermediate variables.

Add .config/molecule/config.yml with shared molecule settings and a new
quarkus_nohost test scenario that verifies the role works when
keycloak_quarkus_hostname is left at its default empty value.

Fixes #428
2026-10-05 15:24:02 +02:00
Harsha CherukuriandGitHub 4b317c46de Merge pull request #430 from RanabirChakraborty/AMW-642
AMW-642 keycloak_identity_provider: add support for Do not store users from transient-users feature
2026-10-01 06:41:16 -04:00
Ranabir Chakraborty bd2c01a588 AMW-642 keycloak_identity_provider: add support for Do not store users from transient-users feature 2026-10-01 00:55:27 +05:30
Harsha CherukuriandGitHub 221b1a7667 Merge pull request #425 from hcherukuri/main
Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND
2026-09-21 08:15:22 -04:00
Harsha Cherukuri d4fea4a5be Fix quarkus molecule verify for JAVA_OPTS sysconfig 2026-09-18 09:30:58 -04:00
Harsha CherukuriandGitHub 8c8eef172d Merge pull request #427 from ansible-middleware/bump/3.1.2
Bump version to 3.1.2
2026-09-18 08:58:33 -04:00
ansible-middleware-core 3b89e5a154 Bump version to 3.1.2 2026-09-18 12:53:05 +00:00
Harsha CherukuriandGitHub a1ed36e919 Merge pull request #426 from ansible-middleware/changelog/3.1.1
Update changelog for release 3.1.1
2026-09-18 08:50:47 -04:00
ansible-middleware-core 37e96d9bc0 Update changelog for release 3.1.1
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-09-18 12:32:53 +00:00
Harsha Cherukuri 8a3ed80b04 Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND 2026-09-17 11:15:47 -04:00
Harsha CherukuriandGitHub d8d36a41a8 Merge pull request #422 from Maestro157/bump/keycloak-26.7.3
Bump Keycloak to 26.7.3 and RHBK to 26.4.15
2026-09-17 08:47:54 -04:00
Harsha CherukuriandGitHub e8031923af Merge pull request #424 from cihlamar/AMW-634
Fix keycloak_quarkus_health_check_url crash when hostname is unset
2026-09-17 08:44:23 -04:00
Harsha CherukuriandGitHub eee2472cd6 Merge pull request #419 from nwintering/main
Add support for the `description` attribute of keycloak groups
2026-09-17 08:43:33 -04:00
Martin Cihlar 45e91f4e3f Fix keycloak_quarkus_health_check_url crash when hostname is unset
Default keycloak_quarkus_hostname to empty string instead of null to
prevent AttributeError when .rstrip() is called on NoneType in the
health_check_url default expression.

Fixes #423
2026-09-17 11:58:29 +02:00
Stefan Krempel f3b484acdd Bump Keycloak to 26.7.3 and RHBK to 26.4.15
Update the keycloak_quarkus role defaults, argument specs, README and
molecule scenarios to the current upstream releases. Keycloak 26.7.2+
and RHBK 26.4.15 fix CVE-2026-18963 (GHSA-4gv3-mc9p-5wqc, CVSS 9.1).

- keycloak_quarkus_version: 26.6.2 -> 26.7.3
- rhbk_version: 26.4.11 -> 26.4.15
- molecule/quarkus: SPID provider 26.5.6 -> 26.7.1 (new sha256),
  keycloak-kerberos-federation 26.6.3 -> 26.7.3
- molecule/quarkus_upgrade: prepare on 26.6.2, converge to 26.7.3

JDBC driver defaults are left unchanged; they still match the versions
listed in Red Hat article 7033107 referenced from the defaults file.
2026-09-15 15:39:42 +02:00
nwintering 7d9e99b370 add missing dot to docu 2026-09-14 16:57:38 +02:00
nwinteringandGitHub 2b4ce2694c Merge branch 'ansible-middleware:main' into main 2026-09-14 16:49:19 +02:00
Harsha CherukuriandGitHub 44e3f0078f Merge pull request #418 from ansible-middleware/dependabot/github_actions/ansible-collections/partner-certification-checker/dot-github/workflows/certification-reusable.yml-5.0.0
Bump ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml from 4.1.0 to 5.0.0
2026-09-14 08:57:53 -04:00
dependabot[bot]andGitHub 034a3bac52 Bump ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml
Bumps [ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml](https://github.com/ansible-collections/partner-certification-checker) from 4.1.0 to 5.0.0.
- [Release notes](https://github.com/ansible-collections/partner-certification-checker/releases)
- [Changelog](https://github.com/ansible-collections/partner-certification-checker/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/ansible-collections/partner-certification-checker/compare/f4bf7ba4d3f008b2db8fc6a812fa3f89fdf42c2e...fefb6b967e99964b55665b66ef0d8e4148d84aca)

---
updated-dependencies:
- dependency-name: ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml
  dependency-version: 5.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-09-14 12:46:56 +00:00
nwintering 2bb6946fb9 Add support for description attribute 2026-09-14 14:44:35 +02:00
Ranabir ChakrabortyandGitHub 48d014cb18 Merge pull request #417 from ansible-middleware/bump/3.1.1
Bump version to 3.1.1
2026-09-11 22:13:53 +05:30
84 changed files with 6824 additions and 2576 deletions
+16
View File
@@ -65,7 +65,11 @@ PYTHONHTTPSVERIFY
# Keycloak-specific
ciba
clusterless
eddsa
multivalued
remembertochangeme
subcomponent
subcomponents
# Molecule / Testing
hspaans
@@ -84,5 +88,17 @@ decomment
# British spellings (from upstream Keycloak docs)
recognises
# Integration test container/variable names
Ceciestes
myidpfromurl
myidprealm
myfed
myldap
rootgrp
subgrp
subsubgrp
subsubsubgrp
Untestes
# Other
rmaster
+1 -1
View File
@@ -22,4 +22,4 @@ concurrency:
# file for each affected ansible-core version (for example, tests/sanity/ignore-2.18.txt).
jobs:
call:
uses: ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml@f4bf7ba4d3f008b2db8fc6a812fa3f89fdf42c2e # v4.1.0
uses: ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml@0b3575fff9a50e8057134e01862c52450648c3fc # v6.0.0
+1 -1
View File
@@ -34,4 +34,4 @@ jobs:
root_permission_varname: 'keycloak_install_requires_become'
debug_verbosity: "${{ github.event.inputs.debug_verbosity }}"
molecule_tests: >-
[ "debian", "sso_test", "quarkus", "quarkus_ha", "quarkus_ha_remote", "quarkus_ha_26.4_below", "default", "quarkus_devmode", "quarkus_upgrade", "keycloak_modules", "quarkus_relpath" ]
[ "sso_test", "quarkus", "quarkus_ha", "quarkus_ha_remote", "quarkus_ha_26.4_below", "default", "quarkus_devmode", "quarkus_upgrade", "keycloak_modules", "quarkus_relpath", "quarkus_nohost", "quarkus_flags" ]
+34
View File
@@ -6,6 +6,40 @@ middleware\_automation.keycloak Release Notes
This changelog describes changes after version 0.2.6.
v3.1.2
======
Major Changes
-------------
- Port integration tests from community.general `#409 <https://github.com/ansible-middleware/keycloak/pull/409>`_
Minor Changes
-------------
- AMW-642 keycloak_identity_provider: add support for Do not store users from transient-users feature `#430 <https://github.com/ansible-middleware/keycloak/pull/430>`_
- AMW-644 keycloak_user_federation module always reports task as changed in check mode `#433 <https://github.com/ansible-middleware/keycloak/pull/433>`_
Bugfixes
--------
- Fix health check URL to use localhost with protocol and port `#429 <https://github.com/ansible-middleware/keycloak/pull/429>`_
- Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND `#425 <https://github.com/ansible-middleware/keycloak/pull/425>`_
v3.1.1
======
Minor Changes
-------------
- Add support for the ``description`` attribute of keycloak groups `#419 <https://github.com/ansible-middleware/keycloak/pull/419>`_
- Bump Keycloak to 26.7.3 and RHBK to 26.4.15 `#422 <https://github.com/ansible-middleware/keycloak/pull/422>`_
Bugfixes
--------
- Fix keycloak_quarkus_health_check_url crash when hostname is unset `#424 <https://github.com/ansible-middleware/keycloak/pull/424>`_
v3.1.0
======
+119 -70
View File
@@ -729,76 +729,6 @@ releases:
- 378.yaml
- 389.yaml
release_date: '2026-08-24'
3.1.0:
changes:
minor_changes:
- '369 add integration tests for keycloak_authentication_v2 `#374 <https://github.com/ansible-middleware/keycloak/pull/374>`_
'
- 'AMW-578 Replace deprecated community.general.yaml callback with result `#413
<https://github.com/ansible-middleware/keycloak/pull/413>`_
'
- 'AMW-615 Inconsistent support of authentication via client credentials `#400
<https://github.com/ansible-middleware/keycloak/pull/400>`_
'
- 'AMW-622 keycloak collection spelling and grammar checking for PRs `#406 <https://github.com/ansible-middleware/keycloak/pull/406>`_
'
- 'AMW-626 keycloak_user_rolemapping raises 403 error code while listing assignable
Roles if invoker lacks view-realm Role `#411 <https://github.com/ansible-middleware/keycloak/pull/411>`_
'
- 'Add use_netrc option to prevent .netrc overriding bearer token `#408 <https://github.com/ansible-middleware/keycloak/pull/408>`_
'
- 'Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter
`#404 <https://github.com/ansible-middleware/keycloak/pull/404>`_
'
- 'Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified
mappers are merged in `#414 <https://github.com/ansible-middleware/keycloak/pull/414>`_
'
- 'Fix issue #397 #398 crash on first role assignment `#405 <https://github.com/ansible-middleware/keycloak/pull/405>`_
'
- 'In a flow definition, handle non-existing keys correctly `#402 <https://github.com/ansible-middleware/keycloak/pull/402>`_
'
- 'Normalize hostname that includes http_relative_path suffix `#392 <https://github.com/ansible-middleware/keycloak/pull/392>`_
'
- 'Replace deprecated top-level fact variables with ansible_fact `#412 <https://github.com/ansible-middleware/keycloak/pull/412>`_
'
- 'authentication_v2: Fix validation for FormActions `#384 <https://github.com/ansible-middleware/keycloak/pull/384>`_
'
- 'keycloak_group: fix subgroup lookup on Keycloak older than 25 `#407 <https://github.com/ansible-middleware/keycloak/pull/407>`_
'
- 'keycloak_user: fix attributes always reporting changed=True `#399 <https://github.com/ansible-middleware/keycloak/pull/399>`_
'
fragments:
- 374.yaml
- 384.yaml
- 392.yaml
- 399.yaml
- 400.yaml
- 402.yaml
- 404.yaml
- 405.yaml
- 406.yaml
- 407.yaml
- 408.yaml
- 411.yaml
- 412.yaml
- 413.yaml
- 414.yaml
release_date: '2026-09-11'
3.0.2:
changes:
bugfixes:
@@ -961,3 +891,122 @@ releases:
fragments:
- 344.yaml
release_date: '2026-06-11'
3.1.0:
changes:
minor_changes:
- '369 add integration tests for keycloak_authentication_v2 `#374 <https://github.com/ansible-middleware/keycloak/pull/374>`_
'
- 'AMW-578 Replace deprecated community.general.yaml callback with result `#413
<https://github.com/ansible-middleware/keycloak/pull/413>`_
'
- 'AMW-615 Inconsistent support of authentication via client credentials `#400
<https://github.com/ansible-middleware/keycloak/pull/400>`_
'
- 'AMW-622 keycloak collection spelling and grammar checking for PRs `#406 <https://github.com/ansible-middleware/keycloak/pull/406>`_
'
- 'AMW-626 keycloak_user_rolemapping raises 403 error code while listing assignable
Roles if invoker lacks view-realm Role `#411 <https://github.com/ansible-middleware/keycloak/pull/411>`_
'
- 'Add use_netrc option to prevent .netrc overriding bearer token `#408 <https://github.com/ansible-middleware/keycloak/pull/408>`_
'
- 'Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter
`#404 <https://github.com/ansible-middleware/keycloak/pull/404>`_
'
- 'Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified
mappers are merged in `#414 <https://github.com/ansible-middleware/keycloak/pull/414>`_
'
- 'Fix issue #397 #398 crash on first role assignment `#405 <https://github.com/ansible-middleware/keycloak/pull/405>`_
'
- 'In a flow definition, handle non-existing keys correctly `#402 <https://github.com/ansible-middleware/keycloak/pull/402>`_
'
- 'Normalize hostname that includes http_relative_path suffix `#392 <https://github.com/ansible-middleware/keycloak/pull/392>`_
'
- 'Replace deprecated top-level fact variables with ansible_fact `#412 <https://github.com/ansible-middleware/keycloak/pull/412>`_
'
- 'authentication_v2: Fix validation for FormActions `#384 <https://github.com/ansible-middleware/keycloak/pull/384>`_
'
- 'keycloak_group: fix subgroup lookup on Keycloak older than 25 `#407 <https://github.com/ansible-middleware/keycloak/pull/407>`_
'
- 'keycloak_user: fix attributes always reporting changed=True `#399 <https://github.com/ansible-middleware/keycloak/pull/399>`_
'
fragments:
- 374.yaml
- 384.yaml
- 392.yaml
- 399.yaml
- 400.yaml
- 402.yaml
- 404.yaml
- 405.yaml
- 406.yaml
- 407.yaml
- 408.yaml
- 411.yaml
- 412.yaml
- 413.yaml
- 414.yaml
release_date: '2026-09-11'
3.1.1:
changes:
bugfixes:
- 'Fix keycloak_quarkus_health_check_url crash when hostname is unset `#424
<https://github.com/ansible-middleware/keycloak/pull/424>`_
'
minor_changes:
- 'Add support for the ``description`` attribute of keycloak groups `#419 <https://github.com/ansible-middleware/keycloak/pull/419>`_
'
- 'Bump Keycloak to 26.7.3 and RHBK to 26.4.15 `#422 <https://github.com/ansible-middleware/keycloak/pull/422>`_
'
fragments:
- 419.yaml
- 422.yaml
- 424.yaml
release_date: '2026-09-18'
3.1.2:
changes:
bugfixes:
- 'Fix health check URL to use localhost with protocol and port `#429 <https://github.com/ansible-middleware/keycloak/pull/429>`_
'
- 'Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP
and JAVA_OPTS_APPEND `#425 <https://github.com/ansible-middleware/keycloak/pull/425>`_
'
major_changes:
- 'Port integration tests from community.general `#409 <https://github.com/ansible-middleware/keycloak/pull/409>`_
'
minor_changes:
- 'AMW-642 keycloak_identity_provider: add support for Do not store users from
transient-users feature `#430 <https://github.com/ansible-middleware/keycloak/pull/430>`_
'
- 'AMW-644 keycloak_user_federation module always reports task as changed in
check mode `#433 <https://github.com/ansible-middleware/keycloak/pull/433>`_
'
fragments:
- 409.yaml
- 425.yaml
- 429.yaml
- 430.yaml
- 433.yaml
release_date: '2026-10-09'
+1 -1
View File
@@ -1,7 +1,7 @@
---
namespace: middleware_automation
name: keycloak
version: "3.1.1"
version: "3.1.3"
readme: README.md
authors:
- Romain Pelisse <rpelisse@redhat.com>
+14 -16
View File
@@ -1,22 +1,20 @@
v3.1.0
v3.1.2
======
Major Changes
-------------
- Port integration tests from community.general #409
Minor Changes
-------------
- 369 add integration tests for keycloak_authentication_v2 #374
- AMW-578 Replace deprecated community.general.yaml callback with result #413
- AMW-615 Inconsistent support of authentication via client credentials #400
- AMW-622 keycloak collection spelling and grammar checking for PRs #406
- AMW-626 keycloak_user_rolemapping raises 403 error code while listing assignable Roles if invoker lacks view-realm Role #411
- Add use_netrc option to prevent .netrc overriding bearer token #408
- Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter #404
- Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified mappers are merged in #414
- Fix issue #397 #398 crash on first role assignment #405
- In a flow definition, handle non-existing keys correctly #402
- Normalize hostname that includes http_relative_path suffix #392
- Replace deprecated top-level fact variables with ansible_fact #412
- authentication_v2: Fix validation for FormActions #384
- keycloak_group: fix subgroup lookup on Keycloak older than 25 #407
- keycloak_user: fix attributes always reporting changed=True #399
- AMW-642 keycloak_identity_provider: add support for Do not store users from transient-users feature #430
- AMW-644 keycloak_user_federation module always reports task as changed in check mode #433
Bugfixes
--------
- Fix health check URL to use localhost with protocol and port #429
- Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND #425
+7 -13
View File
@@ -18,23 +18,17 @@
- name: Verify openid config
block:
- name: Fetch openID config # noqa blocked_modules command-instead-of-module
ansible.builtin.shell: |
set -o pipefail
curl http://localhost:8080/realms/master/.well-known/openid-configuration -k | jq .
args:
executable: /bin/bash
delegate_to: localhost
- name: Fetch openID config
ansible.builtin.uri:
url: http://localhost:8080/realms/master/.well-known/openid-configuration
register: openid_config
changed_when: False
- name: Verify endpoint URLs
ansible.builtin.assert:
that:
- (openid_config.stdout | from_json)["backchannel_authentication_endpoint"] == 'http://localhost:8080/realms/master/protocol/openid-connect/ext/ciba/auth'
- (openid_config.stdout | from_json)['issuer'] == 'http://localhost:8080/realms/master'
- (openid_config.stdout | from_json)['authorization_endpoint'] == 'http://localhost:8080/realms/master/protocol/openid-connect/auth'
- (openid_config.stdout | from_json)['token_endpoint'] == 'http://localhost:8080/realms/master/protocol/openid-connect/token'
delegate_to: localhost
- openid_config.json["backchannel_authentication_endpoint"] == 'http://localhost:8080/realms/master/protocol/openid-connect/ext/ciba/auth'
- openid_config.json['issuer'] == 'http://localhost:8080/realms/master'
- openid_config.json['authorization_endpoint'] == 'http://localhost:8080/realms/master/protocol/openid-connect/auth'
- openid_config.json['token_endpoint'] == 'http://localhost:8080/realms/master/protocol/openid-connect/token'
when:
- hera_home is defined
- hera_home | length == 0
+4 -4
View File
@@ -20,7 +20,7 @@
- name: Download keycloak archive to controller directory
ansible.builtin.get_url: # noqa risky-file-permissions delegated, uses controller host user
url: https://github.com/keycloak/keycloak/releases/download/26.6.2/keycloak-26.6.2.zip
url: https://github.com/keycloak/keycloak/releases/download/26.8.1/keycloak-26.8.1.zip
dest: /tmp/keycloak
mode: '0640'
validate_certs: false
@@ -38,7 +38,7 @@
client_id: "{{ rhn_username }}"
client_secret: "{{ rhn_password }}"
product_type: DISTRIBUTION
product_version: "{{ keycloak_quarkus_version | default('26.6.2') }}"
product_version: "{{ keycloak_quarkus_version | default('26.8.1') }}"
product_category: "RHBK"
register: rhn_products
no_log: "{{ omit_rhn_output | default(true) }}"
@@ -48,7 +48,7 @@
- name: Determine install zipfile from search results
ansible.builtin.set_fact:
rhn_matched_products: "{{ rhn_products.results | selectattr('file_name', 'match', '.*keycloak-' + (keycloak_quarkus_version | default('26.6.2')) + '.zip$') }}"
rhn_matched_products: "{{ rhn_products.results | selectattr('file_name', 'match', '.*keycloak-' + (keycloak_quarkus_version | default('26.8.1')) + '.zip$') }}"
delegate_to: localhost
run_once: true
when:
@@ -60,7 +60,7 @@
client_id: "{{ rhn_username }}"
client_secret: "{{ rhn_password }}"
product_id: "{{ (rhn_matched_products | first).id }}"
dest: "/tmp/keycloak/keycloak-{{ keycloak_quarkus_version | default('26.6.2') }}.zip"
dest: "/tmp/keycloak/keycloak-{{ keycloak_quarkus_version | default('26.8.1') }}.zip"
no_log: "{{ omit_rhn_output | default(true) }}"
delegate_to: localhost
run_once: true
-4
View File
@@ -11,8 +11,6 @@ platforms:
- name: keycloak
exposed_ports:
- "8080/tcp"
published_ports:
- 0.0.0.0:8080:8080/tcp
- name: proxy
image: registry.access.redhat.com/ubi9/ubi-init:latest
pre_build_image: true
@@ -22,8 +20,6 @@ platforms:
- name: keycloak
exposed_ports:
- "443/tcp"
published_ports:
- 0.0.0.0:443:443/tcp
provisioner:
name: ansible
config_options:
@@ -0,0 +1,131 @@
---
# Ported from community.general tests/integration/targets/keycloak_authentication
# Tests authentication flow CRUD: create from copy, create with conditional OTP,
# update config, verify config uniqueness via realm export, and delete.
- name: Set auth flow test variables
ansible.builtin.set_fact:
keycloak_no_otp_required_pattern_original: 'X-Forwarded-For: 10\.[0-9\.:]+'
keycloak_no_otp_required_pattern_modified: 'X-Original-Forwarded-For: 10\.[0-9\.:]+'
- name: Create auth flow from first broker login copy
middleware_automation.keycloak.keycloak_authentication:
realm: "{{ ephemeral_realm }}"
alias: "Test first broker login"
copyFrom: "first broker login"
authenticationExecutions:
- providerId: "idp-review-profile"
requirement: "REQUIRED"
authenticationConfig:
alias: "Test review profile config"
config:
update.profile.on.first.login: "missing"
- name: Create conditional OTP auth flow
middleware_automation.keycloak.keycloak_authentication:
realm: "{{ ephemeral_realm }}"
alias: "My conditional browser otp"
description: "browser based authentication with otp"
providerId: "basic-flow"
authenticationExecutions:
- displayName: Cookie
providerId: auth-cookie
requirement: ALTERNATIVE
- displayName: Kerberos
providerId: auth-spnego
requirement: DISABLED
- displayName: Identity Provider Redirector
providerId: identity-provider-redirector
requirement: ALTERNATIVE
- displayName: My browser otp forms
requirement: ALTERNATIVE
- displayName: Username Password Form
flowAlias: My browser otp forms
providerId: auth-username-password-form
requirement: REQUIRED
- displayName: My browser otp Browser - Conditional OTP
flowAlias: My browser otp forms
requirement: REQUIRED
providerId: "auth-conditional-otp-form"
authenticationConfig:
alias: my-conditional-otp-config
config:
defaultOtpOutcome: "force"
noOtpRequiredForHeaderPattern: "{{ keycloak_no_otp_required_pattern_original }}"
state: present
- name: Update conditional OTP auth flow config
middleware_automation.keycloak.keycloak_authentication:
realm: "{{ ephemeral_realm }}"
alias: "My conditional browser otp"
description: "browser based authentication with otp"
providerId: "basic-flow"
authenticationExecutions:
- displayName: Cookie
providerId: auth-cookie
requirement: ALTERNATIVE
- displayName: Kerberos
providerId: auth-spnego
requirement: DISABLED
- displayName: Identity Provider Redirector
providerId: identity-provider-redirector
requirement: ALTERNATIVE
- displayName: My browser otp forms
requirement: ALTERNATIVE
- displayName: Username Password Form
flowAlias: My browser otp forms
providerId: auth-username-password-form
requirement: REQUIRED
- displayName: My browser otp Browser - Conditional OTP
flowAlias: My browser otp forms
requirement: REQUIRED
providerId: "auth-conditional-otp-form"
authenticationConfig:
alias: my-conditional-otp-config
config:
defaultOtpOutcome: "force"
noOtpRequiredForHeaderPattern: "{{ keycloak_no_otp_required_pattern_modified }}"
state: present
register: result
- name: Get access token for realm export
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/realms/{{ auth_realm }}/protocol/openid-connect/token"
method: POST
status_code: 200
body_format: form-urlencoded
body:
grant_type: "password"
client_id: "admin-cli"
username: "{{ auth_username }}"
password: "{{ auth_password }}"
register: token_response
- name: Extract access token
ansible.builtin.set_fact:
access_token: "{{ token_response.json.access_token }}"
- name: Export ephemeral realm
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ ephemeral_realm }}/partial-export?exportClients=false&exportGroupsAndRoles=false"
method: POST
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
body_format: form-urlencoded
body: {}
register: exported_realm
no_log: true
- name: Assert my-conditional-otp-config exists only once
ansible.builtin.assert:
that:
- exported_realm.json.authenticatorConfig | selectattr('alias', 'equalto', 'my-conditional-otp-config') | list | length == 1
- name: Delete conditional OTP auth flow
middleware_automation.keycloak.keycloak_authentication:
realm: "{{ ephemeral_realm }}"
alias: "My conditional browser otp"
state: absent
register: result
@@ -0,0 +1,164 @@
---
# Ported from community.general tests/integration/targets/keycloak_authz_authorization_scope
# Tests full CRUD lifecycle with check_mode, diff, and idempotency.
- name: Create authorization scope (check mode)
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
display_name: "File delete"
icon_uri: "http://localhost/icon.png"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
check_mode: true
diff: true
register: result
- name: Assert scope not created in check mode
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- result.msg == 'Authorization scope would be created'
- result.diff.before == {}
- result.diff.after.name == 'file:delete'
- result.diff.after.displayName == 'File delete'
- result.diff.after.iconUri == 'http://localhost/icon.png'
- name: Create authorization scope
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
display_name: "File delete"
icon_uri: "http://localhost/icon.png"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "file:delete"
- result.end_state.iconUri == "http://localhost/icon.png"
- result.end_state.displayName == "File delete"
- name: Create authorization scope (idempotency)
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
display_name: "File delete"
icon_uri: "http://localhost/icon.png"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.name == "file:delete"
- result.end_state.iconUri == "http://localhost/icon.png"
- result.end_state.displayName == "File delete"
- name: Update scope - remove optional params (check mode)
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
diff: true
check_mode: true
register: result
- name: Assert scope not updated in check mode
ansible.builtin.assert:
that:
- result is changed
- result.msg == 'Authorization scope would be updated'
- result.diff.before.displayName == 'File delete'
- result.diff.before.iconUri == 'http://localhost/icon.png'
- result.diff.after.displayName == ''
- result.diff.after.iconUri == ''
- name: Update scope - remove optional params
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert optional params removed
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "file:delete"
- result.end_state.iconUri == ""
- result.end_state.displayName == ""
- name: Update scope - idempotency after removal
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope unchanged after update
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.name == "file:delete"
- result.end_state.iconUri == ""
- result.end_state.displayName == ""
- name: Remove scope (check mode)
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: absent
name: "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
diff: true
check_mode: true
register: result
- name: Assert scope not removed in check mode
ansible.builtin.assert:
that:
- result is changed
- result.msg == 'Authorization scope would be removed'
- result.diff.before.name == 'file:delete'
- result.diff.after == {}
- name: Remove scope
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: absent
name: "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope removed
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Remove scope (idempotency)
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: absent
name: "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope already absent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
@@ -0,0 +1,489 @@
---
# Ported from community.general tests/integration/targets/keycloak_authz_permission
# Tests error paths, scope permission CRUD, resource permission CRUD, permission_info queries.
# KC 26.x no longer auto-creates "Default Policy" and "Default Resource"
# when authorization services are enabled via API.
- name: Obtain access token for policy setup
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/realms/{{ auth_realm }}/protocol/openid-connect/token"
method: POST
body_format: form-urlencoded
body:
grant_type: password
client_id: admin-cli
username: "{{ auth_username }}"
password: "{{ auth_password }}"
validate_certs: false
register: authz_perm_token
- name: Look up client UUID
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/clients?clientId={{ client }}"
headers:
Authorization: "Bearer {{ authz_perm_token.json.access_token }}"
validate_certs: false
register: authz_perm_client
- name: Ensure Default Policy exists (role-based positive policy)
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/clients/{{ authz_perm_client.json[0].id }}/authz/resource-server/policy/role"
method: POST
headers:
Authorization: "Bearer {{ authz_perm_token.json.access_token }}"
Content-Type: application/json
body_format: json
body:
name: "Default Policy"
description: "A default policy"
logic: POSITIVE
roles: []
status_code: [201, 409]
validate_certs: false
- name: Ensure Default Resource exists
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/clients/{{ authz_perm_client.json[0].id }}/authz/resource-server/resource"
method: POST
headers:
Authorization: "Bearer {{ authz_perm_token.json.access_token }}"
Content-Type: application/json
body_format: json
body:
name: "Default Resource"
type: "urn:molecule-client:resources:default"
uris:
- "/*"
status_code: [201, 409]
validate_certs: false
- name: Create file:create authorization scope
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:create"
display_name: "File create"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
- name: Create file:delete authorization scope
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
display_name: "File delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
# --- Error paths ---
- name: Create permission without type (test for failure)
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ScopePermission"
description: "Scope permission"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
failed_when: result.msg.find('missing required arguments') == -1
- name: Create scope permission without scopes (test for failure)
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ScopePermission"
description: "Scope permission"
permission_type: scope
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
failed_when: result.msg.find('Scopes need to defined when permission type is set to scope!') == -1
- name: Create scope permission with multiple resources (test for failure)
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ScopePermission"
description: "Scope permission"
resources:
- "Default Resource"
- "Other Resource"
permission_type: scope
scopes:
- "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
failed_when: result.msg.find('Only one resource can be defined for a scope permission!') == -1
- name: Create scope permission with invalid policy name (test for failure)
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ScopePermission"
description: "Scope permission"
permission_type: scope
scopes:
- "file:delete"
policies:
- "Missing Policy"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
failed_when: result.msg.find('Unable to find authorization policy with name') == -1
# --- Scope permission CRUD ---
- name: Create scope permission
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ScopePermission"
description: "Scope permission"
permission_type: scope
scopes:
- "file:delete"
policies:
- "Default Policy"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope permission was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "ScopePermission"
- result.end_state.description == "Scope permission"
- result.end_state.type == "scope"
- result.end_state.resources == []
- result.end_state.policies | length == 1
- result.end_state.scopes | length == 1
- name: Query scope permission state
middleware_automation.keycloak.keycloak_authz_permission_info:
name: "ScopePermission"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert queried state matches
ansible.builtin.assert:
that:
- result.queried_state.name == "ScopePermission"
- result.queried_state.description == "Scope permission"
- name: Create scope permission (idempotency)
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ScopePermission"
description: "Scope permission"
permission_type: scope
scopes:
- "file:delete"
policies:
- "Default Policy"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope permission unchanged
ansible.builtin.assert:
that:
- result.end_state != {}
- result.end_state.name == "ScopePermission"
- result.end_state.description == "Scope permission"
- result.end_state.type == "scope"
- result.end_state.resources == []
- result.end_state.policies | length == 1
- result.end_state.scopes | length == 1
- name: Query scope permission state after idempotency
middleware_automation.keycloak.keycloak_authz_permission_info:
name: "ScopePermission"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert queried state matches after idempotency
ansible.builtin.assert:
that:
- result.queried_state.name == "ScopePermission"
- result.queried_state.description == "Scope permission"
- name: Update scope permission
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ScopePermission"
description: "Scope permission changed"
permission_type: scope
decision_strategy: 'AFFIRMATIVE'
scopes:
- "file:create"
- "file:delete"
policies: []
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope permission updated
ansible.builtin.assert:
that:
- result.changed == True
- result.end_state != {}
- result.end_state.scopes | length == 2
- result.end_state.policies == []
- result.end_state.resources == []
- result.end_state.name == "ScopePermission"
- result.end_state.description == "Scope permission changed"
- name: Query updated scope permission state
middleware_automation.keycloak.keycloak_authz_permission_info:
name: "ScopePermission"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert queried state matches after update
ansible.builtin.assert:
that:
- result.queried_state.name == "ScopePermission"
- result.queried_state.description == "Scope permission changed"
- name: Update scope permission (idempotency)
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ScopePermission"
description: "Scope permission changed"
permission_type: scope
decision_strategy: 'AFFIRMATIVE'
scopes:
- "file:create"
- "file:delete"
policies: []
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope permission update idempotent
ansible.builtin.assert:
that:
- result.changed == True
- result.end_state != {}
- result.end_state.scopes | length == 2
- result.end_state.policies == []
- result.end_state.resources == []
- result.end_state.name == "ScopePermission"
- result.end_state.description == "Scope permission changed"
- name: Query scope permission state after update idempotency
middleware_automation.keycloak.keycloak_authz_permission_info:
name: "ScopePermission"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert queried state matches after update idempotency
ansible.builtin.assert:
that:
- result.queried_state.name == "ScopePermission"
- result.queried_state.description == "Scope permission changed"
- name: Remove scope permission
middleware_automation.keycloak.keycloak_authz_permission:
state: absent
name: "ScopePermission"
permission_type: scope
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope permission removed
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Remove scope permission (idempotency)
middleware_automation.keycloak.keycloak_authz_permission:
state: absent
name: "ScopePermission"
permission_type: scope
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope permission already absent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
# --- Resource permission error paths ---
- name: Create resource permission without resources (test for failure)
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ResourcePermission"
description: "Resource permission"
permission_type: resource
policies:
- "Default Policy"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
failed_when: result.msg.find('A resource need to defined when permission type is set to resource!') == -1
- name: Create resource permission with scopes (test for failure)
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ResourcePermission"
description: "Resource permission"
permission_type: resource
resources:
- "Default Resource"
policies:
- "Default Policy"
scopes:
- "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
failed_when: result.msg.find('Scopes cannot be defined when permission type is set to resource!') == -1
# --- Resource permission CRUD ---
- name: Create resource permission
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ResourcePermission"
description: "Resource permission"
resources:
- "Default Resource"
permission_type: resource
policies:
- "Default Policy"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert resource permission was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.policies | length == 1
- result.end_state.resources | length == 1
- result.end_state.name == "ResourcePermission"
- result.end_state.description == "Resource permission"
- name: Query resource permission state
middleware_automation.keycloak.keycloak_authz_permission_info:
name: "ResourcePermission"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert queried resource state matches
ansible.builtin.assert:
that:
- result.queried_state.name == "ResourcePermission"
- result.queried_state.description == "Resource permission"
- name: Create resource permission (idempotency)
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ResourcePermission"
description: "Resource permission"
resources:
- "Default Resource"
permission_type: resource
policies:
- "Default Policy"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert resource permission unchanged
ansible.builtin.assert:
that:
- result.end_state != {}
- result.end_state.policies | length == 1
- result.end_state.resources | length == 1
- result.end_state.name == "ResourcePermission"
- result.end_state.description == "Resource permission"
- name: Query resource permission state after idempotency
middleware_automation.keycloak.keycloak_authz_permission_info:
name: "ResourcePermission"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert queried resource state matches after idempotency
ansible.builtin.assert:
that:
- result.queried_state.name == "ResourcePermission"
- result.queried_state.description == "Resource permission"
- name: Update resource permission
middleware_automation.keycloak.keycloak_authz_permission:
state: present
name: "ResourcePermission"
description: "Resource permission changed"
resources:
- "Default Resource"
permission_type: resource
policies: []
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert resource permission updated
ansible.builtin.assert:
that:
- result.changed == True
- result.end_state != {}
- result.end_state.policies == []
- result.end_state.resources | length == 1
- result.end_state.name == "ResourcePermission"
- result.end_state.description == "Resource permission changed"
- name: Query updated resource permission state
middleware_automation.keycloak.keycloak_authz_permission_info:
name: "ResourcePermission"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert queried resource state matches after update
ansible.builtin.assert:
that:
- result.queried_state.name == "ResourcePermission"
- result.queried_state.description == "Resource permission changed"
- name: Remove resource permission
middleware_automation.keycloak.keycloak_authz_permission:
state: absent
name: "ResourcePermission"
permission_type: resource
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert resource permission removed
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Remove resource permission (idempotency)
middleware_automation.keycloak.keycloak_authz_permission:
state: absent
name: "ResourcePermission"
permission_type: resource
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert resource permission already absent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
@@ -0,0 +1,84 @@
---
client_id: myclient
client_id_2: mynewclient
post_logout_redirect_uris:
- "https://example.com/logout-callback"
- "https://example.com/signout"
backchannel_logout_url: "https://example.com/backchannel-logout"
redirect_uris1:
- "http://example.c.com/"
- "http://example.b.com/"
- "http://example.a.com/"
client_attributes1: {"backchannel.logout.session.required": true, "backchannel.logout.revoke.offline.tokens": false, "oauth2.device.authorization.grant.enabled": true, "client.secret.creation.time": 0}
client_attributes2: {"backchannel.logout.session.required": false, "oauth2.device.authorization.grant.enabled": false, "client.secret.creation.time": 0}
protocol_mappers1:
- name: 'email'
protocol: 'openid-connect'
protocolMapper: 'oidc-usermodel-property-mapper'
config:
"claim.name": "email"
"user.attribute": "email"
"jsonType.label": "String"
"id.token.claim": true
"access.token.claim": true
"userinfo.token.claim": true
- name: 'email_verified'
protocol: 'openid-connect'
protocolMapper: 'oidc-usermodel-property-mapper'
config:
"claim.name": "email_verified"
"user.attribute": "emailVerified"
"jsonType.label": "boolean"
"id.token.claim": true
"access.token.claim": true
"userinfo.token.claim": true
- name: 'family_name'
protocol: 'openid-connect'
protocolMapper: 'oidc-usermodel-property-mapper'
config:
"claim.name": "family_name"
"user.attribute": "lastName"
"jsonType.label": "String"
"id.token.claim": "true"
"access.token.claim": "true"
"userinfo.token.claim": "true"
protocol_mappers2_unordered:
- "{{ protocol_mappers1[2] }}"
- "{{ protocol_mappers1[1] }}"
- "{{ protocol_mappers1[0] }}"
protocol_mappers3_modifed:
- "{{ protocol_mappers1[2] }}"
- name: address
protocol: openid-connect
protocolMapper: oidc-address-mapper
consentRequired: false
config:
user.attribute.formatted: formatted
user.attribute.country: country
introspection.token.claim: 'true'
user.attribute.postal_code: postal_code
userinfo.token.claim: 'true'
user.attribute.street: street
id.token.claim: 'true'
user.attribute.region: region
access.token.claim: 'true'
user.attribute.locality: locality
- name: 'email'
protocol: 'openid-connect'
protocolMapper: 'oidc-usermodel-property-mapper'
config:
"claim.name": "email"
"user.attribute": "email"
"jsonType.label": "String"
"id.token.claim": true
"access.token.claim": false
"userinfo.token.claim": true
@@ -0,0 +1,409 @@
---
# Ported from community.general tests/integration/targets/keycloak_client
# Tests protocol_mapper CRUD, flow binding overrides, client_scopes_behavior,
# attribute updates, and post-logout redirect URIs / backchannel logout URL.
- name: Load client test variables
ansible.builtin.include_vars:
file: vars.yml
# --- Protocol mapper create, idempotency, and modification ---
- name: Desire client
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
register: desire_client_not_present
- name: Desire client again with same props
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
register: desire_client_when_present_and_same
- name: Check client again with same props
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers2_unordered }}"
authorization_services_enabled: false
check_mode: true
register: check_client_when_present_and_same
- name: Assert changes not detected in last two tasks (desire when same, and check)
ansible.builtin.assert:
that:
- desire_client_when_present_and_same is not changed
- check_client_when_present_and_same is not changed
- name: Check client again with changed props
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
authorization_services_enabled: false
service_accounts_enabled: false
check_mode: true
register: check_client_when_present_and_changed
- name: Assert changes detected in last tasks
ansible.builtin.assert:
that:
- check_client_when_present_and_changed is changed
- name: Check client with modified protocol_mappers idempotence
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers3_modifed }}"
authorization_services_enabled: false
service_accounts_enabled: true
register: check_client_protocol_mappers_idempotence
- name: Assert idempotence changes to protocol_mappers
ansible.builtin.assert:
that:
- check_client_protocol_mappers_idempotence is changed
- end_state.protocolMappers | length == 3
- end_state.protocolMappers | selectattr('name', 'equalto', 'email_verified') | list | length == 0
- end_state.protocolMappers | selectattr('name', 'equalto', 'address') | list | length == 1
- end_state.protocolMappers | selectattr('name', 'equalto', 'email') | list | length == 1
- end_state.protocolMappers | selectattr('name', 'equalto', 'family_name') | list | length == 1
- email.config is defined
- email.config['access.token.claim'] == "false"
vars:
end_state: "{{ check_client_protocol_mappers_idempotence.end_state }}"
email: "{{ end_state.protocolMappers | selectattr('name', 'equalto', 'email') | first | default({}) }}"
# --- Flow binding overrides ---
- name: Desire client with flow binding overrides
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
authentication_flow_binding_overrides:
browser_name: browser
direct_grant_name: direct grant
register: desire_client_with_flow_binding_overrides
- name: Assert flows are set
ansible.builtin.assert:
that:
- desire_client_with_flow_binding_overrides is changed
- "'authenticationFlowBindingOverrides' in desire_client_with_flow_binding_overrides.end_state"
- desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.browser | length > 0
- desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.direct_grant | length > 0
- name: Backup flow UUIDs
ansible.builtin.set_fact:
flow_browser_uuid: "{{ desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.browser }}"
flow_direct_grant_uuid: "{{ desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.direct_grant }}"
- name: Desire client with flow binding overrides remove direct_grant_name
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
authentication_flow_binding_overrides:
browser_name: browser
register: desire_client_with_flow_binding_overrides
- name: Assert flows are updated
ansible.builtin.assert:
that:
- desire_client_with_flow_binding_overrides is changed
- "'authenticationFlowBindingOverrides' in desire_client_with_flow_binding_overrides.end_state"
- desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.browser | length > 0
- "'direct_grant' not in desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides"
- name: Desire client with flow binding overrides remove browser add direct_grant
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
authentication_flow_binding_overrides:
direct_grant_name: direct grant
register: desire_client_with_flow_binding_overrides
- name: Assert flows are updated
ansible.builtin.assert:
that:
- desire_client_with_flow_binding_overrides is changed
- "'authenticationFlowBindingOverrides' in desire_client_with_flow_binding_overrides.end_state"
- "'browser' not in desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides"
- desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.direct_grant | length > 0
- name: Desire client with flow binding overrides with UUIDs
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
authentication_flow_binding_overrides:
browser: "{{ flow_browser_uuid }}"
direct_grant: "{{ flow_direct_grant_uuid }}"
register: desire_client_with_flow_binding_overrides
- name: Assert flows are updated
ansible.builtin.assert:
that:
- desire_client_with_flow_binding_overrides is changed
- "'authenticationFlowBindingOverrides' in desire_client_with_flow_binding_overrides.end_state"
- desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.browser == flow_browser_uuid
- desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.direct_grant == flow_direct_grant_uuid
- name: Unset flow binding overrides
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
authentication_flow_binding_overrides:
browser: "{{ None }}"
direct_grant: null
register: desire_client_with_flow_binding_overrides
- name: Assert flows are removed
ansible.builtin.assert:
that:
- desire_client_with_flow_binding_overrides is changed
- "'authenticationFlowBindingOverrides' in desire_client_with_flow_binding_overrides.end_state"
- "'browser' not in desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides"
- "'direct_grant' not in desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides"
# --- Client scopes behavior ---
- name: Create a scope1 client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ ephemeral_realm }}"
name: scope1
description: "test 1"
protocol: openid-connect
- name: Create a scope2 client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ ephemeral_realm }}"
name: scope2
description: "test 2"
protocol: openid-connect
- name: Create a scope3 client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ ephemeral_realm }}"
name: scope3
description: "test 3"
protocol: openid-connect
- name: Create Keycloak client with default_client_scopes (idempotent behavior)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_scopes_behavior: idempotent
default_client_scopes: ['scope1']
optional_client_scopes: ['scope2']
client_id: testSD-bug
state: present
register: desire_client_with_default_client_scopes
- name: Assert default_client_scopes and optional_client_scopes are set correctly
ansible.builtin.assert:
that:
- desire_client_with_default_client_scopes is changed
- '"scope1" in end_state.defaultClientScopes'
- '"scope2" in end_state.optionalClientScopes'
- end_state.defaultClientScopes | length == 1
- end_state.optionalClientScopes | length == 1
vars:
end_state: "{{ desire_client_with_default_client_scopes.end_state }}"
- name: Update Keycloak client with new scopes (ignore behavior, check mode)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
default_client_scopes: ['scope3']
optional_client_scopes: ['scope3']
client_id: testSD-bug
state: present
check_mode: true
register: desire_client_with_default_client_scopes
- name: Assert client scopes remain unchanged with ignore behavior
ansible.builtin.assert:
that:
- desire_client_with_default_client_scopes is not changed
- end_state.defaultClientScopes | length == 1
- end_state.optionalClientScopes | length == 1
- '"scope1" in end_state.defaultClientScopes'
- '"scope2" in end_state.optionalClientScopes'
vars:
end_state: "{{ desire_client_with_default_client_scopes.end_state }}"
- name: Update Keycloak client with conflicting scopes (patch behavior, should fail)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_scopes_behavior: patch
default_client_scopes: ['scope3']
optional_client_scopes: ['scope1', 'scope2', 'scope3']
client_id: testSD-bug
state: present
ignore_errors: true
register: desire_client_with_default_client_scopes
- name: Assert patch behavior fails when scope is both default and optional
ansible.builtin.assert:
that:
- desire_client_with_default_client_scopes is failed
- "'scope3' in desire_client_with_default_client_scopes.msg"
- name: Update Keycloak client with new scopes (patch behavior)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_scopes_behavior: patch
default_client_scopes: ['scope1', 'scope3']
optional_client_scopes: []
client_id: testSD-bug
state: present
register: desire_client_with_default_client_scopes
- name: Assert client scopes are patched correctly
ansible.builtin.assert:
that:
- desire_client_with_default_client_scopes is changed
- end_state.defaultClientScopes | length == 2
- end_state.optionalClientScopes | length == 1
- '"scope1" in end_state.defaultClientScopes'
- '"scope3" in end_state.defaultClientScopes'
- '"scope2" in end_state.optionalClientScopes'
vars:
end_state: "{{ desire_client_with_default_client_scopes.end_state }}"
- name: Update Keycloak client with empty default_client_scopes (idempotent behavior)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_scopes_behavior: idempotent
default_client_scopes: []
optional_client_scopes: ['scope3']
client_id: testSD-bug
state: present
register: desire_client_with_default_client_scopes
- name: Assert idempotent behavior with empty default_client_scopes
ansible.builtin.assert:
that:
- desire_client_with_default_client_scopes is changed
- end_state.defaultClientScopes | length == 0
- end_state.optionalClientScopes | length == 1
- '"scope3" in end_state.optionalClientScopes'
vars:
end_state: "{{ desire_client_with_default_client_scopes.end_state }}"
# --- Attribute updates ---
- name: Create client with initial attributes
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id_2 }}"
state: present
attributes: "{{ client_attributes1 }}"
register: check_client_when_present_and_attributes_modified
- name: Update client attributes
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id_2 }}"
state: present
attributes: "{{ client_attributes2 }}"
register: check_client_when_present_and_attributes_modified
- name: Assert client attributes are updated
ansible.builtin.assert:
that:
- check_client_when_present_and_attributes_modified is changed
- end_state.attributes["backchannel.logout.revoke.offline.tokens"] == 'false'
- end_state.attributes["backchannel.logout.session.required"] == 'false'
- end_state.attributes["oauth2.device.authorization.grant.enabled"] == 'false'
vars:
end_state: "{{ check_client_when_present_and_attributes_modified.end_state }}"
# --- Post-logout redirect URIs and backchannel logout URL ---
- name: Create client with post logout redirect URIs and backchannel logout URL
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: logout-test-client
valid_post_logout_redirect_uris: "{{ post_logout_redirect_uris }}"
backchannel_logout_url: "{{ backchannel_logout_url }}"
state: present
register: result_create_logout_client
- name: Assert logout client is created with correct attributes
ansible.builtin.assert:
that:
- result_create_logout_client is changed
- result_create_logout_client.end_state.attributes["post.logout.redirect.uris"] is defined
- result_create_logout_client.end_state.attributes["backchannel.logout.url"] == backchannel_logout_url
- name: Re-create client with same logout fields (idempotency)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: logout-test-client
valid_post_logout_redirect_uris: "{{ post_logout_redirect_uris }}"
backchannel_logout_url: "{{ backchannel_logout_url }}"
state: present
register: result_idempotent_logout_client
- name: Assert logout client is idempotent
ansible.builtin.assert:
that:
- result_idempotent_logout_client is not changed
- name: Update client logout fields
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: logout-test-client
valid_post_logout_redirect_uris:
- "https://example.com/new-logout"
backchannel_logout_url: "https://example.com/new-backchannel"
state: present
register: result_update_logout_client
- name: Assert logout client fields are updated
ansible.builtin.assert:
that:
- result_update_logout_client is changed
- result_update_logout_client.end_state.attributes["backchannel.logout.url"] == "https://example.com/new-backchannel"
- name: Delete logout test client
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: logout-test-client
state: absent
@@ -0,0 +1,242 @@
---
# Ported from community.general tests/integration/targets/keycloak_client_rolescope
# Tests multi-role mapping, remap idempotency, partial removal, error handling,
# duplicate roles, realm role operations, full-scope client rejection, and check_mode.
# --- Fixtures ---
- name: Create realm roles for rolescope test
middleware_automation.keycloak.keycloak_role:
name: "{{ item }}"
realm: "{{ ephemeral_realm }}"
state: present
loop:
- realm-role-admin
- realm-role-user
- name: Create private client (full_scope_allowed)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: backend-client-private
state: present
redirect_uris:
- "https://my-backend-api.c.org/"
full_scope_allowed: true
attributes: {"backchannel.logout.session.required": true, "backchannel.logout.revoke.offline.tokens": false, "client.secret.creation.time": 0}
public_client: false
- name: Create client roles on private client
middleware_automation.keycloak.keycloak_role:
name: "{{ item }}"
realm: "{{ ephemeral_realm }}"
client_id: backend-client-private
state: present
loop:
- client-role-admin
- client-role-user
- name: Create public client (full_scope_allowed false)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: frontend-client-public
redirect_uris:
- "https://my-onepage-app-frontend.c.org/"
attributes: {"backchannel.logout.session.required": true, "backchannel.logout.revoke.offline.tokens": false, "client.secret.creation.time": 0}
full_scope_allowed: false
public_client: true
# --- Client role scope mapping ---
- name: Map two client roles to public client
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_owner_client_id: backend-client-private
role_names:
- client-role-admin
- client-role-user
register: result
- name: Assert both client roles mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Remap single role (additive idempotency)
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_owner_client_id: backend-client-private
role_names:
- client-role-user
register: result
- name: Assert no change - both still mapped
ansible.builtin.assert:
that:
- result is not changed
- result.end_state | length == 2
- name: Remove admin role from public client scope
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_owner_client_id: backend-client-private
role_names:
- client-role-admin
state: absent
register: result
- name: Assert admin removed, user remains
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 1
- result.end_state[0].name == "client-role-user"
# --- Error: missing role ---
- name: Map non-existent client role (expect failure)
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_owner_client_id: backend-client-private
role_names:
- client-role-admin
- client-role-missing
ignore_errors: true
register: result
- name: Assert failure on missing client role
ansible.builtin.assert:
that:
- result is failed
# --- Duplicate role names ---
- name: Map duplicate role names
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_owner_client_id: backend-client-private
role_names:
- client-role-admin
- client-role-admin
register: result
- name: Assert duplicate handled - both roles mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
# --- Error: full-scope client ---
- name: Map realm role to full-scope private client (expect failure)
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: backend-client-private
role_names:
- realm-role-admin
ignore_errors: true
register: result
- name: Assert failure on full-scope client
ansible.builtin.assert:
that:
- result is failed
# --- Realm role scope mapping ---
- name: Map one realm role to public client
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_names:
- realm-role-admin
register: result
- name: Assert realm role mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 1
- name: Map two realm roles to public client
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_names:
- realm-role-admin
- realm-role-user
register: result
- name: Assert both realm roles mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Unmap all realm roles from public client
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_names:
- realm-role-admin
- realm-role-user
state: absent
register: result
- name: Assert all realm roles unmapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 0
# --- Error: missing realm role ---
- name: Map non-existent realm role (expect failure)
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_names:
- client-role-missing
ignore_errors: true
register: result
- name: Assert failure on missing realm role
ansible.builtin.assert:
that:
- result is failed
# --- Check mode ---
- name: Check-mode map realm roles to public client
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_names:
- realm-role-admin
- realm-role-user
check_mode: true
register: result
- name: Assert check-mode reports changed
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Verify check-mode did not actually apply changes
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_names: []
register: result
- name: Assert no roles present after check-mode
ansible.builtin.assert:
that:
- result is not changed
- result.end_state | length == 0
@@ -0,0 +1,247 @@
---
# Ported from community.general tests/integration/targets/keycloak_client_scope_rolemappings
# Tests multi-role mapping, error paths, check_mode, partial removal, and full-scope rejection.
# --- Fixtures ---
- name: Create client for scope rolemapping tests
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
state: present
public_client: true
full_scope_allowed: false
- name: Create full-scope client for rejection test
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: full-scope-client
state: present
public_client: true
full_scope_allowed: true
- name: Create realm roles
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ item }}"
loop:
- realm-role-admin
- realm-role-user
- name: Create client roles
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
name: "{{ item }}"
loop:
- client-role-admin
- client-role-user
- name: Create client roles in full-scope client
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: full-scope-client
name: "{{ item }}"
loop:
- client-role-admin
- client-role-user
- name: Create client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ ephemeral_realm }}"
name: client-scope
description: ""
protocol: openid-connect
state: present
# --- Client role mapping tests ---
- name: Map two client roles to scope
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
client_scope_id: client-scope
role_names:
- client-role-admin
- client-role-user
register: result
- name: Assert both client roles mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Remap one existing client role (idempotency - additive)
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
client_scope_id: client-scope
role_names:
- client-role-user
register: result
- name: Assert no change and both still mapped
ansible.builtin.assert:
that:
- result is not changed
- result.end_state | length == 2
- name: Remove admin client role from scope
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
client_scope_id: client-scope
role_names:
- client-role-admin
state: absent
register: result
- name: Assert admin role removed and user role remains
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 1
- result.end_state[0].name == "client-role-user"
- name: Map non-existent client role
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
client_scope_id: client-scope
role_names:
- client-role-admin
- client-role-missing
ignore_errors: true
register: result
- name: Assert failed for missing client role
ansible.builtin.assert:
that:
- result is failed
- "result.msg == \"Failed to retrieve role '\" ~ ephemeral_realm ~ \".backend-client.client-role-missing'\""
- name: Map duplicate client roles
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
client_scope_id: client-scope
role_names:
- client-role-admin
- client-role-admin
register: result
- name: Assert duplicate handled and both roles present
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Map role to full-scope client (should fail)
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
client_id: full-scope-client
role_names:
- client-role-admin
ignore_errors: true
register: result
- name: Assert full-scope client rejected
ansible.builtin.assert:
that:
- result is failed
- "result.msg == \"FullScopeAllowed is active for Client '\" ~ ephemeral_realm ~ \".full-scope-client'\""
# --- Realm role mapping tests ---
- name: Map one realm role to scope
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
role_names:
- realm-role-admin
register: result
- name: Assert realm role mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 1
- name: Map two realm roles
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
role_names:
- realm-role-admin
- realm-role-user
register: result
- name: Assert both realm roles mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Unmap all realm roles
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
role_names:
- realm-role-admin
- realm-role-user
state: absent
register: result
- name: Assert all realm roles unmapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 0
- name: Map non-existent realm role
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
role_names:
- client-role-missing
ignore_errors: true
register: result
- name: Assert failed for missing realm role
ansible.builtin.assert:
that:
- result is failed
- "result.msg == \"Failed to retrieve role '\" ~ ephemeral_realm ~ \".client-role-missing'\""
# --- Check-mode test ---
- name: Map realm roles in check mode
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
role_names:
- realm-role-admin
- realm-role-user
check_mode: true
register: result
- name: Assert check mode reports change
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Verify check mode did not persist changes
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
role_names: []
register: result
- name: Assert no roles actually mapped after check mode
ansible.builtin.assert:
that:
- result is not changed
- result.end_state | length == 0
@@ -0,0 +1,115 @@
---
# Ported from community.general tests/integration/targets/keycloak_client_scope_type
# Tests full realm-level and client-level scope type management with idempotency.
- name: Create client for scope type tests
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: clientscope-type-client
state: present
enabled: true
- name: Create scope1 client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ ephemeral_realm }}"
name: scope1
description: "test 1"
protocol: openid-connect
- name: Create scope2 client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ ephemeral_realm }}"
name: scope2
description: "test 2"
protocol: openid-connect
# --- Realm level ---
- name: Set both scopes as realm defaults
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ ephemeral_realm }}"
default_client_scopes: ['scope1', 'scope2']
optional_client_scopes: []
register: result
- name: Assert realm default scopes are set
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- '"scope1" in result.end_state.default_client_scopes'
- '"scope2" in result.end_state.default_client_scopes'
- result.end_state.default_client_scopes | length == 2
- result.end_state.optional_client_scopes | length == 0
- name: Set same realm defaults (idempotency)
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ ephemeral_realm }}"
default_client_scopes: ['scope1', 'scope2']
optional_client_scopes: []
register: result
failed_when: result is changed
- name: Move scope2 to optional at realm level
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ ephemeral_realm }}"
default_client_scopes: ['scope1']
optional_client_scopes: ['scope2']
register: result
- name: Assert scope2 moved to optional
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- '"scope1" in result.end_state.default_client_scopes'
- '"scope2" in result.end_state.optional_client_scopes'
- result.end_state.default_client_scopes | length == 1
- result.end_state.optional_client_scopes | length == 1
# --- Client level ---
- name: Set both scopes as client defaults
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ ephemeral_realm }}"
client_id: clientscope-type-client
default_client_scopes: ['scope1', 'scope2']
optional_client_scopes: []
register: result
- name: Assert client default scopes are set
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- '"scope1" in result.end_state.default_client_scopes'
- '"scope2" in result.end_state.default_client_scopes'
- result.end_state.default_client_scopes | length == 2
- result.end_state.optional_client_scopes | length == 0
- name: Set same client defaults (idempotency)
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ ephemeral_realm }}"
client_id: clientscope-type-client
default_client_scopes: ['scope1', 'scope2']
optional_client_scopes: []
register: result
failed_when: result is changed
- name: Move scope2 to optional at client level
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ ephemeral_realm }}"
client_id: clientscope-type-client
default_client_scopes: ['scope1']
optional_client_scopes: ['scope2']
register: result
- name: Assert scope2 moved to optional on client
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- '"scope1" in result.end_state.default_client_scopes'
- '"scope2" in result.end_state.optional_client_scopes'
- result.end_state.default_client_scopes | length == 1
- result.end_state.optional_client_scopes | length == 1
@@ -0,0 +1,33 @@
---
# Ported from community.general tests/integration/targets/keycloak_clientsecret_info
# Tests fetch-by-client_id vs fetch-by-id and value assertions.
- name: Look up test client to get internal id
middleware_automation.keycloak.keycloak_client:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
state: present
register: client_lookup
- name: Fetch client secret by client_id
middleware_automation.keycloak.keycloak_clientsecret_info:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
register: fetch_by_client_id_result
- name: Assert client secret retrieved by client_id
ansible.builtin.assert:
that:
- fetch_by_client_id_result.clientsecret_info.type == "secret"
- fetch_by_client_id_result.clientsecret_info.value | length >= 32
- name: Fetch client secret by internal id
middleware_automation.keycloak.keycloak_clientsecret_info:
realm: "{{ target_realm }}"
id: "{{ client_lookup.end_state.id }}"
register: fetch_by_id_result
- name: Assert both fetch methods return the same secret value
ansible.builtin.assert:
that:
- fetch_by_id_result.clientsecret_info.value == fetch_by_client_id_result.clientsecret_info.value
@@ -0,0 +1,34 @@
---
# Ported from community.general tests/integration/targets/keycloak_clientsecret_regenerate
# Tests regenerate-by-client_id vs regenerate-by-id and rotation contract.
- name: Look up test client to get internal id
middleware_automation.keycloak.keycloak_client:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
state: present
register: client_lookup
- name: Regenerate client secret by client_id
middleware_automation.keycloak.keycloak_clientsecret_regenerate:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
register: regenerate_by_client_id
- name: Assert regenerated secret is valid
ansible.builtin.assert:
that:
- regenerate_by_client_id.end_state.type == "secret"
- regenerate_by_client_id.end_state.value | length >= 32
- name: Regenerate client secret by internal id
middleware_automation.keycloak.keycloak_clientsecret_regenerate:
realm: "{{ target_realm }}"
id: "{{ client_lookup.end_state.id }}"
register: regenerate_by_id
- name: Assert secret value changed after second regeneration
ansible.builtin.assert:
that:
- regenerate_by_id.end_state.value | length >= 32
- regenerate_by_id.end_state.value != regenerate_by_client_id.end_state.value
@@ -0,0 +1,218 @@
---
# Ported from community.general tests/integration/targets/keycloak_component_info
# Tests querying components by name, provider_type, parent_id, and combined filters.
- name: Query LDAP federation when absent
middleware_automation.keycloak.keycloak_component_info:
name: myldap
provider_type: "org.keycloak.storage.UserStorageProvider"
realm: "{{ ephemeral_realm }}"
register: result
- name: Assert LDAP federation is absent
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 0
- name: Create LDAP federation for component_info tests
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: myldap
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldap://ldap.example.com"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: secret
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
mappers:
- name: "email"
providerId: "user-attribute-ldap-mapper"
providerType: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
config:
ldap.attribute: mail
user.model.attribute: email
is.mandatory.in.ldap: "false"
read.only: "true"
- name: "username"
providerId: "user-attribute-ldap-mapper"
providerType: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
config:
ldap.attribute: uid
user.model.attribute: username
is.mandatory.in.ldap: "true"
read.only: "true"
state: present
- name: Query LDAP federation by name and type
middleware_automation.keycloak.keycloak_component_info:
name: myldap
provider_type: "org.keycloak.storage.UserStorageProvider"
realm: "{{ ephemeral_realm }}"
register: result
- name: Assert LDAP federation found
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 1
- result.components[0].name == "myldap"
- name: Save LDAP federation id
ansible.builtin.set_fact:
ci_ldap_id: "{{ result.components[0].id }}"
- name: Query LDAP subcomponents by parent_id
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ ephemeral_realm }}"
parent_id: "{{ ci_ldap_id }}"
register: result
- name: Assert subcomponents exist
ansible.builtin.assert:
that:
- result is not changed
- result.components | length > 0
- name: Query LDAP subcomponents filter by name
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ ephemeral_realm }}"
parent_id: "{{ ci_ldap_id }}"
name: "email"
register: result
- name: Assert subcomponent with name email exists
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 1
- result.components[0].name == "email"
- name: Query LDAP subcomponents filter by type
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ ephemeral_realm }}"
parent_id: "{{ ci_ldap_id }}"
provider_type: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
register: result
- name: Assert LDAP mapper subcomponents found
ansible.builtin.assert:
that:
- result is not changed
- result.components | length > 0
- result.components[0].providerType == "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
- name: Query key info when absent
middleware_automation.keycloak.keycloak_component_info:
name: testkey
provider_type: "org.keycloak.keys.KeyProvider"
realm: "{{ ephemeral_realm }}"
register: result
- name: Assert key is missing
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 0
- name: Create AES realm key for component query test
middleware_automation.keycloak.keycloak_realm_key:
name: testkey
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: aes-generated
config:
priority: 150
enabled: true
active: true
- name: Query key component by name and type
middleware_automation.keycloak.keycloak_component_info:
name: testkey
provider_type: "org.keycloak.keys.KeyProvider"
realm: "{{ ephemeral_realm }}"
register: result
- name: Assert key component found
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 1
- name: Query all realm components
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ ephemeral_realm }}"
register: result
- name: Assert realm has components
ansible.builtin.assert:
that:
- result is not changed
- result.components | length > 0
- name: Query all UserStorageProviders in realm
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ ephemeral_realm }}"
provider_type: "org.keycloak.storage.UserStorageProvider"
register: result
- name: Assert only the LDAP federation is returned
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 1
- result.components[0].providerType == "org.keycloak.storage.UserStorageProvider"
- result.components[0].name == "myldap"
- name: Query component by name only
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ ephemeral_realm }}"
name: testkey
register: result
- name: Assert key found by name only
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 1
- result.components[0].providerType == "org.keycloak.keys.KeyProvider"
- result.components[0].name == "testkey"
- name: Clean up - remove AES key
middleware_automation.keycloak.keycloak_realm_key:
name: testkey
parent_id: "{{ ephemeral_realm }}"
provider_id: aes-generated
state: absent
- name: Clean up - remove LDAP federation
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: myldap
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
state: absent
@@ -0,0 +1,412 @@
---
# Ported from community.general tests/integration/targets/keycloak_group
# Tests group CRUD, custom attributes, subgroups, deep chains, and deletion patterns.
# --- Group CRUD ---
- name: Create a group
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: test-group
state: present
register: result
- name: Assert group was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "test-group"
- result.end_state.path == "/test-group"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Save group id
ansible.builtin.set_fact:
molecule_grp_test_id: "{{ result.end_state.id }}"
- name: Create group again (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: test-group
state: present
register: result
- name: Assert group unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.name == "test-group"
- result.end_state.path == "/test-group"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Rename group by id
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
id: "{{ molecule_grp_test_id }}"
name: new-test-group
state: present
register: result
- name: Assert group was renamed
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "new-test-group"
- result.end_state.path == "/new-test-group"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Delete group by id
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
id: "{{ molecule_grp_test_id }}"
state: absent
register: result
- name: Assert group was deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Delete group by id again (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
id: "{{ molecule_grp_test_id }}"
state: absent
register: result
- name: Assert no change on absent group
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
# --- Custom attributes ---
- name: Create group with custom attributes
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: my-new_group
attributes:
attrib1: value1
attrib2: value2
attrib3:
- item1
- item2
register: result
- name: Assert group created with attributes
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "my-new_group"
- result.end_state.path == "/my-new_group"
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- result.end_state.attributes != {}
- result.end_state.attributes.attrib1 == ["value1"]
- result.end_state.attributes.attrib2 == ["value2"]
- result.end_state.attributes.attrib3 == ["item1", "item2"]
- name: Delete group with attributes by name
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: my-new_group
state: absent
register: result
- name: Assert group with attributes was deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
# --- Subgroup tests ---
- name: Create base group for subgroup testing
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: rootgrp
register: grp_root_result
- name: Create subgroup using parent id
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subgrp1
parents:
- id: "{{ grp_root_result.end_state.id }}"
register: result
- name: Assert subgroup created by parent id
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "subgrp1"
- result.end_state.path == "/rootgrp/subgrp1"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Recreate subgroup using parent id (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subgrp1
parents:
- id: "{{ grp_root_result.end_state.id }}"
register: result
- name: Assert subgroup unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.name == "subgrp1"
- result.end_state.path == "/rootgrp/subgrp1"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Rename subgroup
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
id: "{{ result.end_state.id }}"
name: new-subgrp1
parents:
- id: "{{ grp_root_result.end_state.id }}"
register: result
- name: Assert subgroup renamed
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "new-subgrp1"
- result.end_state.path == "/rootgrp/new-subgrp1"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Create subgroup using parent name
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subgrp2
parents:
- name: rootgrp
register: result
- name: Assert subgroup created by parent name
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "subgrp2"
- result.end_state.path == "/rootgrp/subgrp2"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Recreate subgroup using parent name (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subgrp2
parents:
- name: rootgrp
register: result
- name: Assert subgroup unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.name == "subgrp2"
- result.end_state.path == "/rootgrp/subgrp2"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
# --- Sub-subgroup (deep chain) ---
- name: Create sub-subgroup using parent name chain
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subsubgrp
parents:
- name: rootgrp
- name: subgrp2
register: result
- name: Assert sub-subgroup created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "subsubgrp"
- result.end_state.path == "/rootgrp/subgrp2/subsubgrp"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Recreate sub-subgroup using parent names (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subsubgrp
parents:
- name: rootgrp
- name: subgrp2
register: result_subsub
- name: Assert sub-subgroup unchanged
ansible.builtin.assert:
that:
- result_subsub is not changed
- result_subsub.end_state != {}
- result_subsub.end_state.name == "subsubgrp"
- result_subsub.end_state.path == "/rootgrp/subgrp2/subsubgrp"
- result_subsub.end_state.attributes == {}
- result_subsub.end_state.clientRoles == {}
- result_subsub.end_state.realmRoles == []
- result_subsub.end_state.subGroups == []
- name: Create sub-sub-subgroup using direct parent id
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subsubsubgrp
parents:
- id: "{{ result_subsub.end_state.id }}"
register: result
- name: Assert sub-sub-subgroup created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "subsubsubgrp"
- result.end_state.path == "/rootgrp/subgrp2/subsubgrp/subsubsubgrp"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Recreate sub-sub-subgroup using direct parent id (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subsubsubgrp
parents:
- id: "{{ result_subsub.end_state.id }}"
register: result_subsubsub
- name: Assert sub-sub-subgroup unchanged
ansible.builtin.assert:
that:
- result_subsubsub is not changed
- result_subsubsub.end_state != {}
- result_subsubsub.end_state.name == "subsubsubgrp"
- result_subsubsub.end_state.path == "/rootgrp/subgrp2/subsubgrp/subsubsubgrp"
- result_subsubsub.end_state.attributes == {}
- result_subsubsub.end_state.clientRoles == {}
- result_subsubsub.end_state.realmRoles == []
- result_subsubsub.end_state.subGroups == []
# --- Subgroup deletion ---
- name: Delete subgroup by id (no parents needed)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
id: "{{ result_subsubsub.end_state.id }}"
state: absent
register: result
- name: Assert subgroup deleted by id
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Redo subgroup deletion by id (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
id: "{{ result_subsubsub.end_state.id }}"
state: absent
register: result
- name: Assert subgroup deletion idempotent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
- name: Delete subgroup by name with parents
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: new-subgrp1
parents:
- name: rootgrp
state: absent
register: result
- name: Assert subgroup deleted by name
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Redo subgroup deletion by name (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: new-subgrp1
parents:
- name: rootgrp
state: absent
register: result
- name: Assert subgroup name deletion idempotent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
- name: Delete group that has subgroups (cascade)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: rootgrp
state: absent
register: result
- name: Assert group with subgroups deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Redo delete group with subgroups (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: rootgrp
state: absent
register: result
- name: Assert group deletion idempotent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
@@ -0,0 +1,4 @@
---
role_1: myrole-1
role_2: myrole-2
test_group: mygroup
@@ -0,0 +1,113 @@
---
# Ported from community.general tests/integration/targets/keycloak_group_rolemapping
# Tests full map/unmap lifecycle with idempotency for realm role mappings on groups.
- name: Load group rolemapping test variables
ansible.builtin.include_vars:
file: vars.yml
- name: Create realm roles
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ item }}"
state: present
loop:
- "{{ role_1 }}"
- "{{ role_2 }}"
- name: Create group
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: "{{ test_group }}"
state: present
- name: Map realm roles to group
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ ephemeral_realm }}"
group_name: "{{ test_group }}"
roles:
- name: "{{ role_1 }}"
- name: "{{ role_2 }}"
state: present
register: result
- name: Assert realm roles are assigned to group
ansible.builtin.assert:
that:
- result is changed
- result.end_state | count == 2
- name: Map realm roles to group again (idempotency)
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ ephemeral_realm }}"
group_name: "{{ test_group }}"
roles:
- name: "{{ role_1 }}"
- name: "{{ role_2 }}"
state: present
register: result
- name: Assert realm roles stay assigned to group
ansible.builtin.assert:
that:
- result is not changed
- name: Unmap realm role 1 from group
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ ephemeral_realm }}"
group_name: "{{ test_group }}"
roles:
- name: "{{ role_1 }}"
state: absent
register: result
- name: Assert realm role 1 is unassigned from group
ansible.builtin.assert:
that:
- result is changed
- result.end_state | count == 1
- result.end_state[0] == role_2
- name: Unmap realm role 1 from group again (idempotency)
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ ephemeral_realm }}"
group_name: "{{ test_group }}"
roles:
- name: "{{ role_1 }}"
state: absent
register: result
- name: Assert realm role 1 stays unassigned from group
ansible.builtin.assert:
that:
- result is not changed
- name: Unmap realm role 2 from group
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ ephemeral_realm }}"
group_name: "{{ test_group }}"
roles:
- name: "{{ role_2 }}"
state: absent
register: result
- name: Assert no realm roles are assigned to group
ansible.builtin.assert:
that:
- result is changed
- result.end_state | count == 0
- name: Unmap realm role 2 from group again (idempotency)
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ ephemeral_realm }}"
group_name: "{{ test_group }}"
roles:
- name: "{{ role_2 }}"
state: absent
register: result
- name: Assert no realm roles are assigned to group
ansible.builtin.assert:
that:
- result is not changed
- result.end_state | count == 0
@@ -0,0 +1,264 @@
---
# Ported from community.general tests/integration/targets/keycloak_identity_provider
# Tests create with mappers, mapper CRUD, update, clientSecret masking, delete idempotency, fromUrl discovery.
- name: Create new identity provider
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
display_name: OpenID Connect IdP
enabled: true
provider_id: oidc
config:
issuer: https://idp.example.com
authorizationUrl: https://idp.example.com/auth
tokenUrl: https://idp.example.com/token
userInfoUrl: https://idp.example.com/userinfo
clientAuthMethod: client_secret_post
clientId: clientid
clientSecret: clientsecret
syncMode: FORCE
mappers:
- name: "first_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "first_name"
user.attribute: "first_name"
syncMode: "INHERIT"
- name: "last_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "last_name"
user.attribute: "last_name"
syncMode: "INHERIT"
state: present
register: result
- name: Assert identity provider created
ansible.builtin.assert:
that:
- result is changed
- result.existing == {}
- result.end_state.alias == "myidp"
- result.end_state.mappers != []
- result.end_state.config.clientSecret == "**********"
- name: Update existing identity provider (no change)
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
enabled: true
provider_id: oidc
config:
issuer: https://idp.example.com
authorizationUrl: https://idp.example.com/auth
tokenUrl: https://idp.example.com/token
userInfoUrl: https://idp.example.com/userinfo
clientAuthMethod: client_secret_post
clientId: clientid
clientSecret: "**********"
syncMode: FORCE
mappers:
- name: "first_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "first_name"
user.attribute: "first_name"
syncMode: "INHERIT"
- name: "last_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "last_name"
user.attribute: "last_name"
syncMode: "INHERIT"
state: present
register: result
- name: Assert identity provider unchanged
ansible.builtin.assert:
that:
- result is not changed
- name: Update existing identity provider (with change, no mapper change)
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
enabled: false
state: present
register: result
- name: Assert identity provider updated
ansible.builtin.assert:
that:
- result is changed
- result.existing.enabled == true
- result.end_state.enabled == false
- name: Update existing identity provider (delete mapper)
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
state: present
mappers:
- name: "first_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "first_name"
user.attribute: "first_name"
syncMode: "INHERIT"
register: result
- name: Assert identity provider updated
ansible.builtin.assert:
that:
- result is changed
- result.existing.mappers | length == 2
- result.end_state.mappers | length == 1
- result.end_state.mappers[0].name == "first_name"
- name: Update existing identity provider (add mapper)
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
state: present
mappers:
- name: "last_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "last_name"
user.attribute: "last_name"
syncMode: "INHERIT"
- name: "first_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "first_name"
user.attribute: "first_name"
syncMode: "INHERIT"
register: result
- name: Assert identity provider updated
ansible.builtin.assert:
that:
- result is changed
- result.existing.mappers | length == 1
- result.end_state.mappers | length == 2
- name: Update existing identity provider (no change, test mapper idempotency)
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
state: present
mappers:
- name: "last_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "last_name"
user.attribute: "last_name"
syncMode: "INHERIT"
- name: "first_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "first_name"
user.attribute: "first_name"
syncMode: "INHERIT"
register: result
- name: Assert identity provider updated
ansible.builtin.assert:
that:
- result is not changed
- name: Delete existing identity provider
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
state: absent
register: result
- name: Assert identity provider deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Delete absent identity provider
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
state: absent
register: result
- name: Assert identity provider unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
- name: Create IDP realm
middleware_automation.keycloak.keycloak_realm:
id: myidprealm
realm: myidprealm
state: present
- name: Create new identity provider with fromUrl
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidpfromurl
display_name: OpenID Connect IdP from url
enabled: true
provider_id: oidc
config:
fromUrl: "{{ auth_keycloak_url }}/realms/myidprealm/.well-known/openid-configuration"
clientAuthMethod: client_secret_post
clientId: clientid
clientSecret: clientsecret
syncMode: FORCE
state: present
register: result
- name: Assert identity provider created with IDP endpoints
ansible.builtin.assert:
that:
- result is changed
- result.end_state.config.authorizationUrl == auth_keycloak_url ~ "/realms/myidprealm/protocol/openid-connect/auth"
- result.end_state.config.issuer == auth_keycloak_url ~ "/realms/myidprealm"
- result.end_state.config.jwksUrl == auth_keycloak_url ~ "/realms/myidprealm/protocol/openid-connect/certs"
- result.end_state.config.logoutUrl == auth_keycloak_url ~ "/realms/myidprealm/protocol/openid-connect/logout"
- result.end_state.config.tokenUrl == auth_keycloak_url ~ "/realms/myidprealm/protocol/openid-connect/token"
- result.end_state.config.userInfoUrl == auth_keycloak_url ~ "/realms/myidprealm/protocol/openid-connect/userinfo"
- name: Create new identity provider with fromUrl and exclusion should fail
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: "mustfail"
display_name: Failed OpenID Connect IdP from url
enabled: true
provider_id: oidc
config: "{{ config | combine(endpoint) }}"
state: present
vars:
config:
fromUrl: "{{ auth_keycloak_url }}/realms/myidprealm/.well-known/openid-configuration"
clientAuthMethod: client_secret_post
clientId: clientid
clientSecret: clientsecret
endpoint: "{{ { item: auth_keycloak_url ~ '/realms/myidprealm/protocol/openid-connect/' ~ item } }}"
with_items: ['userInfoUrl', 'authorizationUrl', 'tokenUrl', 'logoutUrl', 'issuer', 'jwksUrl']
register: result
ignore_errors: true
- name: Check failure of identity provider creation with fromUrl and userInfoUrl
ansible.builtin.assert:
that:
- result is not changed
- result is failed
- result.results | selectattr('failed', 'equalto', false) | list | length == 0
@@ -0,0 +1,4 @@
---
client_secret: myclientsecret
auth_test_role: myrole
keycloak_role_description: test
@@ -0,0 +1,281 @@
---
# Ported from community.general tests/integration/targets/keycloak_modules_authentication
# Tests the authentication layer shared by all keycloak modules:
# token auth, refresh token fallback, auth fallback chains, client_credentials, and 401 errors.
- name: Load authentication test variables
ansible.builtin.include_vars:
file: vars.yml
- name: Reset public login in master admin-cli (if potentially previous test failed)
middleware_automation.keycloak.keycloak_client:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
auth_client_id: admin-cli
auth_client_secret: "{{ client_secret }}"
client_id: admin-cli
secret: "{{ client_secret }}"
public_client: true
state: present
- name: Create new realm role with username/password authentication
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
- name: Assert username/password authentication succeeded
ansible.builtin.assert:
that:
- result is changed
- result is not failed
- name: Remove created realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
state: absent
register: result
- name: Get Keycloak token
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/realms/master/protocol/openid-connect/token"
method: POST
return_content: true
status_code: 200
body_format: form-urlencoded
body:
grant_type: "password"
client_id: "admin-cli"
username: "{{ auth_username }}"
password: "{{ auth_password }}"
register: token_response
- name: Extract tokens
ansible.builtin.set_fact:
access_token: "{{ token_response.json.access_token }}"
refresh_token: "{{ token_response.json.refresh_token }}"
- name: Create new realm role with provided token authentication
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
token: "{{ access_token }}"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
- name: Assert token authentication succeeded
ansible.builtin.assert:
that:
- result is changed
- result is not failed
- name: Remove created realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
state: absent
register: result
- name: Create new realm role with invalid auth token and valid refresh token
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
token: "invalidtoken!!!"
refresh_token: "{{ refresh_token }}"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
- name: Assert refresh token fallback authentication succeeded
ansible.builtin.assert:
that:
- result is changed
- result is not failed
- name: Remove created realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
state: absent
register: result
- name: Create new realm role with invalid auth token and valid username/password
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
token: "invalidtoken!!!"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
- name: Assert username/password fallback authentication succeeded
ansible.builtin.assert:
that:
- result is changed
- result is not failed
- name: Remove created realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
state: absent
register: result
- name: Create new realm role with invalid auth token, invalid refresh token, and valid username/password
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
token: "invalidtoken!!!"
refresh_token: "invalidrefreshtoken!!!"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
- name: Assert full fallback chain authentication succeeded
ansible.builtin.assert:
that:
- result is changed
- result is not failed
- name: Remove created realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
state: absent
register: result
- name: Test client_credentials authentication
block:
- name: PREPARE - Temporarily disable public login in master admin-cli
middleware_automation.keycloak.keycloak_client:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
auth_client_id: admin-cli
auth_client_secret: "{{ client_secret }}"
client_id: admin-cli
secret: "{{ client_secret }}"
public_client: false
service_accounts_enabled: true
client_authenticator_type: client-secret
state: present
- name: PREPARE - Assign admin role to admin-cli in master
middleware_automation.keycloak.keycloak_user_rolemapping:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
auth_client_id: admin-cli
auth_client_secret: "{{ client_secret }}"
realm: master
roles:
- name: admin
service_account_user_client_id: admin-cli
- name: Create new realm role with valid client_id and client_secret
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_client_id: admin-cli
auth_client_secret: "{{ client_secret }}"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
- name: Assert client_credentials authentication succeeded
ansible.builtin.assert:
that:
- result is changed
- result is not failed
always:
- name: Reset temporarily disabled public login in master admin-cli
middleware_automation.keycloak.keycloak_client:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
auth_client_id: admin-cli
auth_client_secret: "{{ client_secret }}"
client_id: admin-cli
secret: "{{ client_secret }}"
public_client: true
state: present
- name: Remove created realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
state: absent
register: result
### Unhappy path tests
- name: Fail to create new realm role with invalid username/password
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "invalid_password"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
failed_when: >
("HTTP Error 401: Unauthorized" not in result.msg) and
("HTTP Error 400: Bad Request" not in result.msg)
- name: Fail to create new realm role with invalid auth token
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_username: ""
auth_password: ""
token: "invalidtoken!!!"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
failed_when: >
("HTTP Error 401: Unauthorized" not in result.msg) and
("HTTP Error 400: Bad Request" not in result.msg)
- name: Fail to create new realm role with invalid auth and refresh tokens, and invalid username/password
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "invalid_password"
token: "invalidtoken!!!"
refresh_token: "invalidtoken!!!"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
failed_when: >
("HTTP Error 401: Unauthorized" not in result.msg) and
("HTTP Error 400: Bad Request" not in result.msg)
@@ -0,0 +1,210 @@
---
# Ported from community.general tests/integration/targets/keycloak_realm
# Tests session timeout and OAuth2 device settings on keycloak_realm module.
- name: Modify realm
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
client_session_idle_timeout: 240
client_session_max_lifespan: 21600
client_offline_session_idle_timeout: 100
client_offline_session_max_lifespan: 200
oauth2_device_code_lifespan: 700
oauth2_device_polling_interval: 800
state: present
register: result
- name: Assert result
ansible.builtin.assert:
that:
- result is changed
- result.end_state.clientSessionIdleTimeout == 240
- result.end_state.clientSessionMaxLifespan == 21600
- result.end_state.clientOfflineSessionIdleTimeout == 100
- result.end_state.clientOfflineSessionMaxLifespan == 200
- result.end_state.oauth2DeviceCodeLifespan == 700
- result.end_state.oauth2DevicePollingInterval == 800
- name: Delete realm
middleware_automation.keycloak.keycloak_realm:
realm: "{{ ephemeral_realm }}"
state: absent
- name: create realm
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
client_session_idle_timeout: 240
client_session_max_lifespan: 21600
client_offline_session_idle_timeout: 100
client_offline_session_max_lifespan: 200
oauth2_device_code_lifespan: 700
oauth2_device_polling_interval: 800
state: present
register: result
- name: Assert result
ansible.builtin.assert:
that:
- result is changed
- result.end_state.clientSessionIdleTimeout == 240
- result.end_state.clientSessionMaxLifespan == 21600
- result.end_state.clientOfflineSessionIdleTimeout == 100
- result.end_state.clientOfflineSessionMaxLifespan == 200
- result.end_state.oauth2DeviceCodeLifespan == 700
- result.end_state.oauth2DevicePollingInterval == 800
- name: Update realm default client scopes
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
default_default_client_scopes:
- acr
- email
- profile
- roles
default_optional_client_scopes:
- offline_access
- microprofile-jwt
state: present
register: result
- name: Assert default client scopes updated
ansible.builtin.assert:
that:
- result is changed
- "'acr' in result.end_state.defaultDefaultClientScopes"
- "'email' in result.end_state.defaultDefaultClientScopes"
- "'profile' in result.end_state.defaultDefaultClientScopes"
- "'roles' in result.end_state.defaultDefaultClientScopes"
- "result.end_state.defaultDefaultClientScopes | length == 4"
- "'offline_access' in result.end_state.defaultOptionalClientScopes"
- "'microprofile-jwt' in result.end_state.defaultOptionalClientScopes"
- "result.end_state.defaultOptionalClientScopes | length == 2"
- name: Update realm default client scopes again (idempotency)
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
default_default_client_scopes:
- acr
- email
- profile
- roles
default_optional_client_scopes:
- offline_access
- microprofile-jwt
state: present
register: result
- name: Assert no changes on idempotent run
ansible.builtin.assert:
that:
- result is not changed
- name: Fail when setting a non-existent client scope
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
default_default_client_scopes:
- nonexistent-scope
state: present
register: result
ignore_errors: true
- name: Assert failure for non-existent scope
ansible.builtin.assert:
that:
- result is failed
- "'nonexistent-scope' in result.msg"
- name: Configure realm attributes, SMTP server and browser security headers
middleware_automation.keycloak.keycloak_realm: &realm_map_settings
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
attributes:
molecule-number: 123
molecule-flag: true
smtp_server:
host: smtp.example.com
port: 587
from: noreply@example.com
auth: true
user: molecule
password: molecule-smtp-password
starttls: true
browser_security_headers:
xFrameOptions: DENY
state: present
register: result
- name: Assert realm map settings applied
ansible.builtin.assert:
that:
- result is changed
- result.end_state.attributes['molecule-number'] == '123'
- result.end_state.smtpServer.port == '587'
- result.end_state.browserSecurityHeaders.xFrameOptions == 'DENY'
- name: Re-apply realm map settings in check mode
middleware_automation.keycloak.keycloak_realm: *realm_map_settings
check_mode: true
register: result
- name: Assert check mode reports no change for unchanged map settings
ansible.builtin.assert:
that:
- result is not changed
- name: Change a realm attribute in check mode
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
attributes:
molecule-number: 456
molecule-flag: true
state: present
check_mode: true
register: result
- name: Assert check mode reports a changed realm attribute
ansible.builtin.assert:
that:
- result is changed
- name: Change the SMTP port in check mode
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
smtp_server:
host: smtp.example.com
port: 25
from: noreply@example.com
auth: true
user: molecule
password: molecule-smtp-password
starttls: true
state: present
check_mode: true
register: result
- name: Assert check mode reports a changed SMTP server
ansible.builtin.assert:
that:
- result is changed
- name: Change a browser security header in check mode
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
browser_security_headers:
xRobotsTag: all
state: present
check_mode: true
register: result
- name: Assert check mode reports a changed browser security header
ansible.builtin.assert:
that:
- result is changed
@@ -0,0 +1,526 @@
---
# Ported from community.general tests/integration/targets/keycloak_realm_key
# Tests auto-generated key providers: HMAC, AES, ECDSA, RSA, RSA-ENC, ECDH, EdDSA.
# Skips RSA with private key (needs external key material) and Java Keystore (needs keystore file).
# --- HMAC generated key ---
- name: Create HMAC key (check mode)
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
enabled: true
active: true
priority: 100
algorithm: HS256
secret_size: 64
check_mode: true
register: result
- name: Assert HMAC key would be created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "hmac-test-key"
- result.end_state.providerId == "hmac-generated"
- result.end_state.config.algorithm == ["HS256"]
- result.end_state.config.secretSize == ["64"]
- result.msg == "Realm key hmac-test-key would be created"
- name: Create HMAC key
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
enabled: true
active: true
priority: 100
algorithm: HS256
secret_size: 64
register: result
- name: Assert HMAC key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "hmac-test-key"
- result.end_state.providerId == "hmac-generated"
- result.end_state.providerType == "org.keycloak.keys.KeyProvider"
- result.end_state.config.algorithm == ["HS256"]
- result.end_state.config.secretSize == ["64"]
- result.msg == "Realm key hmac-test-key created"
- name: Create HMAC key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
enabled: true
active: true
priority: 100
algorithm: HS256
secret_size: 64
register: result
- name: Assert HMAC key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key hmac-test-key was in sync"
- name: Update HMAC key priority
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
enabled: true
active: true
priority: 110
algorithm: HS256
secret_size: 64
register: result
- name: Assert HMAC key was updated
ansible.builtin.assert:
that:
- result is changed
- result.end_state.config.priority == ["110"]
- "'config.priority' in result.msg"
- name: Remove HMAC key
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
priority: 110
register: result
- name: Assert HMAC key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- result.msg == "Realm key hmac-test-key deleted"
# --- AES generated key ---
- name: Create AES key
middleware_automation.keycloak.keycloak_realm_key:
name: aes-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: aes-generated
config:
enabled: true
active: true
priority: 100
secret_size: 32
register: result
- name: Assert AES key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "aes-test-key"
- result.end_state.providerId == "aes-generated"
- result.end_state.config.secretSize == ["32"]
- result.msg == "Realm key aes-test-key created"
- name: Create AES key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: aes-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: aes-generated
config:
enabled: true
active: true
priority: 100
secret_size: 32
register: result
- name: Assert AES key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key aes-test-key was in sync"
- name: Remove AES key
middleware_automation.keycloak.keycloak_realm_key:
name: aes-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: aes-generated
config:
priority: 100
register: result
- name: Assert AES key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.msg == "Realm key aes-test-key deleted"
# --- ECDSA generated key ---
- name: Create ECDSA key
middleware_automation.keycloak.keycloak_realm_key:
name: ecdsa-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: ecdsa-generated
config:
enabled: true
active: true
priority: 100
algorithm: ES256
elliptic_curve: P-256
register: result
- name: Assert ECDSA key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "ecdsa-test-key"
- result.end_state.providerId == "ecdsa-generated"
- result.end_state.config.algorithm == ["ES256"]
- result.end_state.config.ecdsaEllipticCurveKey == ["P-256"]
- result.msg == "Realm key ecdsa-test-key created"
- name: Create ECDSA key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: ecdsa-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: ecdsa-generated
config:
enabled: true
active: true
priority: 100
algorithm: ES256
elliptic_curve: P-256
register: result
- name: Assert ECDSA key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key ecdsa-test-key was in sync"
- name: Remove ECDSA key
middleware_automation.keycloak.keycloak_realm_key:
name: ecdsa-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: ecdsa-generated
config:
priority: 100
register: result
- name: Assert ECDSA key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.msg == "Realm key ecdsa-test-key deleted"
# --- RSA generated key ---
- name: Create RSA generated key
middleware_automation.keycloak.keycloak_realm_key:
name: rsa-gen-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: rsa-generated
config:
enabled: true
active: true
priority: 100
algorithm: RS256
key_size: 2048
register: result
- name: Assert RSA generated key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "rsa-gen-test-key"
- result.end_state.providerId == "rsa-generated"
- result.end_state.config.algorithm == ["RS256"]
- result.end_state.config.keySize == ["2048"]
- result.msg == "Realm key rsa-gen-test-key created"
- name: Create RSA generated key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: rsa-gen-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: rsa-generated
config:
enabled: true
active: true
priority: 100
algorithm: RS256
key_size: 2048
register: result
- name: Assert RSA generated key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key rsa-gen-test-key was in sync"
- name: Remove RSA generated key
middleware_automation.keycloak.keycloak_realm_key:
name: rsa-gen-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: rsa-generated
config:
priority: 100
register: result
- name: Assert RSA generated key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.msg == "Realm key rsa-gen-test-key deleted"
# --- Default realm key management ---
- name: Update priority of default hmac-generated key
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-generated
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
enabled: true
active: true
priority: 150
algorithm: HS256
register: result
- name: Assert default hmac-generated key was updated
ansible.builtin.assert:
that:
- result is changed
- result.end_state.config.priority == ["150"]
- name: Remove default hmac-generated key
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-generated
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
priority: 150
register: result
- name: Assert default hmac-generated key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- result.msg == "Realm key hmac-generated deleted"
# --- RSA encryption generated key ---
- name: Create RSA encryption key
middleware_automation.keycloak.keycloak_realm_key:
name: rsa-enc-gen-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: rsa-enc-generated
config:
enabled: true
active: true
priority: 100
algorithm: RSA-OAEP
key_size: 2048
register: result
- name: Assert RSA encryption key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "rsa-enc-gen-test-key"
- result.end_state.providerId == "rsa-enc-generated"
- result.end_state.config.algorithm == ["RSA-OAEP"]
- result.end_state.config.keySize == ["2048"]
- result.msg == "Realm key rsa-enc-gen-test-key created"
- name: Create RSA encryption key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: rsa-enc-gen-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: rsa-enc-generated
config:
enabled: true
active: true
priority: 100
algorithm: RSA-OAEP
key_size: 2048
register: result
- name: Assert RSA encryption key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key rsa-enc-gen-test-key was in sync"
- name: Remove RSA encryption key
middleware_automation.keycloak.keycloak_realm_key:
name: rsa-enc-gen-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: rsa-enc-generated
config:
priority: 100
register: result
- name: Assert RSA encryption key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.msg == "Realm key rsa-enc-gen-test-key deleted"
# --- ECDH generated key ---
- name: Create ECDH key
middleware_automation.keycloak.keycloak_realm_key:
name: ecdh-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: ecdh-generated
config:
enabled: true
active: true
priority: 100
algorithm: ECDH_ES
elliptic_curve: P-256
register: result
- name: Assert ECDH key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "ecdh-test-key"
- result.end_state.providerId == "ecdh-generated"
- result.end_state.config.algorithm == ["ECDH_ES"]
- result.end_state.config.ecdhEllipticCurveKey == ["P-256"]
- result.msg == "Realm key ecdh-test-key created"
- name: Create ECDH key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: ecdh-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: ecdh-generated
config:
enabled: true
active: true
priority: 100
algorithm: ECDH_ES
elliptic_curve: P-256
register: result
- name: Assert ECDH key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key ecdh-test-key was in sync"
- name: Remove ECDH key
middleware_automation.keycloak.keycloak_realm_key:
name: ecdh-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: ecdh-generated
config:
priority: 100
register: result
- name: Assert ECDH key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.msg == "Realm key ecdh-test-key deleted"
# --- EdDSA generated key ---
- name: Create EdDSA key
middleware_automation.keycloak.keycloak_realm_key:
name: eddsa-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: eddsa-generated
config:
enabled: true
active: true
priority: 100
elliptic_curve: Ed25519
register: result
- name: Assert EdDSA key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "eddsa-test-key"
- result.end_state.providerId == "eddsa-generated"
- result.end_state.config.eddsaEllipticCurveKey == ["Ed25519"]
- result.msg == "Realm key eddsa-test-key created"
- name: Create EdDSA key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: eddsa-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: eddsa-generated
config:
enabled: true
active: true
priority: 100
elliptic_curve: Ed25519
register: result
- name: Assert EdDSA key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key eddsa-test-key was in sync"
- name: Remove EdDSA key
middleware_automation.keycloak.keycloak_realm_key:
name: eddsa-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: eddsa-generated
config:
priority: 100
register: result
- name: Assert EdDSA key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.msg == "Realm key eddsa-test-key deleted"
@@ -0,0 +1,6 @@
---
keycloak_username: test
keycloak_user_groups:
- name: test
state: present
- name: test2
@@ -0,0 +1,57 @@
---
# Ported from community.general tests/integration/targets/keycloak_realm_users_info
# Tests multi-user listing and group membership in realm users info response.
- name: Load realm users info test variables
ansible.builtin.include_vars:
file: vars.yml
- name: Create new groups
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: "{{ item.name }}"
state: present
loop: "{{ keycloak_user_groups }}"
- name: Create user
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
groups: "{{ keycloak_user_groups }}"
state: present
register: create_result
- name: Assert user is created
ansible.builtin.assert:
that:
- create_result.changed
- create_result.end_state.username == 'test'
- create_result.end_state.groups | length == 2
- name: Create another user
middleware_automation.keycloak.keycloak_user:
username: "testuser2"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes2
last_name: Untestes2
email: ceciestuntestes2@test.com
state: present
register: create_result2
- name: Get user info
middleware_automation.keycloak.keycloak_realm_users_info:
realm: "{{ ephemeral_realm }}"
register: user_infos
- name: Add missing group info for comparison
ansible.builtin.set_fact:
user_info_with_groups: "{{ [user_infos.users[0] | combine({'groups': ['test', 'test2']}), user_infos.users[1] | combine({'groups': []}) ] }}"
- name: Assert user info is returned correctly
ansible.builtin.assert:
that:
- not user_infos.changed
- "user_info_with_groups == [create_result.end_state, create_result2.end_state]"
@@ -0,0 +1,32 @@
---
description_1: role test desc 1
description_2: role test desc 2
keycloak_role_description: composite role test
keycloak_role_composites:
- name: view-clients
client_id: "realm-management"
state: present
- name: query-clients
client_id: "realm-management"
state: present
- name: offline_access
state: present
keycloak_role_composites_with_aliases:
- name: view-clients
clientId: "realm-management"
state: present
- name: query-clients
clientId: "realm-management"
state: present
- name: offline_access
state: present
keycloak_role_composites_with_absent:
- name: view-clients
client_id: "realm-management"
state: present
- name: query-clients
client_id: "realm-management"
state: present
- name: offline_access
state: absent
@@ -0,0 +1,335 @@
---
# Ported from community.general tests/integration/targets/keycloak_role
# Tests full CRUD lifecycle for realm/client roles and composite role management.
- name: Load role test variables
ansible.builtin.include_vars:
file: vars.yml
# --- Realm role CRUD ---
- name: Create realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: myrole-test
description: "{{ description_1 }}"
state: present
register: result
- name: Assert realm role created
ansible.builtin.assert:
that:
- result is changed
- result.existing == {}
- result.end_state.name == "myrole-test"
- result.end_state.containerId == ephemeral_realm
- name: Create realm role again (idempotency)
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: myrole-test
description: "{{ description_1 }}"
state: present
register: result
- name: Assert realm role unchanged
ansible.builtin.assert:
that:
- result is not changed
- name: Update realm role description
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: myrole-test
description: "{{ description_2 }}"
state: present
register: result
- name: Assert realm role updated
ansible.builtin.assert:
that:
- result is changed
- result.existing.description == description_1
- result.end_state.description == description_2
- name: Delete realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: myrole-test
state: absent
register: result
- name: Assert realm role deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Delete absent realm role (idempotency)
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: myrole-test
state: absent
register: result
- name: Assert no change on absent realm role
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
# --- Client role CRUD ---
- name: Create client for role tests
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: myclient
state: present
register: role_test_client
- name: Create client role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: myclient
name: client-role-test
description: "{{ description_1 }}"
state: present
register: result
- name: Assert client role created
ansible.builtin.assert:
that:
- result is changed
- result.existing == {}
- result.end_state.name == "client-role-test"
- result.end_state.containerId == role_test_client.end_state.id
- name: Create client role again (idempotency)
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: myclient
name: client-role-test
description: "{{ description_1 }}"
state: present
register: result
- name: Assert client role unchanged
ansible.builtin.assert:
that:
- result is not changed
- name: Update client role description
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: myclient
name: client-role-test
description: "{{ description_2 }}"
state: present
register: result
- name: Assert client role updated
ansible.builtin.assert:
that:
- result is changed
- result.existing.description == description_1
- result.end_state.description == description_2
- name: Delete client role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: myclient
name: client-role-test
state: absent
register: result
- name: Assert client role deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Delete absent client role (idempotency)
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: myclient
name: client-role-test
state: absent
register: result
- name: Assert no change on absent client role
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
# --- Composite realm roles ---
- name: Create realm role with composites
middleware_automation.keycloak.keycloak_role:
name: composite-role
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites }}"
state: present
register: result
- name: Assert realm role created with composites
ansible.builtin.assert:
that:
- result is changed
- result.end_state.composites | length == 3
- name: Realm role with composites (idempotency)
middleware_automation.keycloak.keycloak_role:
name: composite-role
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites }}"
state: present
register: result
- name: Assert composites unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state.composites | length == 3
- name: Realm composites with aliases (idempotency)
middleware_automation.keycloak.keycloak_role:
name: composite-role
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites_with_aliases }}"
state: present
register: result
- name: Assert composites unchanged with aliases
ansible.builtin.assert:
that:
- result is not changed
- name: Remove one composite from realm role
middleware_automation.keycloak.keycloak_role:
name: composite-role
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites_with_absent }}"
state: present
register: result
- name: Assert composite removed
ansible.builtin.assert:
that:
- result is changed
- result.end_state.composites | length == 2
- name: Delete composite realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: composite-role
state: absent
register: result
- name: Assert composite role deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Delete absent realm role with composites
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: composite-role
state: absent
register: result
- name: Assert not changed and realm role absent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
# --- Composite client roles ---
- name: Create client role with composites
middleware_automation.keycloak.keycloak_role:
name: composite-client-role
client_id: myclient
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites }}"
state: present
register: result
- name: Assert client role created with composites
ansible.builtin.assert:
that:
- result is changed
- result.end_state.composites | length == 3
- name: Client role with composites (idempotency)
middleware_automation.keycloak.keycloak_role:
name: composite-client-role
client_id: myclient
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites }}"
state: present
register: result
- name: Assert client composites unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state.composites | length == 3
- name: Remove one composite from client role
middleware_automation.keycloak.keycloak_role:
name: composite-client-role
client_id: myclient
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites_with_absent }}"
state: present
register: result
- name: Assert composite removed from client role
ansible.builtin.assert:
that:
- result is changed
- result.end_state.composites | length == 2
- name: Delete composite client role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: composite-client-role
client_id: myclient
state: absent
register: result
- name: Assert composite client role deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Delete absent client role with composites
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: composite-client-role
client_id: myclient
state: absent
register: result
- name: Assert not changed and client role absent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
@@ -0,0 +1,19 @@
---
keycloak_username: test
keycloak_user_attributes:
- name: attr1
values:
- value1s
state: present
- name: attr2
values:
- value2s
state: present
- name: attr3
values:
- value3s
state: present
keycloak_user_groups:
- name: test
state: present
- name: test2
@@ -0,0 +1,347 @@
---
# Ported from community.general tests/integration/targets/keycloak_user
# Tests: user with groups+attributes, plus-addressed email, email_verified default reset,
# required_actions explicit reset to empty list.
- name: Load user test variables
ansible.builtin.include_vars:
file: vars.yml
- name: Create new groups
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: "{{ item.name }}"
state: present
loop: "{{ keycloak_user_groups }}"
- name: Create user
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
groups: "{{ keycloak_user_groups }}"
attributes: "{{ keycloak_user_attributes }}"
state: present
register: create_result
- name: Assert user is created
ansible.builtin.assert:
that:
- create_result.changed
- create_result.end_state.username == 'test'
- create_result.end_state.userProfileMetadata.attributes | length == 4
- create_result.end_state.groups | length == 2
- name: Delete User
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
groups: "{{ keycloak_user_groups }}"
attributes: "{{ keycloak_user_attributes }}"
state: absent
register: delete_result
- name: Assert user is deleted
ansible.builtin.assert:
that:
- delete_result.changed
- delete_result.end_state | length == 0
- name: Create user with plus-addressed email
middleware_automation.keycloak.keycloak_user:
username: "testuser+tag"
realm: "{{ ephemeral_realm }}"
first_name: Plus
last_name: User
email: "testuser+tag@example.org"
state: present
register: plus_create_result
- name: Assert plus-addressed user is created
ansible.builtin.assert:
that:
- plus_create_result.changed
- plus_create_result.end_state.username == 'testuser+tag'
- plus_create_result.end_state.email == 'testuser+tag@example.org'
- name: Re-run plus-addressed user creation (idempotency)
middleware_automation.keycloak.keycloak_user:
username: "testuser+tag"
realm: "{{ ephemeral_realm }}"
first_name: Plus
last_name: User
email: "testuser+tag@example.org"
state: present
register: plus_idempotent_result
- name: Assert plus-addressed user is idempotent
ansible.builtin.assert:
that:
- plus_idempotent_result is not changed
- name: Delete plus-addressed user
middleware_automation.keycloak.keycloak_user:
username: "testuser+tag"
realm: "{{ ephemeral_realm }}"
state: absent
register: plus_delete_result
- name: Assert plus-addressed user is deleted
ansible.builtin.assert:
that:
- plus_delete_result.changed
- name: Create user again
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
state: present
email_verified_behavior: no_defaults
register: create_result
- name: Assert user is created without email_verified
ansible.builtin.assert:
that:
- create_result.changed
- create_result.end_state.username == 'test'
- create_result.end_state.emailVerified == false
- name: Set email_verified
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
groups: "{{ keycloak_user_groups }}"
attributes: "{{ keycloak_user_attributes }}"
email_verified: true
state: present
register: create_result
- name: Assert email_verified is set
ansible.builtin.assert:
that:
- create_result.changed
- create_result.end_state.emailVerified == True
- name: Leave email_verified as it is
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
state: present
email_verified_behavior: no_defaults
register: create_result
- name: Assert email_verified is still set
ansible.builtin.assert:
that:
- not create_result.changed
- create_result.end_state.emailVerified == True
- name: Test old email_verified behavior
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
state: present
register: create_result
- name: Assert email_verified is reset
ansible.builtin.assert:
that:
- create_result.changed
- create_result.end_state.emailVerified == False
- name: Test setting required_actions
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
required_actions:
- UPDATE_PASSWORD
- VERIFY_EMAIL
state: present
register: create_result
- name: Assert required_actions are set
ansible.builtin.assert:
that:
- create_result.changed
- "'UPDATE_PASSWORD' in create_result.end_state.requiredActions"
- "'VERIFY_EMAIL' in create_result.end_state.requiredActions"
- name: Test required_actions unchanged
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
state: present
register: create_result
- name: Assert required_actions are still set
ansible.builtin.assert:
that:
- not create_result.changed
- "'UPDATE_PASSWORD' in create_result.end_state.requiredActions"
- "'VERIFY_EMAIL' in create_result.end_state.requiredActions"
- name: Test required_actions reset
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
state: present
required_actions: []
register: create_result
- name: Assert required_actions are reset
ansible.builtin.assert:
that:
- create_result.changed
- create_result.end_state.requiredActions == []
- name: Create user for check mode tests
middleware_automation.keycloak.keycloak_user:
username: check-mode-user
realm: "{{ ephemeral_realm }}"
state: present
- name: Re-run with identical input in check mode
middleware_automation.keycloak.keycloak_user:
username: check-mode-user
realm: "{{ ephemeral_realm }}"
state: present
check_mode: true
register: check_mode_result
- name: Assert check mode reports no change for identical input
ansible.builtin.assert:
that:
- check_mode_result is not changed
- name: Add the user to a group
middleware_automation.keycloak.keycloak_user:
username: check-mode-user
realm: "{{ ephemeral_realm }}"
groups:
- name: test
state: present
- name: Re-run with identical groups in check mode
middleware_automation.keycloak.keycloak_user:
username: check-mode-user
realm: "{{ ephemeral_realm }}"
groups:
- name: test
state: present
check_mode: true
register: check_mode_result
- name: Assert check mode reports no change for identical groups
ansible.builtin.assert:
that:
- check_mode_result is not changed
- name: Join a second group in check mode
middleware_automation.keycloak.keycloak_user:
username: check-mode-user
realm: "{{ ephemeral_realm }}"
groups:
- name: test
- name: test2
state: present
check_mode: true
register: check_mode_result
- name: Assert check mode reports joining a group as a change
ansible.builtin.assert:
that:
- check_mode_result is changed
- name: Create a parent group and a subgroup for check mode tests
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: "{{ item.name }}"
parents: "{{ item.parents | default(omit) }}"
state: present
loop:
- name: check-mode-parent
- name: check-mode-child
parents:
- name: check-mode-parent
- name: Add the user to the subgroup by path
middleware_automation.keycloak.keycloak_user:
username: check-mode-user
realm: "{{ ephemeral_realm }}"
groups:
- name: test
- name: /check-mode-parent/check-mode-child
state: present
- name: Re-run with identical groups given by path in check mode
middleware_automation.keycloak.keycloak_user:
username: check-mode-user
realm: "{{ ephemeral_realm }}"
groups:
- name: test
- name: /check-mode-parent/check-mode-child
state: present
check_mode: true
register: check_mode_result
- name: Assert check mode reports no change for identical groups given by path
ansible.builtin.assert:
that:
- check_mode_result is not changed
- check_mode_result.end_state.groups | sort == ['check-mode-child', 'test']
- name: Leave the subgroup by path in check mode
middleware_automation.keycloak.keycloak_user:
username: check-mode-user
realm: "{{ ephemeral_realm }}"
groups:
- name: test
- name: /check-mode-parent/check-mode-child
state: absent
state: present
check_mode: true
register: check_mode_result
- name: Assert check mode reports leaving a group given by path as a change
ansible.builtin.assert:
that:
- check_mode_result is changed
- check_mode_result.end_state.groups == ['test']
- name: Delete user for check mode tests
middleware_automation.keycloak.keycloak_user:
username: check-mode-user
realm: "{{ ephemeral_realm }}"
state: absent
register: check_mode_delete_result
- name: Assert user for check mode tests is deleted
ansible.builtin.assert:
that:
- check_mode_delete_result.changed
@@ -0,0 +1,2 @@
---
federation: myfed
@@ -0,0 +1,352 @@
---
# Ported from community.general tests/integration/targets/keycloak_user_federation
# Tests full LDAP user federation lifecycle: create, idempotency (with masked credentials),
# update with mappers, delete, delete-absent, and create-with-mappers-in-one-step.
- name: Load user federation test variables
ansible.builtin.include_vars:
file: vars.yml
- name: Create new user federation
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldaps://ldap.example.com:636"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: secret
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
debug: false
register: result
- name: Assert user federation created
ansible.builtin.assert:
that:
- result is changed
- result.existing == {}
- result.end_state.name == federation
- name: Create new user federation in admin realm
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ auth_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldaps://ldap.example.com:636"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: secret
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
debug: false
register: result
- name: Assert user federation created (admin realm)
ansible.builtin.assert:
that:
- result is changed
- result.existing == {}
- result.end_state.name == federation
- name: Update existing user federation (no change)
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldaps://ldap.example.com:636"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: "**********"
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
debug: false
register: result
- name: Assert user federation unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.existing != {}
- result.existing.name == federation
- result.end_state != {}
- result.end_state.name == federation
- name: Update existing user federation (no change, admin realm)
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ auth_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldaps://ldap.example.com:636"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: "**********"
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
debug: false
register: result
- name: Assert user federation unchanged (admin realm)
ansible.builtin.assert:
that:
- result is not changed
- result.existing != {}
- result.existing.name == federation
- result.end_state != {}
- result.end_state.name == federation
- name: Update existing user federation (with change)
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldaps://ldap.example.com:636"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: "**********"
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
debug: false
mappers:
- name: "username"
providerId: "user-attribute-ldap-mapper"
config:
ldap.attribute: ldap_user
user.model.attribute: usr
read.only: true
- name: "full name"
providerId: "full-name-ldap-mapper"
providerType: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
config:
ldap.full.name.attribute: cn
read.only: true
write.only: false
register: result
- name: Assert user federation created
ansible.builtin.assert:
that:
- result is changed
- result.existing != {}
- result.existing.name == federation
- result.end_state != {}
- result.end_state.name == federation
- name: Delete existing user federation
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: absent
register: result
- name: Assert user federation deleted
ansible.builtin.assert:
that:
- result is changed
- result.existing != {}
- result.end_state == {}
- name: Delete absent user federation
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: absent
register: result
- name: Assert user federation unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.existing == {}
- result.end_state == {}
- name: Create new user federation together with mappers
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldaps://ldap.example.com:636"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: secret
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
debug: false
mappers:
- name: "username"
providerId: "user-attribute-ldap-mapper"
config:
ldap.attribute: ldap_user
user.model.attribute: usr
read.only: true
- name: "full name"
providerId: "full-name-ldap-mapper"
providerType: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
config:
ldap.full.name.attribute: cn
read.only: true
write.only: false
register: result
- name: Assert user federation created
ansible.builtin.assert:
that:
- result is changed
- result.existing == {}
- result.end_state.name == federation
- name: Clean up - delete user federation
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: absent
- name: Clean up - delete user federation (admin realm)
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ auth_realm }}"
name: "{{ federation }}"
state: absent
@@ -0,0 +1,5 @@
---
client_id: myclient
client_id_2: myotherclient
test_role: myrole
description_1: desc 1
@@ -0,0 +1,141 @@
---
# Ported from community.general tests/integration/targets/keycloak_user_rolemapping
# Tests service account role mapping (realm and client roles) and cross-client mapping.
- name: Load user rolemapping test variables
ansible.builtin.include_vars:
file: vars.yml
- name: Create client with service account for rolemapping test
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
service_accounts_enabled: true
state: present
register: rolemapping_client
- name: Create realm role for service account mapping
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ test_role }}"
description: "{{ description_1 }}"
state: present
- name: Map realm role to client service account
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ ephemeral_realm }}"
service_account_user_client_id: "{{ client_id }}"
roles:
- name: "{{ test_role }}"
state: present
register: result
- name: Assert realm role is assigned to service account
ansible.builtin.assert:
that:
- result is changed
- result.end_state | selectattr("clientRole", "eq", false) | selectattr("name", "eq", test_role) | list | count > 0
- name: Unmap realm role from client service account
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ ephemeral_realm }}"
service_account_user_client_id: "{{ client_id }}"
roles:
- name: "{{ test_role }}"
state: absent
register: result
- name: Assert realm role is unassigned from service account
ansible.builtin.assert:
that:
- result is changed
- (result.end_state | length) == (result.existing | length) - 1
- result.existing | selectattr("clientRole", "eq", false) | selectattr("name", "eq", test_role) | list | count > 0
- result.end_state | selectattr("clientRole", "eq", false) | selectattr("name", "eq", test_role) | list | count == 0
- name: Delete existing realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ test_role }}"
state: absent
- name: Create second client for cross-client role mapping test
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id_2 }}"
service_accounts_enabled: true
state: present
register: client_2
- name: Create new client role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
name: "{{ test_role }}"
description: "{{ description_1 }}"
state: present
- name: Map client role to user with no existing roles for that client
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
service_account_user_client_id: "{{ client_id_2 }}"
roles:
- name: "{{ test_role }}"
state: present
register: result
- name: Assert client role is assigned to user with no prior roles
ansible.builtin.assert:
that:
- result is changed
- result.end_state | selectattr("clientRole", "eq", true) | selectattr("name", "eq", test_role) | list | count > 0
- name: Unmap the cross-client role mapping
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
service_account_user_client_id: "{{ client_id_2 }}"
roles:
- name: "{{ test_role }}"
state: absent
register: result
- name: Assert cross-client role mapping is removed
ansible.builtin.assert:
that:
- result is changed
- result.end_state == []
- name: Map client role to client service account
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
service_account_user_client_id: "{{ client_id }}"
roles:
- name: "{{ test_role }}"
state: present
register: result
- name: Assert client role is assigned
ansible.builtin.assert:
that:
- result is changed
- result.end_state | selectattr("clientRole", "eq", true) | selectattr("name", "eq", test_role) | list | count > 0
- name: Unmap client role from client service account
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
service_account_user_client_id: "{{ client_id }}"
roles:
- name: "{{ test_role }}"
state: absent
register: result
- name: Assert client role is unassigned
ansible.builtin.assert:
that:
- result is changed
- result.end_state == []
- result.existing | selectattr("clientRole", "eq", true) | selectattr("name", "eq", test_role) | list | count > 0
@@ -0,0 +1,128 @@
---
attributes_default:
- name: username
displayName: "${username}"
validations:
length:
min: 3
max: 255
usernameProhibitedCharacters: {}
up_username_not_idn_homograph: {}
annotations: {}
permissions:
view:
- admin
- user
edit: []
multivalued: false
- name: email
displayName: "${email}"
validations:
email: {}
length:
max: 255
annotations: {}
required:
roles:
- user
permissions:
view:
- admin
- user
edit: []
multivalued: false
- name: firstName
displayName: "${firstName}"
validations:
length:
max: 255
personNameProhibitedCharacters: {}
annotations: {}
required:
roles:
- user
permissions:
view:
- admin
- user
edit: []
multivalued: false
- name: lastName
displayName: "${lastName}"
validations:
length:
max: 255
person_name_prohibited_characters: {}
annotations: {}
required:
roles:
- user
permissions:
view:
- admin
- user
edit: []
multivalued: false
attributes_additional:
- name: additionalAttribute
displayName: additionalAttribute
group: user-metadata
required:
roles:
- user
permissions:
view:
- admin
- user
edit: []
multivalued: false
groups_default:
- name: user-metadata
displayHeader: User metadata
displayDescription: Attributes, which refer to user metadata
config_default:
kc_user_profile_config:
- attributes: "{{ attributes_default }}"
groups: "{{ groups_default }}"
config_updated:
kc_user_profile_config:
- attributes: "{{ attributes_default + attributes_additional }}"
groups: "{{ groups_default }}"
config_unmanaged_attributes_enabled:
kc_user_profile_config:
- unmanagedAttributePolicy: ENABLED
attributes: "{{ attributes_default }}"
config_unmanaged_attributes_admin_edit:
kc_user_profile_config:
- unmanagedAttributePolicy: ADMIN_EDIT
attributes: "{{ attributes_default }}"
config_unmanaged_attributes_admin_view:
kc_user_profile_config:
- unmanagedAttributePolicy: ADMIN_VIEW
attributes: "{{ attributes_default }}"
attributes_required_by_scope:
- name: requiredByScope
displayName: requiredByScope
required:
roles:
- user
scopes:
- profile
permissions:
view:
- admin
- user
edit: []
multivalued: false
config_required_by_scope:
kc_user_profile_config:
- attributes: "{{ attributes_default + attributes_required_by_scope }}"
@@ -0,0 +1,214 @@
---
# Ported from community.general tests/integration/targets/keycloak_userprofile
# Tests full CRUD cycle with check_mode for user profile config,
# switching between unmanaged attribute policies (ENABLED, ADMIN_EDIT, ADMIN_VIEW).
- name: Load user profile config variables
ansible.builtin.include_vars:
file: vars.yml
- name: Create default User Profile (check mode)
middleware_automation.keycloak.keycloak_userprofile:
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_default }}"
check_mode: true
register: result
- name: Assert User Profile would be created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg == "Userprofile declarative-user-profile would be created"
- name: Create default User Profile
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_default }}"
diff: true
register: result
- name: Assert User Profile was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg == "Userprofile declarative-user-profile created"
- name: Create default User Profile (idempotency)
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_default }}"
register: result
- name: Assert User Profile was in sync
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg == "Userprofile declarative-user-profile was in sync"
- name: Update User Profile (check mode)
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_updated }}"
check_mode: true
register: result
- name: Assert User Profile would be changed
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg.startswith("Userprofile declarative-user-profile would be changed:")
- name: Update User Profile
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_updated }}"
diff: true
register: result
- name: Assert User Profile changed
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg.startswith("Userprofile declarative-user-profile changed:")
- name: Update User Profile (idempotency)
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_updated }}"
register: result
- name: Assert User Profile still in sync
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg == "Userprofile declarative-user-profile was in sync"
- name: Remove User Profile
middleware_automation.keycloak.keycloak_userprofile:
state: absent
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_default }}"
diff: true
register: result
- name: Assert User Profile was deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- result.msg == "Userprofile declarative-user-profile deleted"
- name: Remove User Profile (idempotency)
middleware_automation.keycloak.keycloak_userprofile:
state: absent
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_default }}"
register: result
- name: Assert User Profile not present
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
- result.msg == "Userprofile declarative-user-profile not present"
- name: Create User Profile with unmanaged attributes ENABLED
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_unmanaged_attributes_enabled }}"
diff: true
register: result
- name: Assert User Profile created with ENABLED policy
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg == "Userprofile declarative-user-profile created"
- name: Change User Profile to unmanaged ADMIN_EDIT
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_unmanaged_attributes_admin_edit }}"
diff: true
register: result
- name: Assert User Profile changed to ADMIN_EDIT
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg.startswith("Userprofile declarative-user-profile changed:")
- name: Change User Profile to unmanaged ADMIN_VIEW
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_unmanaged_attributes_admin_view }}"
diff: true
register: result
- name: Assert User Profile changed to ADMIN_VIEW
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg.startswith("Userprofile declarative-user-profile changed:")
- name: Require an attribute only for a client scope
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_required_by_scope }}"
diff: true
register: result
- name: Assert the attribute is required for the scope
ansible.builtin.assert:
that:
- result is changed
- (result.end_state.config['kc.user.profile.config'][0].attributes | selectattr('name', 'equalto', 'requiredByScope') | first).required.scopes == ['profile']
- name: Require an attribute only for a client scope (idempotency)
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_required_by_scope }}"
register: result
- name: Assert the scoped requirement is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Userprofile declarative-user-profile was in sync"
+347 -93
View File
@@ -103,13 +103,13 @@
state: absent
failed_when: false
- name: keycloak_role — create realm role for module tests
- name: keycloak_role - create realm role for module tests
middleware_automation.keycloak.keycloak_role:
realm: "{{ target_realm }}"
name: "{{ role }}"
state: present
- name: keycloak_client — create confidential client for module tests
- name: keycloak_client - create confidential client for module tests
middleware_automation.keycloak.keycloak_client:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
@@ -121,7 +121,7 @@
secret: molecule-client-secret
state: present
- name: keycloak_client — enable authorization services on test client
- name: keycloak_client - enable authorization services on test client
middleware_automation.keycloak.keycloak_client:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
@@ -130,26 +130,26 @@
full_scope_allowed: false
state: present
- name: keycloak_role — create client role for rolemapping tests
- name: keycloak_role - create client role for rolemapping tests
middleware_automation.keycloak.keycloak_role:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
name: "{{ client_role }}"
state: present
- name: keycloak_client_scope — create client scope
- name: keycloak_client_scope - create client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ target_realm }}"
name: "{{ scope }}"
state: present
- name: keycloak_group — create group
- name: keycloak_group - create group
middleware_automation.keycloak.keycloak_group:
realm: "{{ target_realm }}"
name: "{{ group }}"
state: present
- name: keycloak_user — create user
- name: keycloak_user - create user
middleware_automation.keycloak.keycloak_user:
realm: "{{ target_realm }}"
username: "{{ user }}"
@@ -159,13 +159,13 @@
enabled: true
state: present
- name: keycloak_role — create realm role for restricted admin test
- name: keycloak_role - create realm role for restricted admin test
middleware_automation.keycloak.keycloak_role:
realm: "{{ target_realm }}"
name: "{{ role }}-restricted"
state: present
- name: keycloak_user — create restricted admin in master (manage-users only, no view-realm)
- name: keycloak_user - create restricted admin in master (manage-users only, no view-realm)
middleware_automation.keycloak.keycloak_user:
realm: master
username: molecule-restricted-admin
@@ -178,7 +178,7 @@
temporary: false
state: present
- name: keycloak_user_rolemapping — grant manage-users for TestRealm to restricted admin
- name: keycloak_user_rolemapping - grant manage-users for TestRealm to restricted admin
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: master
target_username: molecule-restricted-admin
@@ -188,7 +188,7 @@
- name: manage-users
- name: view-users
- name: keycloak_authentication_flow — create browser-style flow
- name: keycloak_authentication_flow - create browser-style flow
middleware_automation.keycloak.keycloak_authentication_flow:
realm: "{{ target_realm }}"
alias: "{{ flow }}"
@@ -198,7 +198,7 @@
requirement: REQUIRED
state: present
- name: keycloak_realm_info — query TestRealm (public endpoint, no admin auth)
- name: keycloak_realm_info - query TestRealm (public endpoint, no admin auth)
middleware_automation.keycloak.keycloak_realm_info:
auth_keycloak_url: "{{ auth_keycloak_url }}"
realm: "{{ target_realm }}"
@@ -213,15 +213,15 @@
auth_password: "{{ auth_password }}"
validate_certs: false
block:
- name: keycloak_realm_keys_metadata_info — query realm keys
- name: keycloak_realm_keys_metadata_info - query realm keys
middleware_automation.keycloak.keycloak_realm_keys_metadata_info:
realm: "{{ target_realm }}"
- name: keycloak_component_info — list realm components
- name: keycloak_component_info - list realm components
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ target_realm }}"
- name: keycloak_realm_users_info — list users in realm
- name: keycloak_realm_users_info - list users in realm
middleware_automation.keycloak.keycloak_realm_users_info:
realm: "{{ target_realm }}"
register: realm_users_info_result
@@ -233,14 +233,14 @@
- realm_users_info_result.users | length > 0
- realm_users_info_result.users | selectattr('username', 'equalto', user) | list | length == 1
- name: keycloak_realm — create ephemeral realm
- name: keycloak_realm - create ephemeral realm
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
enabled: true
state: present
- name: keycloak_realm — modify realm attributes without pruning undefined attributes. Step 1 - Introduce custom realm attributes
- name: keycloak_realm - modify realm attributes without pruning undefined attributes. Step 1 - Introduce custom realm attributes
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
@@ -259,7 +259,7 @@
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-1"] == "123"
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-2"] == "true"
- name: keycloak_realm — modify realm attributes without pruning undefined attributes. Step 2 - Verify unchanged custom realm attributes
- name: keycloak_realm - modify realm attributes without pruning undefined attributes. Step 2 - Verify unchanged custom realm attributes
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
@@ -277,7 +277,7 @@
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-1"] == "123" # should still be 123
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-2"] == "false"
- name: keycloak_realm — modify realm attributes with pruning undefined attributes
- name: keycloak_realm - modify realm attributes with pruning undefined attributes
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
@@ -296,16 +296,84 @@
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-2"] is not defined
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-3"] == "custom-attribute-3"
- name: keycloak_realm - session timeout and OAuth2 device settings
ansible.builtin.include_tasks:
file: keycloak_realm/verify.yml
- name: keycloak_group_rolemapping - full map/unmap lifecycle
ansible.builtin.include_tasks:
file: keycloak_group_rolemapping/verify.yml
- name: keycloak_client_scope_type - realm and client scope types
ansible.builtin.include_tasks:
file: keycloak_client_scope_type/verify.yml
- name: keycloak_realm_users_info - multi-user and group membership
ansible.builtin.include_tasks:
file: keycloak_realm_users_info/verify.yml
- name: keycloak_user_rolemapping - service account role mapping
ansible.builtin.include_tasks:
file: keycloak_user_rolemapping/verify.yml
- name: keycloak_role - full CRUD and composite roles
ansible.builtin.include_tasks:
file: keycloak_role/verify.yml
- name: keycloak_user - edge cases (plus-addressed email, groups, required_actions reset)
ansible.builtin.include_tasks:
file: keycloak_user/verify.yml
- name: keycloak_identity_provider - mapper CRUD and fromUrl discovery
ansible.builtin.include_tasks:
file: keycloak_identity_provider/verify.yml
- name: keycloak_client_rolescope - multi-role and error cases
ansible.builtin.include_tasks:
file: keycloak_client_rolescope/verify.yml
- name: keycloak_client_scope_rolemappings - error paths, check_mode, multi-role
ansible.builtin.include_tasks:
file: keycloak_client_scope_rolemappings/verify.yml
- name: keycloak_user_federation - full LDAP federation lifecycle
ansible.builtin.include_tasks:
file: keycloak_user_federation/verify.yml
- name: keycloak_component_info - query patterns (name, type, parent, subcomponents)
ansible.builtin.include_tasks:
file: keycloak_component_info/verify.yml
- name: keycloak_realm_key - auto-generated key providers (7 types)
ansible.builtin.include_tasks:
file: keycloak_realm_key/verify.yml
- name: keycloak_userprofile - full CRUD with check_mode
ansible.builtin.include_tasks:
file: keycloak_userprofile/verify.yml
- name: keycloak_client - flow bindings, scopes behavior, attributes
ansible.builtin.include_tasks:
file: keycloak_client/verify.yml
- name: keycloak_group - deep subgroups, attributes, rename, cascade delete
ansible.builtin.include_tasks:
file: keycloak_group/verify.yml
- name: keycloak_authentication - conditional OTP flow CRUD and config uniqueness
ansible.builtin.include_tasks:
file: keycloak_authentication/verify.yml
# --- Organization module tests ---
- name: keycloak_realm — enable organizations on ephemeral realm
- name: keycloak_realm - enable organizations on ephemeral realm
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
organizations_enabled: true
state: present
- name: keycloak_organization — create organization
- name: keycloak_organization - create organization
middleware_automation.keycloak.keycloak_organization:
realm: "{{ ephemeral_realm }}"
name: molecule-org
@@ -325,7 +393,7 @@
- org_create_result.end_state.enabled == true
- org_create_result.end_state.id is defined
- name: keycloak_organization — create organization (idempotency)
- name: keycloak_organization - create organization (idempotency)
middleware_automation.keycloak.keycloak_organization:
realm: "{{ ephemeral_realm }}"
name: molecule-org
@@ -341,7 +409,7 @@
that:
- org_create_idempotent_result is not changed
- name: keycloak_organization — update organization description
- name: keycloak_organization - update organization description
middleware_automation.keycloak.keycloak_organization:
realm: "{{ ephemeral_realm }}"
name: molecule-org
@@ -355,7 +423,7 @@
- org_update_result is changed
- org_update_result.end_state.description == "Updated molecule test organization"
- name: keycloak_organization — update organization (idempotency)
- name: keycloak_organization - update organization (idempotency)
middleware_automation.keycloak.keycloak_organization:
realm: "{{ ephemeral_realm }}"
name: molecule-org
@@ -368,7 +436,7 @@
that:
- org_update_idempotent_result is not changed
- name: keycloak_organization_info — query organization by name
- name: keycloak_organization_info - query organization by name
middleware_automation.keycloak.keycloak_organization_info:
realm: "{{ ephemeral_realm }}"
name: molecule-org
@@ -381,7 +449,7 @@
- org_info_result.organizations | length == 1
- org_info_result.organizations[0].name == "molecule-org"
- name: keycloak_organization_info — list all organizations
- name: keycloak_organization_info - list all organizations
middleware_automation.keycloak.keycloak_organization_info:
realm: "{{ ephemeral_realm }}"
register: org_info_all_result
@@ -391,7 +459,7 @@
that:
- org_info_all_result.organizations | length >= 1
- name: keycloak_organization — create organization with attributes
- name: keycloak_organization - create organization with attributes
middleware_automation.keycloak.keycloak_organization:
realm: "{{ ephemeral_realm }}"
name: molecule-org-attrs
@@ -411,7 +479,7 @@
- org_attrs_result.end_state.attributes.department == ["engineering"]
- org_attrs_result.end_state.attributes.tags == ["test", "molecule"]
- name: keycloak_organization — delete organization with attributes
- name: keycloak_organization - delete organization with attributes
middleware_automation.keycloak.keycloak_organization:
realm: "{{ ephemeral_realm }}"
name: molecule-org-attrs
@@ -423,7 +491,7 @@
that:
- org_attrs_delete_result is changed
- name: keycloak_organization — delete organization
- name: keycloak_organization - delete organization
middleware_automation.keycloak.keycloak_organization:
realm: "{{ ephemeral_realm }}"
name: molecule-org
@@ -435,7 +503,7 @@
that:
- org_delete_result is changed
- name: keycloak_organization — delete organization (idempotency)
- name: keycloak_organization - delete organization (idempotency)
middleware_automation.keycloak.keycloak_organization:
realm: "{{ ephemeral_realm }}"
name: molecule-org
@@ -447,7 +515,7 @@
that:
- org_delete_idempotent_result is not changed
- name: keycloak_realm_localization — set locale override
- name: keycloak_realm_localization - set locale override
middleware_automation.keycloak.keycloak_realm_localization:
parent_id: "{{ target_realm }}"
locale: en
@@ -456,25 +524,25 @@
- key: molecule.module.test
value: molecule module test
- name: keycloak_realm_key — create generated AES key component
- name: keycloak_realm_key - create generated AES key component
middleware_automation.keycloak.keycloak_realm_key:
parent_id: "{{ target_realm }}"
name: "{{ realm_key }}"
provider_id: aes-generated
state: present
- name: keycloak_authentication — copy browser flow
- name: keycloak_authentication - copy browser flow
middleware_automation.keycloak.keycloak_authentication:
realm: "{{ target_realm }}"
alias: "{{ auth_copy }}"
copyFrom: browser
state: present
- name: keycloak_authentication_v2 — manage flow with safe-swap semantics
- name: keycloak_authentication_v2 - manage flow with safe-swap semantics
ansible.builtin.include_tasks:
file: keycloak_authentication_v2/verify.yml
- name: keycloak_authentication_required_actions — ensure VERIFY_EMAIL is enabled
- name: keycloak_authentication_required_actions - ensure VERIFY_EMAIL is enabled
middleware_automation.keycloak.keycloak_authentication_required_actions:
realm: "{{ target_realm }}"
state: present
@@ -482,7 +550,7 @@
- alias: VERIFY_EMAIL
enabled: true
- name: keycloak_userprofile — set unmanaged attribute policy
- name: keycloak_userprofile - set unmanaged attribute policy
middleware_automation.keycloak.keycloak_userprofile:
parent_id: "{{ target_realm }}"
state: present
@@ -490,7 +558,7 @@
kc_user_profile_config:
- unmanagedAttributePolicy: ENABLED
- name: keycloak_identity_provider — create OIDC broker stub
- name: keycloak_identity_provider - create OIDC broker stub
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: "{{ idp }}"
@@ -502,7 +570,7 @@
clientId: molecule-idp-client
state: present
- name: keycloak_identity_provider — set hide_on_login via top-level param
- name: keycloak_identity_provider - set hide_on_login via top-level param
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: "{{ idp }}"
@@ -517,7 +585,7 @@
- idp_hide_on_login_result.end_state.hideOnLogin == true
- "'hide_on_login' not in (idp_hide_on_login_result.end_state.config | default({}))"
- name: keycloak_identity_provider — set hide_on_login idempotency check
- name: keycloak_identity_provider - set hide_on_login idempotency check
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: "{{ idp }}"
@@ -531,7 +599,7 @@
- idp_hide_on_login_idempotent_result is not changed
- idp_hide_on_login_idempotent_result.end_state.hideOnLogin == true
- name: keycloak_identity_provider — set hide_on_login via legacy config key (backward compat)
- name: keycloak_identity_provider - set hide_on_login via legacy config key (backward compat)
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: "{{ idp }}"
@@ -546,7 +614,52 @@
- idp_hide_on_login_off_result.end_state.hideOnLogin == false
- "'hide_on_login_page' not in (idp_hide_on_login_off_result.end_state.config | default({}))"
- name: keycloak_clienttemplate — create client template
- name: keycloak_identity_provider - set doNotStoreUsers config option
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: "{{ idp }}"
config:
doNotStoreUsers: "true"
state: present
register: idp_do_not_store_users_result
- name: Assert doNotStoreUsers is set correctly in end_state config
ansible.builtin.assert:
that:
- idp_do_not_store_users_result is changed
- idp_do_not_store_users_result.end_state.config.doNotStoreUsers == "true"
- name: keycloak_identity_provider - set doNotStoreUsers idempotency check
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: "{{ idp }}"
config:
doNotStoreUsers: "true"
state: present
register: idp_do_not_store_users_idempotent_result
- name: Assert doNotStoreUsers idempotency (no change)
ansible.builtin.assert:
that:
- idp_do_not_store_users_idempotent_result is not changed
- idp_do_not_store_users_idempotent_result.end_state.config.doNotStoreUsers == "true"
- name: keycloak_identity_provider - disable doNotStoreUsers
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: "{{ idp }}"
config:
doNotStoreUsers: "false"
state: present
register: idp_do_not_store_users_off_result
- name: Assert doNotStoreUsers can be toggled off
ansible.builtin.assert:
that:
- idp_do_not_store_users_off_result is changed
- idp_do_not_store_users_off_result.end_state.config.doNotStoreUsers == "false"
- name: keycloak_clienttemplate - create client template
middleware_automation.keycloak.keycloak_clienttemplate:
realm: "{{ target_realm }}"
name: "{{ template }}"
@@ -558,13 +671,13 @@
- "'404' not in (clienttemplate_result.msg | default(''))"
- "'Not Found' not in (clienttemplate_result.msg | default(''))"
- name: keycloak_client_scope_type — attach scope as optional on realm
- name: keycloak_client_scope_type - attach scope as optional on realm
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ target_realm }}"
optional_client_scopes:
- "{{ scope }}"
- name: keycloak_user_rolemapping — assign realm role to user
- name: keycloak_user_rolemapping - assign realm role to user
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ target_realm }}"
target_username: "{{ user }}"
@@ -572,7 +685,7 @@
roles:
- name: "{{ role }}"
- name: keycloak_user_rolemapping — assign realm role using restricted admin (no view-realm)
- name: keycloak_user_rolemapping - assign realm role using restricted admin (no view-realm)
middleware_automation.keycloak.keycloak_user_rolemapping:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
@@ -591,7 +704,7 @@
that:
- restricted_admin_rolemapping_result is changed
- name: keycloak_user_rolemapping — idempotency check with restricted admin
- name: keycloak_user_rolemapping - idempotency check with restricted admin
middleware_automation.keycloak.keycloak_user_rolemapping:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
@@ -610,7 +723,7 @@
that:
- restricted_admin_rolemapping_idempotent_result is not changed
- name: keycloak_realm_rolemapping — assign realm role to group
- name: keycloak_realm_rolemapping - assign realm role to group
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ target_realm }}"
group_name: "{{ group }}"
@@ -618,7 +731,7 @@
roles:
- name: "{{ role }}"
- name: keycloak_client_rolemapping — assign client role to group
- name: keycloak_client_rolemapping - assign client role to group
middleware_automation.keycloak.keycloak_client_rolemapping:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
@@ -627,7 +740,7 @@
roles:
- name: "{{ client_role }}"
- name: keycloak_group — create subgroup below the parent group
- name: keycloak_group - create subgroup below the parent group
middleware_automation.keycloak.keycloak_group:
realm: "{{ target_realm }}"
name: "{{ subgroup }}"
@@ -642,7 +755,7 @@
- subgroup_result is changed
- subgroup_result.end_state.path == '/' ~ group ~ '/' ~ subgroup
- name: keycloak_group — create enough siblings to exceed the children page size
- name: keycloak_group - create enough siblings to exceed the children page size
middleware_automation.keycloak.keycloak_group:
realm: "{{ target_realm }}"
name: "{{ subgroup }}-{{ item }}"
@@ -651,7 +764,7 @@
state: present
loop: "{{ range(1, 13) | list }}"
- name: keycloak_group — look up a subgroup sorting past the children page size
- name: keycloak_group - look up a subgroup sorting past the children page size
middleware_automation.keycloak.keycloak_group:
realm: "{{ target_realm }}"
name: "{{ subgroup }}-9"
@@ -666,7 +779,7 @@
- subgroup_paging_result is not changed
- subgroup_paging_result.end_state.path == '/' ~ group ~ '/' ~ subgroup ~ '-9'
- name: keycloak_realm_rolemapping — assign realm role to subgroup via parents
- name: keycloak_realm_rolemapping - assign realm role to subgroup via parents
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ target_realm }}"
group_name: "{{ subgroup }}"
@@ -682,7 +795,7 @@
that:
- subgroup_rolemapping_result is changed
- name: keycloak_client_rolescope — restrict realm role on client
- name: keycloak_client_rolescope - restrict realm role on client
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ target_realm }}"
target_client_id: "{{ client }}"
@@ -690,7 +803,7 @@
- "{{ role }}"
state: present
- name: keycloak_client_scope_rolemappings — map client roles to client scope
- name: keycloak_client_scope_rolemappings - map client roles to client scope
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
@@ -705,7 +818,7 @@
- client_scope_rolemappings_result is changed
- client_scope_rolemappings_result.end_state | length == 1
- name: keycloak_client_scope_rolemappings — remap client role (idempotency)
- name: keycloak_client_scope_rolemappings - remap client role (idempotency)
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
@@ -720,7 +833,7 @@
- client_scope_rolemappings_idempotent_result is not changed
- client_scope_rolemappings_idempotent_result.end_state | length == 1
- name: keycloak_client_scope_rolemappings — map realm role to client scope
- name: keycloak_client_scope_rolemappings - map realm role to client scope
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ target_realm }}"
client_scope_id: "{{ scope }}"
@@ -734,7 +847,7 @@
- client_scope_realm_rolemappings_result is changed
- client_scope_realm_rolemappings_result.end_state | length == 1
- name: keycloak_user — set email_verified explicitly
- name: keycloak_user - set email_verified explicitly
middleware_automation.keycloak.keycloak_user:
realm: "{{ target_realm }}"
username: "{{ user }}"
@@ -748,7 +861,7 @@
- user_email_verified_result is changed
- user_email_verified_result.end_state.emailVerified == true
- name: keycloak_user — leave email_verified unchanged with no_defaults
- name: keycloak_user - leave email_verified unchanged with no_defaults
middleware_automation.keycloak.keycloak_user:
realm: "{{ target_realm }}"
username: "{{ user }}"
@@ -762,7 +875,7 @@
- user_email_verified_idempotent_result is not changed
- user_email_verified_idempotent_result.end_state.emailVerified == true
- name: keycloak_user — set required actions
- name: keycloak_user - set required actions
middleware_automation.keycloak.keycloak_user:
realm: "{{ target_realm }}"
username: "{{ user }}"
@@ -779,7 +892,7 @@
- "'UPDATE_PASSWORD' in user_required_actions_result.end_state.requiredActions"
- "'VERIFY_EMAIL' in user_required_actions_result.end_state.requiredActions"
- name: keycloak_user — leave required actions unchanged when omitted
- name: keycloak_user - leave required actions unchanged when omitted
middleware_automation.keycloak.keycloak_user:
realm: "{{ target_realm }}"
username: "{{ user }}"
@@ -793,19 +906,35 @@
- "'UPDATE_PASSWORD' in user_required_actions_idempotent_result.end_state.requiredActions"
- "'VERIFY_EMAIL' in user_required_actions_idempotent_result.end_state.requiredActions"
- name: keycloak_clientsecret_info — read client secret
- name: keycloak_clientsecret_info - read client secret
middleware_automation.keycloak.keycloak_clientsecret_info:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
no_log: true
- name: keycloak_clientsecret_regenerate — rotate client secret
- name: keycloak_clientsecret_regenerate - rotate client secret
middleware_automation.keycloak.keycloak_clientsecret_regenerate:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
no_log: true
- name: keycloak_authz_authorization_scope — create authorization scope
- name: keycloak_clientsecret_info - fetch by client_id and by id
ansible.builtin.include_tasks:
file: keycloak_clientsecret_info/verify.yml
- name: keycloak_clientsecret_regenerate - rotation contract and by-id
ansible.builtin.include_tasks:
file: keycloak_clientsecret_regenerate/verify.yml
- name: keycloak_authz_authorization_scope - full CRUD with check_mode
ansible.builtin.include_tasks:
file: keycloak_authz_authorization_scope/verify.yml
- name: keycloak_authz_permission - scope and resource permissions lifecycle
ansible.builtin.include_tasks:
file: keycloak_authz_permission/verify.yml
- name: keycloak_authz_authorization_scope - create authorization scope
middleware_automation.keycloak.keycloak_authz_authorization_scope:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
@@ -813,7 +942,7 @@
display_name: Molecule module test scope
state: present
- name: keycloak_authz_permission — create scope permission
- name: keycloak_authz_permission - create scope permission
middleware_automation.keycloak.keycloak_authz_permission:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
@@ -823,13 +952,13 @@
- "{{ authz_scope }}"
state: present
- name: keycloak_authz_permission_info — query scope permission
- name: keycloak_authz_permission_info - query scope permission
middleware_automation.keycloak.keycloak_authz_permission_info:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
name: "{{ authz_permission }}"
- name: keycloak_authz_custom_policy — requires deployed policy provider on server
- name: keycloak_authz_custom_policy - requires deployed policy provider on server
middleware_automation.keycloak.keycloak_authz_custom_policy:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
@@ -845,7 +974,7 @@
- "'Method Not Allowed' not in (authz_custom_policy_result.msg | default(''))"
- "'not found' not in (authz_custom_policy_result.msg | default('') | lower)"
- name: keycloak_user_execute_actions_email — trigger execute-actions email
- name: keycloak_user_execute_actions_email - trigger execute-actions email
middleware_automation.keycloak.keycloak_user_execute_actions_email:
realm: "{{ target_realm }}"
username: "{{ user }}"
@@ -857,13 +986,134 @@
- "'Connection refused' in (execute_actions_email_result.msg | default(''))"
- "'Failed to send' in (execute_actions_email_result.msg | default(''))"
- name: keycloak_user_federation — remove non-existent federation (module API test)
- name: keycloak_user_federation - create LDAP federation
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ target_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
editMode: READ_ONLY
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: inetOrgPerson, organizationalPerson
connectionUrl: ldap://ldap.example.com
usersDn: ou=users,dc=example,dc=com
authType: simple
bindDn: cn=admin,dc=example,dc=com
bindCredential: admin_password
searchScope: "1"
pagination: true
importEnabled: true
batchSizeForSync: 1000
fullSyncPeriod: -1
changedSyncPeriod: -1
bind_credential_update_mode: only_indirect
register: federation_create_result
- name: Assert federation was created
ansible.builtin.assert:
that:
- federation_create_result is changed
- name: keycloak_user_federation - create LDAP federation (idempotency)
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ target_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
editMode: READ_ONLY
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: inetOrgPerson, organizationalPerson
connectionUrl: ldap://ldap.example.com
usersDn: ou=users,dc=example,dc=com
authType: simple
bindDn: cn=admin,dc=example,dc=com
bindCredential: admin_password
searchScope: "1"
pagination: true
importEnabled: true
batchSizeForSync: 1000
fullSyncPeriod: -1
changedSyncPeriod: -1
bind_credential_update_mode: only_indirect
register: federation_idempotent_result
- name: Assert federation creation is idempotent
ansible.builtin.assert:
that:
- federation_idempotent_result is not changed
- name: keycloak_user_federation - check mode reports no change when config matches
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ target_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
editMode: READ_ONLY
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: inetOrgPerson, organizationalPerson
connectionUrl: ldap://ldap.example.com
usersDn: ou=users,dc=example,dc=com
authType: simple
bindDn: cn=admin,dc=example,dc=com
bindCredential: admin_password
searchScope: "1"
pagination: true
importEnabled: true
batchSizeForSync: 1000
fullSyncPeriod: -1
changedSyncPeriod: -1
bind_credential_update_mode: only_indirect
check_mode: true
register: federation_check_mode_result
- name: Assert check mode returns no change when config matches
ansible.builtin.assert:
that:
- federation_check_mode_result is not changed
- name: keycloak_user_federation - remove federation
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ target_realm }}"
name: "{{ federation }}"
state: absent
register: federation_remove_result
- name: Assert federation was removed
ansible.builtin.assert:
that:
- federation_remove_result is changed
- name: keycloak_user_federation - remove non-existent federation (module API test)
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ target_realm }}"
name: "{{ federation }}"
state: absent
- name: keycloak_component — remove non-existent component (module API test)
- name: keycloak_component - remove non-existent component (module API test)
middleware_automation.keycloak.keycloak_component:
parent_id: "{{ target_realm }}"
name: "{{ component }}"
@@ -871,6 +1121,10 @@
provider_type: org.keycloak.storage.UserStorageProvider
state: absent
- name: keycloak_modules_authentication - token, refresh, client_credentials auth
ansible.builtin.include_tasks:
file: keycloak_modules_authentication/verify.yml
- name: Remove shared test fixtures
module_defaults:
group/middleware_automation.keycloak.keycloak:
@@ -880,7 +1134,7 @@
auth_password: "{{ auth_password }}"
validate_certs: false
block:
- name: keycloak_authz_custom_policy — remove custom policy if created
- name: keycloak_authz_custom_policy - remove custom policy if created
middleware_automation.keycloak.keycloak_authz_custom_policy:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
@@ -889,7 +1143,7 @@
state: absent
failed_when: false
- name: keycloak_authz_permission — remove scope permission
- name: keycloak_authz_permission - remove scope permission
middleware_automation.keycloak.keycloak_authz_permission:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
@@ -897,14 +1151,14 @@
permission_type: scope
state: absent
- name: keycloak_authz_authorization_scope — remove authorization scope
- name: keycloak_authz_authorization_scope - remove authorization scope
middleware_automation.keycloak.keycloak_authz_authorization_scope:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
name: "{{ authz_scope }}"
state: absent
- name: keycloak_client_scope_rolemappings — remove realm role from client scope
- name: keycloak_client_scope_rolemappings - remove realm role from client scope
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ target_realm }}"
client_scope_id: "{{ scope }}"
@@ -912,7 +1166,7 @@
- "{{ role }}"
state: absent
- name: keycloak_client_scope_rolemappings — remove client role from client scope
- name: keycloak_client_scope_rolemappings - remove client role from client scope
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
@@ -921,7 +1175,7 @@
- "{{ client_role }}"
state: absent
- name: keycloak_client_rolescope — remove role scope mapping
- name: keycloak_client_rolescope - remove role scope mapping
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ target_realm }}"
target_client_id: "{{ client }}"
@@ -929,7 +1183,7 @@
- "{{ role }}"
state: absent
- name: keycloak_client_rolemapping — remove group client role mapping
- name: keycloak_client_rolemapping - remove group client role mapping
middleware_automation.keycloak.keycloak_client_rolemapping:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
@@ -938,7 +1192,7 @@
roles:
- name: "{{ client_role }}"
- name: keycloak_realm_rolemapping — remove group realm role mapping
- name: keycloak_realm_rolemapping - remove group realm role mapping
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ target_realm }}"
group_name: "{{ group }}"
@@ -946,7 +1200,7 @@
roles:
- name: "{{ role }}"
- name: keycloak_user_rolemapping — remove user role mapping
- name: keycloak_user_rolemapping - remove user role mapping
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ target_realm }}"
target_username: "{{ user }}"
@@ -954,7 +1208,7 @@
roles:
- name: "{{ role }}"
- name: keycloak_user_rolemapping — remove restricted admin role mapping from user
- name: keycloak_user_rolemapping - remove restricted admin role mapping from user
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ target_realm }}"
target_username: "{{ user }}"
@@ -962,38 +1216,38 @@
roles:
- name: "{{ role }}-restricted"
- name: keycloak_user — remove restricted admin user from master
- name: keycloak_user - remove restricted admin user from master
middleware_automation.keycloak.keycloak_user:
realm: master
username: molecule-restricted-admin
state: absent
- name: keycloak_role — remove restricted admin test role
- name: keycloak_role - remove restricted admin test role
middleware_automation.keycloak.keycloak_role:
realm: "{{ target_realm }}"
name: "{{ role }}-restricted"
state: absent
- name: keycloak_identity_provider — remove OIDC provider
- name: keycloak_identity_provider - remove OIDC provider
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: "{{ idp }}"
state: absent
- name: keycloak_authentication — remove copied flow
- name: keycloak_authentication - remove copied flow
middleware_automation.keycloak.keycloak_authentication:
realm: "{{ target_realm }}"
alias: "{{ auth_copy }}"
state: absent
- name: keycloak_realm_key — remove generated key
- name: keycloak_realm_key - remove generated key
middleware_automation.keycloak.keycloak_realm_key:
parent_id: "{{ target_realm }}"
name: "{{ realm_key }}"
provider_id: aes-generated
state: absent
- name: keycloak_realm_localization — remove locale override
- name: keycloak_realm_localization - remove locale override
middleware_automation.keycloak.keycloak_realm_localization:
parent_id: "{{ target_realm }}"
locale: en
@@ -1001,57 +1255,57 @@
overrides:
- key: molecule.module.test
- name: keycloak_realm — remove ephemeral realm
- name: keycloak_realm - remove ephemeral realm
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
state: absent
- name: keycloak_clienttemplate — remove client template
- name: keycloak_clienttemplate - remove client template
middleware_automation.keycloak.keycloak_clienttemplate:
realm: "{{ target_realm }}"
name: "{{ template }}"
state: absent
failed_when: false
- name: keycloak_authentication_flow — remove authentication flow
- name: keycloak_authentication_flow - remove authentication flow
middleware_automation.keycloak.keycloak_authentication_flow:
realm: "{{ target_realm }}"
alias: "{{ flow }}"
state: absent
- name: keycloak_user — remove user
- name: keycloak_user - remove user
middleware_automation.keycloak.keycloak_user:
realm: "{{ target_realm }}"
username: "{{ user }}"
state: absent
- name: keycloak_group — remove group
- name: keycloak_group - remove group
middleware_automation.keycloak.keycloak_group:
realm: "{{ target_realm }}"
name: "{{ group }}"
state: absent
- name: keycloak_role — remove client role
- name: keycloak_role - remove client role
middleware_automation.keycloak.keycloak_role:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
name: "{{ client_role }}"
state: absent
- name: keycloak_client — remove confidential client
- name: keycloak_client - remove confidential client
middleware_automation.keycloak.keycloak_client:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
state: absent
- name: keycloak_client_scope — remove client scope
- name: keycloak_client_scope - remove client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ target_realm }}"
name: "{{ scope }}"
state: absent
- name: keycloak_role — remove realm role
- name: keycloak_role - remove realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ target_realm }}"
name: "{{ role }}"
+2 -2
View File
@@ -12,7 +12,7 @@
name: "{{ sudo_pkg_name }}"
state: present
when:
- ansible_user_id == 'root'
- ansible_facts["user_id"] == 'root'
- name: Gather the package facts
ansible.builtin.package_facts:
@@ -30,7 +30,7 @@
- iproute
state: present
when:
- ansible_user_id == 'root'
- ansible_facts["user_id"] == 'root'
- name: "Retrieve assets server from env"
ansible.builtin.set_fact:
+5 -5
View File
@@ -25,7 +25,7 @@
keycloak_quarkus_systemd_wait_for_delay: 2
keycloak_quarkus_systemd_wait_for_log: true
keycloak_quarkus_restart_health_check: false # would fail because of self-signed cert
keycloak_quarkus_version: 26.6.2
keycloak_quarkus_version: 26.8.1
keycloak_quarkus_java_heap_opts: "-Xms1024m -Xmx1024m"
keycloak_quarkus_additional_env_vars:
- key: KC_FEATURES_DISABLED
@@ -39,16 +39,16 @@
- key: default-connection-pool-size
value: 10
- id: spid-saml
url: https://github.com/italia/spid-keycloak-provider/releases/download/26.5.6/spid-provider.jar
url: https://github.com/italia/spid-keycloak-provider/releases/download/26.8.1/spid-provider.jar
- id: spid-saml-w-checksum
url: https://github.com/italia/spid-keycloak-provider/releases/download/26.5.6/spid-provider.jar
checksum: sha256:2ddafc389a5f017d8665bfdfa2f72b3784fc74b9f3a482e796fa89a5ba5cc95b
url: https://github.com/italia/spid-keycloak-provider/releases/download/26.8.1/spid-provider.jar
checksum: sha256:a499161de815156c50208efb6d550a63c64be443e3e494523d737781c5494688
- id: keycloak-kerberos-federation
maven:
repository_url: https://repo1.maven.org/maven2/ # https://mvnrepository.com/artifact/org.keycloak/keycloak-kerberos-federation/24.0.4
group_id: org.keycloak
artifact_id: keycloak-kerberos-federation
version: 26.6.3 # optional
version: 26.8.1 # optional
# username: myUser # optional
# password: myPAT # optional
# - id: my-static-theme
-2
View File
@@ -12,8 +12,6 @@ platforms:
- "8443/tcp"
- "8009/tcp"
- "9000/tcp"
published_ports:
- 0.0.0.0:8443:8443/tcp
provisioner:
name: ansible
config_options:
+31 -13
View File
@@ -17,6 +17,27 @@
- ansible_facts.services["keycloak.service"]["status"] == "enabled"
fail_msg: "Service not running"
- name: Read Keycloak sysconfig
ansible.builtin.slurp:
src: /etc/sysconfig/keycloak
register: keycloak_sysconfig
become: "{{ molecule_prepare_require_privilege_escalation | default(true) }}"
- name: Decode Keycloak sysconfig
ansible.builtin.set_fact:
keycloak_sysconfig_text: "{{ keycloak_sysconfig.content | ansible.builtin.b64decode(encoding='utf-8') }}"
- name: Assert sysconfig defers JAVA_OPTS to Keycloak kc.sh defaults
ansible.builtin.assert:
that:
- keycloak_sysconfig_text is search('JAVA_OPTS_KC_HEAP=')
- keycloak_sysconfig_text is search('JAVA_OPTS_APPEND=')
- keycloak_sysconfig_text is not search('(?m)^JAVA_OPTS=')
fail_msg: >-
Expected JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND (not JAVA_OPTS) in sysconfig.
Got:
{{ keycloak_sysconfig_text }}
- name: Set internal envvar
ansible.builtin.set_fact:
hera_home: "{{ lookup('env', 'HERA_HOME') }}"
@@ -26,23 +47,20 @@
- hera_home is defined
- hera_home | length == 0
block:
- name: Fetch openID config # noqa blocked_modules command-instead-of-module
ansible.builtin.shell: |
set -o pipefail
curl -H 'Host: instance' https://localhost:8443/realms/master/.well-known/openid-configuration -k | jq .
args:
executable: /bin/bash
delegate_to: localhost
- name: Fetch openID config
ansible.builtin.uri:
url: https://localhost:8443/realms/master/.well-known/openid-configuration
headers:
Host: instance
validate_certs: false
register: openid_config
changed_when: False
- name: Verify endpoint URLs
ansible.builtin.assert:
that:
- (openid_config.stdout | from_json)["backchannel_authentication_endpoint"] == 'https://instance:8443/realms/master/protocol/openid-connect/ext/ciba/auth'
- (openid_config.stdout | from_json)['issuer'] == 'https://instance:8443/realms/master'
- (openid_config.stdout | from_json)['authorization_endpoint'] == 'https://instance:8443/realms/master/protocol/openid-connect/auth'
- (openid_config.stdout | from_json)['token_endpoint'] == 'https://instance:8443/realms/master/protocol/openid-connect/token'
delegate_to: localhost
- openid_config.json["backchannel_authentication_endpoint"] == 'https://instance:8443/realms/master/protocol/openid-connect/ext/ciba/auth'
- openid_config.json['issuer'] == 'https://instance:8443/realms/master'
- openid_config.json['authorization_endpoint'] == 'https://instance:8443/realms/master/protocol/openid-connect/auth'
- openid_config.json['token_endpoint'] == 'https://instance:8443/realms/master/protocol/openid-connect/token'
- name: Check log folder
ansible.builtin.stat:
+1
View File
@@ -14,6 +14,7 @@
keycloak_quarkus_proxy_mode: none
keycloak_quarkus_java_home: /opt/openjdk/
keycloak_quarkus_java_heap_opts: "-Xms640m -Xmx640m"
keycloak_realm_client_public: false
roles:
- role: keycloak_quarkus
-3
View File
@@ -11,9 +11,6 @@ platforms:
- "8080/tcp"
- "8009/tcp"
- "9000/tcp"
published_ports:
- 0.0.0.0:8080:8080/tcp
- 0.0.0.0:9000:9000/TCP
provisioner:
name: ansible
config_options:
+36 -13
View File
@@ -19,29 +19,52 @@
executable: /bin/bash
changed_when: False
- name: Verify token api call
ansible.builtin.uri:
url: "http://localhost:8080/realms/master/protocol/openid-connect/token"
method: POST
body: "client_id=admin-cli&username=remembertochangeme&password=remembertochangeme&grant_type=password"
validate_certs: false
register: keycloak_auth_response
until: keycloak_auth_response.status == 200
retries: 2
delay: 2
- name: Get clients in TestRealm
ansible.builtin.uri:
url: "http://localhost:8080/admin/realms/TestRealm/clients"
validate_certs: false
headers:
Authorization: "Bearer {{ keycloak_auth_response.json.access_token }}"
register: keycloak_clients
- name: Get TestClient details
ansible.builtin.set_fact:
test_client: "{{ (keycloak_clients.json | selectattr('clientId', '==', 'TestClient')) | first }}"
- name: Assert TestClient is confidential (not public)
ansible.builtin.assert:
that:
- test_client.publicClient == false
fail_msg: "TestClient should be confidential (publicClient=false) but got publicClient={{ test_client.publicClient }}"
- name: Set internal envvar
ansible.builtin.set_fact:
hera_home: "{{ lookup('env', 'HERA_HOME') }}"
- name: Verify openid config
block:
- name: Fetch openID config # noqa blocked_modules command-instead-of-module
ansible.builtin.shell: |
set -o pipefail
curl http://localhost:8080/realms/master/.well-known/openid-configuration -k | jq .
args:
executable: /bin/bash
delegate_to: localhost
- name: Fetch openID config
ansible.builtin.uri:
url: http://localhost:8080/realms/master/.well-known/openid-configuration
register: openid_config
changed_when: False
- name: Verify endpoint URLs
ansible.builtin.assert:
that:
- (openid_config.stdout | from_json)["backchannel_authentication_endpoint"] == 'http://localhost:8080/realms/master/protocol/openid-connect/ext/ciba/auth'
- (openid_config.stdout | from_json)['issuer'] == 'http://localhost:8080/realms/master'
- (openid_config.stdout | from_json)['authorization_endpoint'] == 'http://localhost:8080/realms/master/protocol/openid-connect/auth'
- (openid_config.stdout | from_json)['token_endpoint'] == 'http://localhost:8080/realms/master/protocol/openid-connect/token'
delegate_to: localhost
- openid_config.json["backchannel_authentication_endpoint"] == 'http://localhost:8080/realms/master/protocol/openid-connect/ext/ciba/auth'
- openid_config.json['issuer'] == 'http://localhost:8080/realms/master'
- openid_config.json['authorization_endpoint'] == 'http://localhost:8080/realms/master/protocol/openid-connect/auth'
- openid_config.json['token_endpoint'] == 'http://localhost:8080/realms/master/protocol/openid-connect/token'
when:
- hera_home is defined
- hera_home | length == 0
+26
View File
@@ -0,0 +1,26 @@
---
- name: Converge
hosts: all
vars_files:
- ../group_vars/all/vars.yml
vars:
keycloak_quarkus_show_deprecation_warnings: false
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
keycloak_quarkus_hostname: "http://localhost:8080"
keycloak_quarkus_log: file
keycloak_quarkus_start_dev: true
keycloak_quarkus_proxy_mode: none
keycloak_quarkus_offline_install: true
keycloak_quarkus_download_path: /tmp/keycloak/
keycloak_quarkus_java_heap_opts: "-Xms640m -Xmx640m"
keycloak_quarkus_metrics_enabled: true
keycloak_quarkus_transaction_xa_enabled: false
keycloak_quarkus_spi_sticky_session_encoder_infinispan_should_attach_route: false
keycloak_quarkus_java_opts_use_keycloak_defaults: false
keycloak_quarkus_validate_certs: false
keycloak_quarkus_health_enabled: false
keycloak_quarkus_restart_health_check: false
keycloak_quarkus_hostname_backchannel_dynamic: true
roles:
- role: keycloak_quarkus
+49
View File
@@ -0,0 +1,49 @@
---
driver:
name: docker
platforms:
- name: instance
image: registry.access.redhat.com/ubi9/ubi-init:latest
pre_build_image: true
privileged: true
command: "/usr/sbin/init"
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "8009/tcp"
- "9000/tcp"
provisioner:
name: ansible
config_options:
defaults:
interpreter_python: auto_silent
ssh_connection:
pipelining: false
playbooks:
prepare: ../default/prepare.yml
inventory:
host_vars:
localhost:
ansible_python_interpreter: "{{ ansible_playbook_python }}"
env:
ANSIBLE_FORCE_COLOR: "true"
PROXY: "${PROXY}"
NO_PROXY: "${NO_PROXY}"
verifier:
name: ansible
scenario:
test_sequence:
- cleanup
- destroy
- create
- prepare
- converge
- idempotence
- side_effect
- verify
- cleanup
- destroy
+1
View File
@@ -0,0 +1 @@
../../roles
+71
View File
@@ -0,0 +1,71 @@
---
- name: Verify
hosts: all
tasks:
- name: Populate service facts
ansible.builtin.service_facts:
- name: Check if keycloak service started
ansible.builtin.assert:
that:
- ansible_facts.services["keycloak.service"]["state"] == "running"
- ansible_facts.services["keycloak.service"]["status"] == "enabled"
- name: Read keycloak.conf
ansible.builtin.shell: cat /opt/keycloak/keycloak-*/conf/keycloak.conf
changed_when: false
register: keycloak_conf
- name: Verify toggled flags in keycloak.conf
ansible.builtin.assert:
that:
- "'metrics-enabled=true' in keycloak_conf_content"
- "'transaction-xa-enabled=false' in keycloak_conf_content"
- "'spi-sticky-session-encoder-infinispan-should-attach-route=false' in keycloak_conf_content"
- "'health-enabled=false' in keycloak_conf_content"
- "'hostname-backchannel-dynamic=true' in keycloak_conf_content"
vars:
keycloak_conf_content: "{{ keycloak_conf.stdout }}"
- name: Read sysconfig
ansible.builtin.slurp:
src: /etc/sysconfig/keycloak
register: keycloak_sysconfig
- name: Verify JAVA_OPTS is used instead of JAVA_OPTS_KC_HEAP
ansible.builtin.assert:
that:
- "'JAVA_OPTS=' in keycloak_sysconfig_content"
- "'JAVA_OPTS_KC_HEAP' not in keycloak_sysconfig_content"
vars:
keycloak_sysconfig_content: "{{ keycloak_sysconfig.content | b64decode }}"
- name: Fetch metrics endpoint
ansible.builtin.uri:
url: "http://localhost:9000/metrics"
method: GET
validate_certs: false
register: metrics_response
until: metrics_response.status == 200
retries: 5
delay: 5
- name: Assert metrics endpoint is reachable
ansible.builtin.assert:
that:
- metrics_response.status == 200
fail_msg: "Metrics endpoint should be enabled but returned {{ metrics_response.status }}"
- name: Fetch health endpoint
ansible.builtin.uri:
url: "http://localhost:9000/health"
method: GET
validate_certs: false
status_code: [200, 404]
register: health_response
- name: Assert health endpoint is disabled
ansible.builtin.assert:
that:
- health_response.status == 404
fail_msg: "Health endpoint should be disabled (404) but returned {{ health_response.status }}"
+1 -5
View File
@@ -32,17 +32,13 @@ platforms:
image: ubuntu/postgres:14-22.04_beta
pre_build_image: true
privileged: true
command: postgres
command: "postgres -c listen_addresses=*"
groups:
- database
networks:
- name: rhbk
exposed_ports:
- "5432/tcp"
mounts:
- type: bind
target: /etc/postgresql/postgresql.conf
source: ${MOLECULE_PROJECT_DIRECTORY}/molecule/quarkus_ha/postgresql/postgresql.conf
env:
POSTGRES_USER: keycloak
POSTGRES_PASSWORD: mysecretpass
@@ -1,750 +0,0 @@
# -----------------------------
# PostgreSQL configuration file
# -----------------------------
#
# This file consists of lines of the form:
#
# name = value
#
# (The "=" is optional.) Whitespace may be used. Comments are introduced with
# "#" anywhere on a line. The complete list of parameter names and allowed
# values can be found in the PostgreSQL documentation.
#
# The commented-out settings shown in this file represent the default values.
# Re-commenting a setting is NOT sufficient to revert it to the default value;
# you need to reload the server.
#
# This file is read on server startup and when the server receives a SIGHUP
# signal. If you edit the file on a running system, you have to SIGHUP the
# server for the changes to take effect, run "pg_ctl reload", or execute
# "SELECT pg_reload_conf()". Some parameters, which are marked below,
# require a server shutdown and restart to take effect.
#
# Any parameter can also be given as a command-line option to the server, e.g.,
# "postgres -c log_connections=on". Some parameters can be changed at run time
# with the "SET" SQL command.
#
# Memory units: kB = kilobytes Time units: ms = milliseconds
# MB = megabytes s = seconds
# GB = gigabytes min = minutes
# TB = terabytes h = hours
# d = days
#------------------------------------------------------------------------------
# FILE LOCATIONS
#------------------------------------------------------------------------------
# The default values of these variables are driven from the -D command-line
# option or PGDATA environment variable, represented here as ConfigDir.
#data_directory = 'ConfigDir' # use data in another directory
# (change requires restart)
#hba_file = 'ConfigDir/pg_hba.conf' # host-based authentication file
# (change requires restart)
#ident_file = 'ConfigDir/pg_ident.conf' # ident configuration file
# (change requires restart)
# If external_pid_file is not explicitly set, no extra PID file is written.
#external_pid_file = '' # write an extra PID file
# (change requires restart)
#------------------------------------------------------------------------------
# CONNECTIONS AND AUTHENTICATION
#------------------------------------------------------------------------------
# - Connection Settings -
listen_addresses = '*' # what IP address(es) to listen on;
# comma-separated list of addresses;
# defaults to 'localhost'; use '*' for all
# (change requires restart)
#port = 5432 # (change requires restart)
#max_connections = 100 # (change requires restart)
#superuser_reserved_connections = 3 # (change requires restart)
#unix_socket_directories = '/tmp' # comma-separated list of directories
# (change requires restart)
#unix_socket_group = '' # (change requires restart)
#unix_socket_permissions = 0777 # begin with 0 to use octal notation
# (change requires restart)
#bonjour = off # advertise server via Bonjour
# (change requires restart)
#bonjour_name = '' # defaults to the computer name
# (change requires restart)
# - TCP settings -
# see "man 7 tcp" for details
#tcp_keepalives_idle = 0 # TCP_KEEPIDLE, in seconds;
# 0 selects the system default
#tcp_keepalives_interval = 0 # TCP_KEEPINTVL, in seconds;
# 0 selects the system default
#tcp_keepalives_count = 0 # TCP_KEEPCNT;
# 0 selects the system default
#tcp_user_timeout = 0 # TCP_USER_TIMEOUT, in milliseconds;
# 0 selects the system default
# - Authentication -
#authentication_timeout = 1min # 1s-600s
#password_encryption = md5 # md5 or scram-sha-256
#db_user_namespace = off
# GSSAPI using Kerberos
#krb_server_keyfile = ''
#krb_caseins_users = off
# - SSL -
#ssl = off
#ssl_ca_file = ''
#ssl_cert_file = 'server.crt'
#ssl_crl_file = ''
#ssl_key_file = 'server.key'
#ssl_ciphers = 'HIGH:MEDIUM:+3DES:!aNULL' # allowed SSL ciphers
#ssl_prefer_server_ciphers = on
#ssl_ecdh_curve = 'prime256v1'
#ssl_min_protocol_version = 'TLSv1'
#ssl_max_protocol_version = ''
#ssl_dh_params_file = ''
#ssl_passphrase_command = ''
#ssl_passphrase_command_supports_reload = off
#------------------------------------------------------------------------------
# RESOURCE USAGE (except WAL)
#------------------------------------------------------------------------------
# - Memory -
#shared_buffers = 32MB # min 128kB
# (change requires restart)
#huge_pages = try # on, off, or try
# (change requires restart)
#temp_buffers = 8MB # min 800kB
#max_prepared_transactions = 0 # zero disables the feature
# (change requires restart)
# Caution: it is not advisable to set max_prepared_transactions nonzero unless
# you actively intend to use prepared transactions.
#work_mem = 4MB # min 64kB
#maintenance_work_mem = 64MB # min 1MB
#autovacuum_work_mem = -1 # min 1MB, or -1 to use maintenance_work_mem
#max_stack_depth = 2MB # min 100kB
#shared_memory_type = mmap # the default is the first option
# supported by the operating system:
# mmap
# sysv
# windows
# (change requires restart)
#dynamic_shared_memory_type = posix # the default is the first option
# supported by the operating system:
# posix
# sysv
# windows
# mmap
# (change requires restart)
# - Disk -
#temp_file_limit = -1 # limits per-process temp file space
# in kB, or -1 for no limit
# - Kernel Resources -
#max_files_per_process = 1000 # min 25
# (change requires restart)
# - Cost-Based Vacuum Delay -
#vacuum_cost_delay = 0 # 0-100 milliseconds (0 disables)
#vacuum_cost_page_hit = 1 # 0-10000 credits
#vacuum_cost_page_miss = 10 # 0-10000 credits
#vacuum_cost_page_dirty = 20 # 0-10000 credits
#vacuum_cost_limit = 200 # 1-10000 credits
# - Background Writer -
#bgwriter_delay = 200ms # 10-10000ms between rounds
#bgwriter_lru_maxpages = 100 # max buffers written/round, 0 disables
#bgwriter_lru_multiplier = 2.0 # 0-10.0 multiplier on buffers scanned/round
#bgwriter_flush_after = 0 # measured in pages, 0 disables
# - Asynchronous Behavior -
#effective_io_concurrency = 1 # 1-1000; 0 disables prefetching
#max_worker_processes = 8 # (change requires restart)
#max_parallel_maintenance_workers = 2 # taken from max_parallel_workers
#max_parallel_workers_per_gather = 2 # taken from max_parallel_workers
#parallel_leader_participation = on
#max_parallel_workers = 8 # maximum number of max_worker_processes that
# can be used in parallel operations
#old_snapshot_threshold = -1 # 1min-60d; -1 disables; 0 is immediate
# (change requires restart)
#backend_flush_after = 0 # measured in pages, 0 disables
#------------------------------------------------------------------------------
# WRITE-AHEAD LOG
#------------------------------------------------------------------------------
# - Settings -
#wal_level = replica # minimal, replica, or logical
# (change requires restart)
#fsync = on # flush data to disk for crash safety
# (turning this off can cause
# unrecoverable data corruption)
#synchronous_commit = on # synchronization level;
# off, local, remote_write, remote_apply, or on
#wal_sync_method = fsync # the default is the first option
# supported by the operating system:
# open_datasync
# fdatasync (default on Linux)
# fsync
# fsync_writethrough
# open_sync
#full_page_writes = on # recover from partial page writes
#wal_compression = off # enable compression of full-page writes
#wal_log_hints = off # also do full page writes of non-critical updates
# (change requires restart)
#wal_init_zero = on # zero-fill new WAL files
#wal_recycle = on # recycle WAL files
#wal_buffers = -1 # min 32kB, -1 sets based on shared_buffers
# (change requires restart)
#wal_writer_delay = 200ms # 1-10000 milliseconds
#wal_writer_flush_after = 1MB # measured in pages, 0 disables
#commit_delay = 0 # range 0-100000, in microseconds
#commit_siblings = 5 # range 1-1000
# - Checkpoints -
#checkpoint_timeout = 5min # range 30s-1d
#max_wal_size = 1GB
#min_wal_size = 80MB
#checkpoint_completion_target = 0.5 # checkpoint target duration, 0.0 - 1.0
#checkpoint_flush_after = 0 # measured in pages, 0 disables
#checkpoint_warning = 30s # 0 disables
# - Archiving -
#archive_mode = off # enables archiving; off, on, or always
# (change requires restart)
#archive_command = '' # command to use to archive a logfile segment
# placeholders: %p = path of file to archive
# %f = file name only
# e.g. 'test ! -f /mnt/server/archivedir/%f && cp %p /mnt/server/archivedir/%f'
#archive_timeout = 0 # force a logfile segment switch after this
# number of seconds; 0 disables
# - Archive Recovery -
# These are only used in recovery mode.
#restore_command = '' # command to use to restore an archived logfile segment
# placeholders: %p = path of file to restore
# %f = file name only
# e.g. 'cp /mnt/server/archivedir/%f %p'
# (change requires restart)
#archive_cleanup_command = '' # command to execute at every restartpoint
#recovery_end_command = '' # command to execute at completion of recovery
# - Recovery Target -
# Set these only when performing a targeted recovery.
#recovery_target = '' # 'immediate' to end recovery as soon as a
# consistent state is reached
# (change requires restart)
#recovery_target_name = '' # the named restore point to which recovery will proceed
# (change requires restart)
#recovery_target_time = '' # the time stamp up to which recovery will proceed
# (change requires restart)
#recovery_target_xid = '' # the transaction ID up to which recovery will proceed
# (change requires restart)
#recovery_target_lsn = '' # the WAL LSN up to which recovery will proceed
# (change requires restart)
#recovery_target_inclusive = on # Specifies whether to stop:
# just after the specified recovery target (on)
# just before the recovery target (off)
# (change requires restart)
#recovery_target_timeline = 'latest' # 'current', 'latest', or timeline ID
# (change requires restart)
#recovery_target_action = 'pause' # 'pause', 'promote', 'shutdown'
# (change requires restart)
#------------------------------------------------------------------------------
# REPLICATION
#------------------------------------------------------------------------------
# - Sending Servers -
# Set these on the master and on any standby that will send replication data.
#max_wal_senders = 10 # max number of walsender processes
# (change requires restart)
#wal_keep_segments = 0 # in logfile segments; 0 disables
#wal_sender_timeout = 60s # in milliseconds; 0 disables
#max_replication_slots = 10 # max number of replication slots
# (change requires restart)
#track_commit_timestamp = off # collect timestamp of transaction commit
# (change requires restart)
# - Master Server -
# These settings are ignored on a standby server.
#synchronous_standby_names = '' # standby servers that provide sync rep
# method to choose sync standbys, number of sync standbys,
# and comma-separated list of application_name
# from standby(s); '*' = all
#vacuum_defer_cleanup_age = 0 # number of xacts by which cleanup is delayed
# - Standby Servers -
# These settings are ignored on a master server.
#primary_conninfo = '' # connection string to sending server
# (change requires restart)
#primary_slot_name = '' # replication slot on sending server
# (change requires restart)
#promote_trigger_file = '' # file name whose presence ends recovery
#hot_standby = on # "off" disallows queries during recovery
# (change requires restart)
#max_standby_archive_delay = 30s # max delay before canceling queries
# when reading WAL from archive;
# -1 allows indefinite delay
#max_standby_streaming_delay = 30s # max delay before canceling queries
# when reading streaming WAL;
# -1 allows indefinite delay
#wal_receiver_status_interval = 10s # send replies at least this often
# 0 disables
#hot_standby_feedback = off # send info from standby to prevent
# query conflicts
#wal_receiver_timeout = 60s # time that receiver waits for
# communication from master
# in milliseconds; 0 disables
#wal_retrieve_retry_interval = 5s # time to wait before retrying to
# retrieve WAL after a failed attempt
#recovery_min_apply_delay = 0 # minimum delay for applying changes during recovery
# - Subscribers -
# These settings are ignored on a publisher.
#max_logical_replication_workers = 4 # taken from max_worker_processes
# (change requires restart)
#max_sync_workers_per_subscription = 2 # taken from max_logical_replication_workers
#------------------------------------------------------------------------------
# QUERY TUNING
#------------------------------------------------------------------------------
# - Planner Method Configuration -
#enable_bitmapscan = on
#enable_hashagg = on
#enable_hashjoin = on
#enable_indexscan = on
#enable_indexonlyscan = on
#enable_material = on
#enable_mergejoin = on
#enable_nestloop = on
#enable_parallel_append = on
#enable_seqscan = on
#enable_sort = on
#enable_tidscan = on
#enable_partitionwise_join = off
#enable_partitionwise_aggregate = off
#enable_parallel_hash = on
#enable_partition_pruning = on
# - Planner Cost Constants -
#seq_page_cost = 1.0 # measured on an arbitrary scale
#random_page_cost = 4.0 # same scale as above
#cpu_tuple_cost = 0.01 # same scale as above
#cpu_index_tuple_cost = 0.005 # same scale as above
#cpu_operator_cost = 0.0025 # same scale as above
#parallel_tuple_cost = 0.1 # same scale as above
#parallel_setup_cost = 1000.0 # same scale as above
#jit_above_cost = 100000 # perform JIT compilation if available
# and query more expensive than this;
# -1 disables
#jit_inline_above_cost = 500000 # inline small functions if query is
# more expensive than this; -1 disables
#jit_optimize_above_cost = 500000 # use expensive JIT optimizations if
# query is more expensive than this;
# -1 disables
#min_parallel_table_scan_size = 8MB
#min_parallel_index_scan_size = 512kB
#effective_cache_size = 4GB
# - Genetic Query Optimizer -
#geqo = on
#geqo_threshold = 12
#geqo_effort = 5 # range 1-10
#geqo_pool_size = 0 # selects default based on effort
#geqo_generations = 0 # selects default based on effort
#geqo_selection_bias = 2.0 # range 1.5-2.0
#geqo_seed = 0.0 # range 0.0-1.0
# - Other Planner Options -
#default_statistics_target = 100 # range 1-10000
#constraint_exclusion = partition # on, off, or partition
#cursor_tuple_fraction = 0.1 # range 0.0-1.0
#from_collapse_limit = 8
#join_collapse_limit = 8 # 1 disables collapsing of explicit
# JOIN clauses
#force_parallel_mode = off
#jit = on # allow JIT compilation
#plan_cache_mode = auto # auto, force_generic_plan or
# force_custom_plan
#------------------------------------------------------------------------------
# REPORTING AND LOGGING
#------------------------------------------------------------------------------
# - Where to Log -
#log_destination = 'stderr' # Valid values are combinations of
# stderr, csvlog, syslog, and eventlog,
# depending on platform. csvlog
# requires logging_collector to be on.
# This is used when logging to stderr:
#logging_collector = off # Enable capturing of stderr and csvlog
# into log files. Required to be on for
# csvlogs.
# (change requires restart)
# These are only used if logging_collector is on:
#log_directory = 'log' # directory where log files are written,
# can be absolute or relative to PGDATA
#log_filename = 'postgresql-%Y-%m-%d_%H%M%S.log' # log file name pattern,
# can include strftime() escapes
#log_file_mode = 0600 # creation mode for log files,
# begin with 0 to use octal notation
#log_truncate_on_rotation = off # If on, an existing log file with the
# same name as the new log file will be
# truncated rather than appended to.
# But such truncation only occurs on
# time-driven rotation, not on restarts
# or size-driven rotation. Default is
# off, meaning append to existing files
# in all cases.
#log_rotation_age = 1d # Automatic rotation of logfiles will
# happen after that time. 0 disables.
#log_rotation_size = 10MB # Automatic rotation of logfiles will
# happen after that much log output.
# 0 disables.
# These are relevant when logging to syslog:
#syslog_facility = 'LOCAL0'
#syslog_ident = 'postgres'
#syslog_sequence_numbers = on
#syslog_split_messages = on
# This is only relevant when logging to eventlog (win32):
# (change requires restart)
#event_source = 'PostgreSQL'
# - When to Log -
#log_min_messages = warning # values in order of decreasing detail:
# debug5
# debug4
# debug3
# debug2
# debug1
# info
# notice
# warning
# error
# log
# fatal
# panic
#log_min_error_statement = error # values in order of decreasing detail:
# debug5
# debug4
# debug3
# debug2
# debug1
# info
# notice
# warning
# error
# log
# fatal
# panic (effectively off)
#log_min_duration_statement = -1 # -1 is disabled, 0 logs all statements
# and their durations, > 0 logs only
# statements running at least this number
# of milliseconds
#log_transaction_sample_rate = 0.0 # Fraction of transactions whose statements
# are logged regardless of their duration. 1.0 logs all
# statements from all transactions, 0.0 never logs.
# - What to Log -
#debug_print_parse = off
#debug_print_rewritten = off
#debug_print_plan = off
#debug_pretty_print = on
#log_checkpoints = off
#log_connections = off
#log_disconnections = off
#log_duration = off
#log_error_verbosity = default # terse, default, or verbose messages
#log_hostname = off
#log_line_prefix = '%m [%p] ' # special values:
# %a = application name
# %u = user name
# %d = database name
# %r = remote host and port
# %h = remote host
# %p = process ID
# %t = timestamp without milliseconds
# %m = timestamp with milliseconds
# %n = timestamp with milliseconds (as a Unix epoch)
# %i = command tag
# %e = SQL state
# %c = session ID
# %l = session line number
# %s = session start timestamp
# %v = virtual transaction ID
# %x = transaction ID (0 if none)
# %q = stop here in non-session
# processes
# %% = '%'
# e.g. '<%u%%%d> '
#log_lock_waits = off # log lock waits >= deadlock_timeout
#log_statement = 'none' # none, ddl, mod, all
#log_replication_commands = off
#log_temp_files = -1 # log temporary files equal or larger
# than the specified size in kilobytes;
# -1 disables, 0 logs all temp files
#log_timezone = 'GMT'
#------------------------------------------------------------------------------
# PROCESS TITLE
#------------------------------------------------------------------------------
#cluster_name = '' # added to process titles if nonempty
# (change requires restart)
#update_process_title = on
#------------------------------------------------------------------------------
# STATISTICS
#------------------------------------------------------------------------------
# - Query and Index Statistics Collector -
#track_activities = on
#track_counts = on
#track_io_timing = off
#track_functions = none # none, pl, all
#track_activity_query_size = 1024 # (change requires restart)
#stats_temp_directory = 'pg_stat_tmp'
# - Monitoring -
#log_parser_stats = off
#log_planner_stats = off
#log_executor_stats = off
#log_statement_stats = off
#------------------------------------------------------------------------------
# AUTOVACUUM
#------------------------------------------------------------------------------
#autovacuum = on # Enable autovacuum subprocess? 'on'
# requires track_counts to also be on.
#log_autovacuum_min_duration = -1 # -1 disables, 0 logs all actions and
# their durations, > 0 logs only
# actions running at least this number
# of milliseconds.
#autovacuum_max_workers = 3 # max number of autovacuum subprocesses
# (change requires restart)
#autovacuum_naptime = 1min # time between autovacuum runs
#autovacuum_vacuum_threshold = 50 # min number of row updates before
# vacuum
#autovacuum_analyze_threshold = 50 # min number of row updates before
# analyze
#autovacuum_vacuum_scale_factor = 0.2 # fraction of table size before vacuum
#autovacuum_analyze_scale_factor = 0.1 # fraction of table size before analyze
#autovacuum_freeze_max_age = 200000000 # maximum XID age before forced vacuum
# (change requires restart)
#autovacuum_multixact_freeze_max_age = 400000000 # maximum multixact age
# before forced vacuum
# (change requires restart)
#autovacuum_vacuum_cost_delay = 2ms # default vacuum cost delay for
# autovacuum, in milliseconds;
# -1 means use vacuum_cost_delay
#autovacuum_vacuum_cost_limit = -1 # default vacuum cost limit for
# autovacuum, -1 means use
# vacuum_cost_limit
#------------------------------------------------------------------------------
# CLIENT CONNECTION DEFAULTS
#------------------------------------------------------------------------------
# - Statement Behavior -
#client_min_messages = notice # values in order of decreasing detail:
# debug5
# debug4
# debug3
# debug2
# debug1
# log
# notice
# warning
# error
#search_path = '"$user", public' # schema names
#row_security = on
#default_tablespace = '' # a tablespace name, '' uses the default
#temp_tablespaces = '' # a list of tablespace names, '' uses
# only default tablespace
#default_table_access_method = 'heap'
#check_function_bodies = on
#default_transaction_isolation = 'read committed'
#default_transaction_read_only = off
#default_transaction_deferrable = off
#session_replication_role = 'origin'
#statement_timeout = 0 # in milliseconds, 0 is disabled
#lock_timeout = 0 # in milliseconds, 0 is disabled
#idle_in_transaction_session_timeout = 0 # in milliseconds, 0 is disabled
#vacuum_freeze_min_age = 50000000
#vacuum_freeze_table_age = 150000000
#vacuum_multixact_freeze_min_age = 5000000
#vacuum_multixact_freeze_table_age = 150000000
#vacuum_cleanup_index_scale_factor = 0.1 # fraction of total number of tuples
# before index cleanup, 0 always performs
# index cleanup
#bytea_output = 'hex' # hex, escape
#xmlbinary = 'base64'
#xmloption = 'content'
#gin_fuzzy_search_limit = 0
#gin_pending_list_limit = 4MB
# - Locale and Formatting -
#datestyle = 'iso, mdy'
#intervalstyle = 'postgres'
#timezone = 'GMT'
#timezone_abbreviations = 'Default' # Select the set of available time zone
# abbreviations. Currently, there are
# Default
# Australia (historical usage)
# India
# You can create your own file in
# share/timezonesets/.
#extra_float_digits = 1 # min -15, max 3; any value >0 actually
# selects precise output mode
#client_encoding = sql_ascii # actually, defaults to database
# encoding
# These settings are initialized by initdb, but they can be changed.
#lc_messages = 'C' # locale for system error message
# strings
#lc_monetary = 'C' # locale for monetary formatting
#lc_numeric = 'C' # locale for number formatting
#lc_time = 'C' # locale for time formatting
# default configuration for text search
#default_text_search_config = 'pg_catalog.simple'
# - Shared Library Preloading -
#shared_preload_libraries = '' # (change requires restart)
#local_preload_libraries = ''
#session_preload_libraries = ''
#jit_provider = 'llvmjit' # JIT library to use
# - Other Defaults -
#dynamic_library_path = '$libdir'
#------------------------------------------------------------------------------
# LOCK MANAGEMENT
#------------------------------------------------------------------------------
#deadlock_timeout = 1s
#max_locks_per_transaction = 64 # min 10
# (change requires restart)
#max_pred_locks_per_transaction = 64 # min 10
# (change requires restart)
#max_pred_locks_per_relation = -2 # negative values mean
# (max_pred_locks_per_transaction
# / -max_pred_locks_per_relation) - 1
#max_pred_locks_per_page = 2 # min 0
#------------------------------------------------------------------------------
# VERSION AND PLATFORM COMPATIBILITY
#------------------------------------------------------------------------------
# - Previous PostgreSQL Versions -
#array_nulls = on
#backslash_quote = safe_encoding # on, off, or safe_encoding
#escape_string_warning = on
#lo_compat_privileges = off
#operator_precedence_warning = off
#quote_all_identifiers = off
#standard_conforming_strings = on
#synchronize_seqscans = on
# - Other Platforms and Clients -
#transform_null_equals = off
#------------------------------------------------------------------------------
# ERROR HANDLING
#------------------------------------------------------------------------------
#exit_on_error = off # terminate session on any error?
#restart_after_crash = on # reinitialize after backend crash?
#data_sync_retry = off # retry or panic on failure to fsync
# data?
# (change requires restart)
#------------------------------------------------------------------------------
# CONFIG FILE INCLUDES
#------------------------------------------------------------------------------
# These options allow settings to be loaded from files other than the
# default postgresql.conf. Note that these are directives, not variable
# assignments, so they can usefully be given more than once.
#include_dir = '...' # include files ending in '.conf' from
# a directory, e.g., 'conf.d'
#include_if_exists = '...' # include file only if it exists
#include = '...' # include file
#------------------------------------------------------------------------------
# CUSTOMIZED OPTIONS
#------------------------------------------------------------------------------
# Add settings for extensions here
+1 -5
View File
@@ -32,17 +32,13 @@ platforms:
image: ubuntu/postgres:14-22.04_beta
pre_build_image: true
privileged: true
command: postgres
command: "postgres -c listen_addresses=*"
groups:
- database
networks:
- name: rhbk
exposed_ports:
- "5432/tcp"
mounts:
- type: bind
target: /etc/postgresql/postgresql.conf
source: ${MOLECULE_PROJECT_DIRECTORY}/molecule/quarkus_ha/postgresql/postgresql.conf
env:
POSTGRES_USER: keycloak
POSTGRES_PASSWORD: mysecretpass
@@ -1,750 +0,0 @@
# -----------------------------
# PostgreSQL configuration file
# -----------------------------
#
# This file consists of lines of the form:
#
# name = value
#
# (The "=" is optional.) Whitespace may be used. Comments are introduced with
# "#" anywhere on a line. The complete list of parameter names and allowed
# values can be found in the PostgreSQL documentation.
#
# The commented-out settings shown in this file represent the default values.
# Re-commenting a setting is NOT sufficient to revert it to the default value;
# you need to reload the server.
#
# This file is read on server startup and when the server receives a SIGHUP
# signal. If you edit the file on a running system, you have to SIGHUP the
# server for the changes to take effect, run "pg_ctl reload", or execute
# "SELECT pg_reload_conf()". Some parameters, which are marked below,
# require a server shutdown and restart to take effect.
#
# Any parameter can also be given as a command-line option to the server, e.g.,
# "postgres -c log_connections=on". Some parameters can be changed at run time
# with the "SET" SQL command.
#
# Memory units: kB = kilobytes Time units: ms = milliseconds
# MB = megabytes s = seconds
# GB = gigabytes min = minutes
# TB = terabytes h = hours
# d = days
#------------------------------------------------------------------------------
# FILE LOCATIONS
#------------------------------------------------------------------------------
# The default values of these variables are driven from the -D command-line
# option or PGDATA environment variable, represented here as ConfigDir.
#data_directory = 'ConfigDir' # use data in another directory
# (change requires restart)
#hba_file = 'ConfigDir/pg_hba.conf' # host-based authentication file
# (change requires restart)
#ident_file = 'ConfigDir/pg_ident.conf' # ident configuration file
# (change requires restart)
# If external_pid_file is not explicitly set, no extra PID file is written.
#external_pid_file = '' # write an extra PID file
# (change requires restart)
#------------------------------------------------------------------------------
# CONNECTIONS AND AUTHENTICATION
#------------------------------------------------------------------------------
# - Connection Settings -
listen_addresses = '*' # what IP address(es) to listen on;
# comma-separated list of addresses;
# defaults to 'localhost'; use '*' for all
# (change requires restart)
#port = 5432 # (change requires restart)
#max_connections = 100 # (change requires restart)
#superuser_reserved_connections = 3 # (change requires restart)
#unix_socket_directories = '/tmp' # comma-separated list of directories
# (change requires restart)
#unix_socket_group = '' # (change requires restart)
#unix_socket_permissions = 0777 # begin with 0 to use octal notation
# (change requires restart)
#bonjour = off # advertise server via Bonjour
# (change requires restart)
#bonjour_name = '' # defaults to the computer name
# (change requires restart)
# - TCP settings -
# see "man 7 tcp" for details
#tcp_keepalives_idle = 0 # TCP_KEEPIDLE, in seconds;
# 0 selects the system default
#tcp_keepalives_interval = 0 # TCP_KEEPINTVL, in seconds;
# 0 selects the system default
#tcp_keepalives_count = 0 # TCP_KEEPCNT;
# 0 selects the system default
#tcp_user_timeout = 0 # TCP_USER_TIMEOUT, in milliseconds;
# 0 selects the system default
# - Authentication -
#authentication_timeout = 1min # 1s-600s
#password_encryption = md5 # md5 or scram-sha-256
#db_user_namespace = off
# GSSAPI using Kerberos
#krb_server_keyfile = ''
#krb_caseins_users = off
# - SSL -
#ssl = off
#ssl_ca_file = ''
#ssl_cert_file = 'server.crt'
#ssl_crl_file = ''
#ssl_key_file = 'server.key'
#ssl_ciphers = 'HIGH:MEDIUM:+3DES:!aNULL' # allowed SSL ciphers
#ssl_prefer_server_ciphers = on
#ssl_ecdh_curve = 'prime256v1'
#ssl_min_protocol_version = 'TLSv1'
#ssl_max_protocol_version = ''
#ssl_dh_params_file = ''
#ssl_passphrase_command = ''
#ssl_passphrase_command_supports_reload = off
#------------------------------------------------------------------------------
# RESOURCE USAGE (except WAL)
#------------------------------------------------------------------------------
# - Memory -
#shared_buffers = 32MB # min 128kB
# (change requires restart)
#huge_pages = try # on, off, or try
# (change requires restart)
#temp_buffers = 8MB # min 800kB
#max_prepared_transactions = 0 # zero disables the feature
# (change requires restart)
# Caution: it is not advisable to set max_prepared_transactions nonzero unless
# you actively intend to use prepared transactions.
#work_mem = 4MB # min 64kB
#maintenance_work_mem = 64MB # min 1MB
#autovacuum_work_mem = -1 # min 1MB, or -1 to use maintenance_work_mem
#max_stack_depth = 2MB # min 100kB
#shared_memory_type = mmap # the default is the first option
# supported by the operating system:
# mmap
# sysv
# windows
# (change requires restart)
#dynamic_shared_memory_type = posix # the default is the first option
# supported by the operating system:
# posix
# sysv
# windows
# mmap
# (change requires restart)
# - Disk -
#temp_file_limit = -1 # limits per-process temp file space
# in kB, or -1 for no limit
# - Kernel Resources -
#max_files_per_process = 1000 # min 25
# (change requires restart)
# - Cost-Based Vacuum Delay -
#vacuum_cost_delay = 0 # 0-100 milliseconds (0 disables)
#vacuum_cost_page_hit = 1 # 0-10000 credits
#vacuum_cost_page_miss = 10 # 0-10000 credits
#vacuum_cost_page_dirty = 20 # 0-10000 credits
#vacuum_cost_limit = 200 # 1-10000 credits
# - Background Writer -
#bgwriter_delay = 200ms # 10-10000ms between rounds
#bgwriter_lru_maxpages = 100 # max buffers written/round, 0 disables
#bgwriter_lru_multiplier = 2.0 # 0-10.0 multiplier on buffers scanned/round
#bgwriter_flush_after = 0 # measured in pages, 0 disables
# - Asynchronous Behavior -
#effective_io_concurrency = 1 # 1-1000; 0 disables prefetching
#max_worker_processes = 8 # (change requires restart)
#max_parallel_maintenance_workers = 2 # taken from max_parallel_workers
#max_parallel_workers_per_gather = 2 # taken from max_parallel_workers
#parallel_leader_participation = on
#max_parallel_workers = 8 # maximum number of max_worker_processes that
# can be used in parallel operations
#old_snapshot_threshold = -1 # 1min-60d; -1 disables; 0 is immediate
# (change requires restart)
#backend_flush_after = 0 # measured in pages, 0 disables
#------------------------------------------------------------------------------
# WRITE-AHEAD LOG
#------------------------------------------------------------------------------
# - Settings -
#wal_level = replica # minimal, replica, or logical
# (change requires restart)
#fsync = on # flush data to disk for crash safety
# (turning this off can cause
# unrecoverable data corruption)
#synchronous_commit = on # synchronization level;
# off, local, remote_write, remote_apply, or on
#wal_sync_method = fsync # the default is the first option
# supported by the operating system:
# open_datasync
# fdatasync (default on Linux)
# fsync
# fsync_writethrough
# open_sync
#full_page_writes = on # recover from partial page writes
#wal_compression = off # enable compression of full-page writes
#wal_log_hints = off # also do full page writes of non-critical updates
# (change requires restart)
#wal_init_zero = on # zero-fill new WAL files
#wal_recycle = on # recycle WAL files
#wal_buffers = -1 # min 32kB, -1 sets based on shared_buffers
# (change requires restart)
#wal_writer_delay = 200ms # 1-10000 milliseconds
#wal_writer_flush_after = 1MB # measured in pages, 0 disables
#commit_delay = 0 # range 0-100000, in microseconds
#commit_siblings = 5 # range 1-1000
# - Checkpoints -
#checkpoint_timeout = 5min # range 30s-1d
#max_wal_size = 1GB
#min_wal_size = 80MB
#checkpoint_completion_target = 0.5 # checkpoint target duration, 0.0 - 1.0
#checkpoint_flush_after = 0 # measured in pages, 0 disables
#checkpoint_warning = 30s # 0 disables
# - Archiving -
#archive_mode = off # enables archiving; off, on, or always
# (change requires restart)
#archive_command = '' # command to use to archive a logfile segment
# placeholders: %p = path of file to archive
# %f = file name only
# e.g. 'test ! -f /mnt/server/archivedir/%f && cp %p /mnt/server/archivedir/%f'
#archive_timeout = 0 # force a logfile segment switch after this
# number of seconds; 0 disables
# - Archive Recovery -
# These are only used in recovery mode.
#restore_command = '' # command to use to restore an archived logfile segment
# placeholders: %p = path of file to restore
# %f = file name only
# e.g. 'cp /mnt/server/archivedir/%f %p'
# (change requires restart)
#archive_cleanup_command = '' # command to execute at every restartpoint
#recovery_end_command = '' # command to execute at completion of recovery
# - Recovery Target -
# Set these only when performing a targeted recovery.
#recovery_target = '' # 'immediate' to end recovery as soon as a
# consistent state is reached
# (change requires restart)
#recovery_target_name = '' # the named restore point to which recovery will proceed
# (change requires restart)
#recovery_target_time = '' # the time stamp up to which recovery will proceed
# (change requires restart)
#recovery_target_xid = '' # the transaction ID up to which recovery will proceed
# (change requires restart)
#recovery_target_lsn = '' # the WAL LSN up to which recovery will proceed
# (change requires restart)
#recovery_target_inclusive = on # Specifies whether to stop:
# just after the specified recovery target (on)
# just before the recovery target (off)
# (change requires restart)
#recovery_target_timeline = 'latest' # 'current', 'latest', or timeline ID
# (change requires restart)
#recovery_target_action = 'pause' # 'pause', 'promote', 'shutdown'
# (change requires restart)
#------------------------------------------------------------------------------
# REPLICATION
#------------------------------------------------------------------------------
# - Sending Servers -
# Set these on the master and on any standby that will send replication data.
#max_wal_senders = 10 # max number of walsender processes
# (change requires restart)
#wal_keep_segments = 0 # in logfile segments; 0 disables
#wal_sender_timeout = 60s # in milliseconds; 0 disables
#max_replication_slots = 10 # max number of replication slots
# (change requires restart)
#track_commit_timestamp = off # collect timestamp of transaction commit
# (change requires restart)
# - Master Server -
# These settings are ignored on a standby server.
#synchronous_standby_names = '' # standby servers that provide sync rep
# method to choose sync standbys, number of sync standbys,
# and comma-separated list of application_name
# from standby(s); '*' = all
#vacuum_defer_cleanup_age = 0 # number of xacts by which cleanup is delayed
# - Standby Servers -
# These settings are ignored on a master server.
#primary_conninfo = '' # connection string to sending server
# (change requires restart)
#primary_slot_name = '' # replication slot on sending server
# (change requires restart)
#promote_trigger_file = '' # file name whose presence ends recovery
#hot_standby = on # "off" disallows queries during recovery
# (change requires restart)
#max_standby_archive_delay = 30s # max delay before canceling queries
# when reading WAL from archive;
# -1 allows indefinite delay
#max_standby_streaming_delay = 30s # max delay before canceling queries
# when reading streaming WAL;
# -1 allows indefinite delay
#wal_receiver_status_interval = 10s # send replies at least this often
# 0 disables
#hot_standby_feedback = off # send info from standby to prevent
# query conflicts
#wal_receiver_timeout = 60s # time that receiver waits for
# communication from master
# in milliseconds; 0 disables
#wal_retrieve_retry_interval = 5s # time to wait before retrying to
# retrieve WAL after a failed attempt
#recovery_min_apply_delay = 0 # minimum delay for applying changes during recovery
# - Subscribers -
# These settings are ignored on a publisher.
#max_logical_replication_workers = 4 # taken from max_worker_processes
# (change requires restart)
#max_sync_workers_per_subscription = 2 # taken from max_logical_replication_workers
#------------------------------------------------------------------------------
# QUERY TUNING
#------------------------------------------------------------------------------
# - Planner Method Configuration -
#enable_bitmapscan = on
#enable_hashagg = on
#enable_hashjoin = on
#enable_indexscan = on
#enable_indexonlyscan = on
#enable_material = on
#enable_mergejoin = on
#enable_nestloop = on
#enable_parallel_append = on
#enable_seqscan = on
#enable_sort = on
#enable_tidscan = on
#enable_partitionwise_join = off
#enable_partitionwise_aggregate = off
#enable_parallel_hash = on
#enable_partition_pruning = on
# - Planner Cost Constants -
#seq_page_cost = 1.0 # measured on an arbitrary scale
#random_page_cost = 4.0 # same scale as above
#cpu_tuple_cost = 0.01 # same scale as above
#cpu_index_tuple_cost = 0.005 # same scale as above
#cpu_operator_cost = 0.0025 # same scale as above
#parallel_tuple_cost = 0.1 # same scale as above
#parallel_setup_cost = 1000.0 # same scale as above
#jit_above_cost = 100000 # perform JIT compilation if available
# and query more expensive than this;
# -1 disables
#jit_inline_above_cost = 500000 # inline small functions if query is
# more expensive than this; -1 disables
#jit_optimize_above_cost = 500000 # use expensive JIT optimizations if
# query is more expensive than this;
# -1 disables
#min_parallel_table_scan_size = 8MB
#min_parallel_index_scan_size = 512kB
#effective_cache_size = 4GB
# - Genetic Query Optimizer -
#geqo = on
#geqo_threshold = 12
#geqo_effort = 5 # range 1-10
#geqo_pool_size = 0 # selects default based on effort
#geqo_generations = 0 # selects default based on effort
#geqo_selection_bias = 2.0 # range 1.5-2.0
#geqo_seed = 0.0 # range 0.0-1.0
# - Other Planner Options -
#default_statistics_target = 100 # range 1-10000
#constraint_exclusion = partition # on, off, or partition
#cursor_tuple_fraction = 0.1 # range 0.0-1.0
#from_collapse_limit = 8
#join_collapse_limit = 8 # 1 disables collapsing of explicit
# JOIN clauses
#force_parallel_mode = off
#jit = on # allow JIT compilation
#plan_cache_mode = auto # auto, force_generic_plan or
# force_custom_plan
#------------------------------------------------------------------------------
# REPORTING AND LOGGING
#------------------------------------------------------------------------------
# - Where to Log -
#log_destination = 'stderr' # Valid values are combinations of
# stderr, csvlog, syslog, and eventlog,
# depending on platform. csvlog
# requires logging_collector to be on.
# This is used when logging to stderr:
#logging_collector = off # Enable capturing of stderr and csvlog
# into log files. Required to be on for
# csvlogs.
# (change requires restart)
# These are only used if logging_collector is on:
#log_directory = 'log' # directory where log files are written,
# can be absolute or relative to PGDATA
#log_filename = 'postgresql-%Y-%m-%d_%H%M%S.log' # log file name pattern,
# can include strftime() escapes
#log_file_mode = 0600 # creation mode for log files,
# begin with 0 to use octal notation
#log_truncate_on_rotation = off # If on, an existing log file with the
# same name as the new log file will be
# truncated rather than appended to.
# But such truncation only occurs on
# time-driven rotation, not on restarts
# or size-driven rotation. Default is
# off, meaning append to existing files
# in all cases.
#log_rotation_age = 1d # Automatic rotation of logfiles will
# happen after that time. 0 disables.
#log_rotation_size = 10MB # Automatic rotation of logfiles will
# happen after that much log output.
# 0 disables.
# These are relevant when logging to syslog:
#syslog_facility = 'LOCAL0'
#syslog_ident = 'postgres'
#syslog_sequence_numbers = on
#syslog_split_messages = on
# This is only relevant when logging to eventlog (win32):
# (change requires restart)
#event_source = 'PostgreSQL'
# - When to Log -
#log_min_messages = warning # values in order of decreasing detail:
# debug5
# debug4
# debug3
# debug2
# debug1
# info
# notice
# warning
# error
# log
# fatal
# panic
#log_min_error_statement = error # values in order of decreasing detail:
# debug5
# debug4
# debug3
# debug2
# debug1
# info
# notice
# warning
# error
# log
# fatal
# panic (effectively off)
#log_min_duration_statement = -1 # -1 is disabled, 0 logs all statements
# and their durations, > 0 logs only
# statements running at least this number
# of milliseconds
#log_transaction_sample_rate = 0.0 # Fraction of transactions whose statements
# are logged regardless of their duration. 1.0 logs all
# statements from all transactions, 0.0 never logs.
# - What to Log -
#debug_print_parse = off
#debug_print_rewritten = off
#debug_print_plan = off
#debug_pretty_print = on
#log_checkpoints = off
#log_connections = off
#log_disconnections = off
#log_duration = off
#log_error_verbosity = default # terse, default, or verbose messages
#log_hostname = off
#log_line_prefix = '%m [%p] ' # special values:
# %a = application name
# %u = user name
# %d = database name
# %r = remote host and port
# %h = remote host
# %p = process ID
# %t = timestamp without milliseconds
# %m = timestamp with milliseconds
# %n = timestamp with milliseconds (as a Unix epoch)
# %i = command tag
# %e = SQL state
# %c = session ID
# %l = session line number
# %s = session start timestamp
# %v = virtual transaction ID
# %x = transaction ID (0 if none)
# %q = stop here in non-session
# processes
# %% = '%'
# e.g. '<%u%%%d> '
#log_lock_waits = off # log lock waits >= deadlock_timeout
#log_statement = 'none' # none, ddl, mod, all
#log_replication_commands = off
#log_temp_files = -1 # log temporary files equal or larger
# than the specified size in kilobytes;
# -1 disables, 0 logs all temp files
#log_timezone = 'GMT'
#------------------------------------------------------------------------------
# PROCESS TITLE
#------------------------------------------------------------------------------
#cluster_name = '' # added to process titles if nonempty
# (change requires restart)
#update_process_title = on
#------------------------------------------------------------------------------
# STATISTICS
#------------------------------------------------------------------------------
# - Query and Index Statistics Collector -
#track_activities = on
#track_counts = on
#track_io_timing = off
#track_functions = none # none, pl, all
#track_activity_query_size = 1024 # (change requires restart)
#stats_temp_directory = 'pg_stat_tmp'
# - Monitoring -
#log_parser_stats = off
#log_planner_stats = off
#log_executor_stats = off
#log_statement_stats = off
#------------------------------------------------------------------------------
# AUTOVACUUM
#------------------------------------------------------------------------------
#autovacuum = on # Enable autovacuum subprocess? 'on'
# requires track_counts to also be on.
#log_autovacuum_min_duration = -1 # -1 disables, 0 logs all actions and
# their durations, > 0 logs only
# actions running at least this number
# of milliseconds.
#autovacuum_max_workers = 3 # max number of autovacuum subprocesses
# (change requires restart)
#autovacuum_naptime = 1min # time between autovacuum runs
#autovacuum_vacuum_threshold = 50 # min number of row updates before
# vacuum
#autovacuum_analyze_threshold = 50 # min number of row updates before
# analyze
#autovacuum_vacuum_scale_factor = 0.2 # fraction of table size before vacuum
#autovacuum_analyze_scale_factor = 0.1 # fraction of table size before analyze
#autovacuum_freeze_max_age = 200000000 # maximum XID age before forced vacuum
# (change requires restart)
#autovacuum_multixact_freeze_max_age = 400000000 # maximum multixact age
# before forced vacuum
# (change requires restart)
#autovacuum_vacuum_cost_delay = 2ms # default vacuum cost delay for
# autovacuum, in milliseconds;
# -1 means use vacuum_cost_delay
#autovacuum_vacuum_cost_limit = -1 # default vacuum cost limit for
# autovacuum, -1 means use
# vacuum_cost_limit
#------------------------------------------------------------------------------
# CLIENT CONNECTION DEFAULTS
#------------------------------------------------------------------------------
# - Statement Behavior -
#client_min_messages = notice # values in order of decreasing detail:
# debug5
# debug4
# debug3
# debug2
# debug1
# log
# notice
# warning
# error
#search_path = '"$user", public' # schema names
#row_security = on
#default_tablespace = '' # a tablespace name, '' uses the default
#temp_tablespaces = '' # a list of tablespace names, '' uses
# only default tablespace
#default_table_access_method = 'heap'
#check_function_bodies = on
#default_transaction_isolation = 'read committed'
#default_transaction_read_only = off
#default_transaction_deferrable = off
#session_replication_role = 'origin'
#statement_timeout = 0 # in milliseconds, 0 is disabled
#lock_timeout = 0 # in milliseconds, 0 is disabled
#idle_in_transaction_session_timeout = 0 # in milliseconds, 0 is disabled
#vacuum_freeze_min_age = 50000000
#vacuum_freeze_table_age = 150000000
#vacuum_multixact_freeze_min_age = 5000000
#vacuum_multixact_freeze_table_age = 150000000
#vacuum_cleanup_index_scale_factor = 0.1 # fraction of total number of tuples
# before index cleanup, 0 always performs
# index cleanup
#bytea_output = 'hex' # hex, escape
#xmlbinary = 'base64'
#xmloption = 'content'
#gin_fuzzy_search_limit = 0
#gin_pending_list_limit = 4MB
# - Locale and Formatting -
#datestyle = 'iso, mdy'
#intervalstyle = 'postgres'
#timezone = 'GMT'
#timezone_abbreviations = 'Default' # Select the set of available time zone
# abbreviations. Currently, there are
# Default
# Australia (historical usage)
# India
# You can create your own file in
# share/timezonesets/.
#extra_float_digits = 1 # min -15, max 3; any value >0 actually
# selects precise output mode
#client_encoding = sql_ascii # actually, defaults to database
# encoding
# These settings are initialized by initdb, but they can be changed.
#lc_messages = 'C' # locale for system error message
# strings
#lc_monetary = 'C' # locale for monetary formatting
#lc_numeric = 'C' # locale for number formatting
#lc_time = 'C' # locale for time formatting
# default configuration for text search
#default_text_search_config = 'pg_catalog.simple'
# - Shared Library Preloading -
#shared_preload_libraries = '' # (change requires restart)
#local_preload_libraries = ''
#session_preload_libraries = ''
#jit_provider = 'llvmjit' # JIT library to use
# - Other Defaults -
#dynamic_library_path = '$libdir'
#------------------------------------------------------------------------------
# LOCK MANAGEMENT
#------------------------------------------------------------------------------
#deadlock_timeout = 1s
#max_locks_per_transaction = 64 # min 10
# (change requires restart)
#max_pred_locks_per_transaction = 64 # min 10
# (change requires restart)
#max_pred_locks_per_relation = -2 # negative values mean
# (max_pred_locks_per_transaction
# / -max_pred_locks_per_relation) - 1
#max_pred_locks_per_page = 2 # min 0
#------------------------------------------------------------------------------
# VERSION AND PLATFORM COMPATIBILITY
#------------------------------------------------------------------------------
# - Previous PostgreSQL Versions -
#array_nulls = on
#backslash_quote = safe_encoding # on, off, or safe_encoding
#escape_string_warning = on
#lo_compat_privileges = off
#operator_precedence_warning = off
#quote_all_identifiers = off
#standard_conforming_strings = on
#synchronize_seqscans = on
# - Other Platforms and Clients -
#transform_null_equals = off
#------------------------------------------------------------------------------
# ERROR HANDLING
#------------------------------------------------------------------------------
#exit_on_error = off # terminate session on any error?
#restart_after_crash = on # reinitialize after backend crash?
#data_sync_retry = off # retry or panic on failure to fsync
# data?
# (change requires restart)
#------------------------------------------------------------------------------
# CONFIG FILE INCLUDES
#------------------------------------------------------------------------------
# These options allow settings to be loaded from files other than the
# default postgresql.conf. Note that these are directives, not variable
# assignments, so they can usefully be given more than once.
#include_dir = '...' # include files ending in '.conf' from
# a directory, e.g., 'conf.d'
#include_if_exists = '...' # include file only if it exists
#include = '...' # include file
#------------------------------------------------------------------------------
# CUSTOMIZED OPTIONS
#------------------------------------------------------------------------------
# Add settings for extensions here
+1 -5
View File
@@ -30,17 +30,13 @@ platforms:
image: ubuntu/postgres:14-22.04_beta
pre_build_image: true
privileged: true
command: postgres
command: "postgres -c listen_addresses=*"
groups:
- database
networks:
- name: rhbk
exposed_ports:
- "5432/tcp"
mounts:
- type: bind
target: /etc/postgresql/postgresql.conf
source: ${MOLECULE_PROJECT_DIRECTORY}/molecule/quarkus_ha_remote/postgresql/postgresql.conf
env:
POSTGRES_USER: keycloak
POSTGRES_PASSWORD: mysecretpass
@@ -1,750 +0,0 @@
# -----------------------------
# PostgreSQL configuration file
# -----------------------------
#
# This file consists of lines of the form:
#
# name = value
#
# (The "=" is optional.) Whitespace may be used. Comments are introduced with
# "#" anywhere on a line. The complete list of parameter names and allowed
# values can be found in the PostgreSQL documentation.
#
# The commented-out settings shown in this file represent the default values.
# Re-commenting a setting is NOT sufficient to revert it to the default value;
# you need to reload the server.
#
# This file is read on server startup and when the server receives a SIGHUP
# signal. If you edit the file on a running system, you have to SIGHUP the
# server for the changes to take effect, run "pg_ctl reload", or execute
# "SELECT pg_reload_conf()". Some parameters, which are marked below,
# require a server shutdown and restart to take effect.
#
# Any parameter can also be given as a command-line option to the server, e.g.,
# "postgres -c log_connections=on". Some parameters can be changed at run time
# with the "SET" SQL command.
#
# Memory units: kB = kilobytes Time units: ms = milliseconds
# MB = megabytes s = seconds
# GB = gigabytes min = minutes
# TB = terabytes h = hours
# d = days
#------------------------------------------------------------------------------
# FILE LOCATIONS
#------------------------------------------------------------------------------
# The default values of these variables are driven from the -D command-line
# option or PGDATA environment variable, represented here as ConfigDir.
#data_directory = 'ConfigDir' # use data in another directory
# (change requires restart)
#hba_file = 'ConfigDir/pg_hba.conf' # host-based authentication file
# (change requires restart)
#ident_file = 'ConfigDir/pg_ident.conf' # ident configuration file
# (change requires restart)
# If external_pid_file is not explicitly set, no extra PID file is written.
#external_pid_file = '' # write an extra PID file
# (change requires restart)
#------------------------------------------------------------------------------
# CONNECTIONS AND AUTHENTICATION
#------------------------------------------------------------------------------
# - Connection Settings -
listen_addresses = '*' # what IP address(es) to listen on;
# comma-separated list of addresses;
# defaults to 'localhost'; use '*' for all
# (change requires restart)
#port = 5432 # (change requires restart)
#max_connections = 100 # (change requires restart)
#superuser_reserved_connections = 3 # (change requires restart)
#unix_socket_directories = '/tmp' # comma-separated list of directories
# (change requires restart)
#unix_socket_group = '' # (change requires restart)
#unix_socket_permissions = 0777 # begin with 0 to use octal notation
# (change requires restart)
#bonjour = off # advertise server via Bonjour
# (change requires restart)
#bonjour_name = '' # defaults to the computer name
# (change requires restart)
# - TCP settings -
# see "man 7 tcp" for details
#tcp_keepalives_idle = 0 # TCP_KEEPIDLE, in seconds;
# 0 selects the system default
#tcp_keepalives_interval = 0 # TCP_KEEPINTVL, in seconds;
# 0 selects the system default
#tcp_keepalives_count = 0 # TCP_KEEPCNT;
# 0 selects the system default
#tcp_user_timeout = 0 # TCP_USER_TIMEOUT, in milliseconds;
# 0 selects the system default
# - Authentication -
#authentication_timeout = 1min # 1s-600s
#password_encryption = md5 # md5 or scram-sha-256
#db_user_namespace = off
# GSSAPI using Kerberos
#krb_server_keyfile = ''
#krb_caseins_users = off
# - SSL -
#ssl = off
#ssl_ca_file = ''
#ssl_cert_file = 'server.crt'
#ssl_crl_file = ''
#ssl_key_file = 'server.key'
#ssl_ciphers = 'HIGH:MEDIUM:+3DES:!aNULL' # allowed SSL ciphers
#ssl_prefer_server_ciphers = on
#ssl_ecdh_curve = 'prime256v1'
#ssl_min_protocol_version = 'TLSv1'
#ssl_max_protocol_version = ''
#ssl_dh_params_file = ''
#ssl_passphrase_command = ''
#ssl_passphrase_command_supports_reload = off
#------------------------------------------------------------------------------
# RESOURCE USAGE (except WAL)
#------------------------------------------------------------------------------
# - Memory -
#shared_buffers = 32MB # min 128kB
# (change requires restart)
#huge_pages = try # on, off, or try
# (change requires restart)
#temp_buffers = 8MB # min 800kB
#max_prepared_transactions = 0 # zero disables the feature
# (change requires restart)
# Caution: it is not advisable to set max_prepared_transactions nonzero unless
# you actively intend to use prepared transactions.
#work_mem = 4MB # min 64kB
#maintenance_work_mem = 64MB # min 1MB
#autovacuum_work_mem = -1 # min 1MB, or -1 to use maintenance_work_mem
#max_stack_depth = 2MB # min 100kB
#shared_memory_type = mmap # the default is the first option
# supported by the operating system:
# mmap
# sysv
# windows
# (change requires restart)
#dynamic_shared_memory_type = posix # the default is the first option
# supported by the operating system:
# posix
# sysv
# windows
# mmap
# (change requires restart)
# - Disk -
#temp_file_limit = -1 # limits per-process temp file space
# in kB, or -1 for no limit
# - Kernel Resources -
#max_files_per_process = 1000 # min 25
# (change requires restart)
# - Cost-Based Vacuum Delay -
#vacuum_cost_delay = 0 # 0-100 milliseconds (0 disables)
#vacuum_cost_page_hit = 1 # 0-10000 credits
#vacuum_cost_page_miss = 10 # 0-10000 credits
#vacuum_cost_page_dirty = 20 # 0-10000 credits
#vacuum_cost_limit = 200 # 1-10000 credits
# - Background Writer -
#bgwriter_delay = 200ms # 10-10000ms between rounds
#bgwriter_lru_maxpages = 100 # max buffers written/round, 0 disables
#bgwriter_lru_multiplier = 2.0 # 0-10.0 multiplier on buffers scanned/round
#bgwriter_flush_after = 0 # measured in pages, 0 disables
# - Asynchronous Behavior -
#effective_io_concurrency = 1 # 1-1000; 0 disables prefetching
#max_worker_processes = 8 # (change requires restart)
#max_parallel_maintenance_workers = 2 # taken from max_parallel_workers
#max_parallel_workers_per_gather = 2 # taken from max_parallel_workers
#parallel_leader_participation = on
#max_parallel_workers = 8 # maximum number of max_worker_processes that
# can be used in parallel operations
#old_snapshot_threshold = -1 # 1min-60d; -1 disables; 0 is immediate
# (change requires restart)
#backend_flush_after = 0 # measured in pages, 0 disables
#------------------------------------------------------------------------------
# WRITE-AHEAD LOG
#------------------------------------------------------------------------------
# - Settings -
#wal_level = replica # minimal, replica, or logical
# (change requires restart)
#fsync = on # flush data to disk for crash safety
# (turning this off can cause
# unrecoverable data corruption)
#synchronous_commit = on # synchronization level;
# off, local, remote_write, remote_apply, or on
#wal_sync_method = fsync # the default is the first option
# supported by the operating system:
# open_datasync
# fdatasync (default on Linux)
# fsync
# fsync_writethrough
# open_sync
#full_page_writes = on # recover from partial page writes
#wal_compression = off # enable compression of full-page writes
#wal_log_hints = off # also do full page writes of non-critical updates
# (change requires restart)
#wal_init_zero = on # zero-fill new WAL files
#wal_recycle = on # recycle WAL files
#wal_buffers = -1 # min 32kB, -1 sets based on shared_buffers
# (change requires restart)
#wal_writer_delay = 200ms # 1-10000 milliseconds
#wal_writer_flush_after = 1MB # measured in pages, 0 disables
#commit_delay = 0 # range 0-100000, in microseconds
#commit_siblings = 5 # range 1-1000
# - Checkpoints -
#checkpoint_timeout = 5min # range 30s-1d
#max_wal_size = 1GB
#min_wal_size = 80MB
#checkpoint_completion_target = 0.5 # checkpoint target duration, 0.0 - 1.0
#checkpoint_flush_after = 0 # measured in pages, 0 disables
#checkpoint_warning = 30s # 0 disables
# - Archiving -
#archive_mode = off # enables archiving; off, on, or always
# (change requires restart)
#archive_command = '' # command to use to archive a logfile segment
# placeholders: %p = path of file to archive
# %f = file name only
# e.g. 'test ! -f /mnt/server/archivedir/%f && cp %p /mnt/server/archivedir/%f'
#archive_timeout = 0 # force a logfile segment switch after this
# number of seconds; 0 disables
# - Archive Recovery -
# These are only used in recovery mode.
#restore_command = '' # command to use to restore an archived logfile segment
# placeholders: %p = path of file to restore
# %f = file name only
# e.g. 'cp /mnt/server/archivedir/%f %p'
# (change requires restart)
#archive_cleanup_command = '' # command to execute at every restartpoint
#recovery_end_command = '' # command to execute at completion of recovery
# - Recovery Target -
# Set these only when performing a targeted recovery.
#recovery_target = '' # 'immediate' to end recovery as soon as a
# consistent state is reached
# (change requires restart)
#recovery_target_name = '' # the named restore point to which recovery will proceed
# (change requires restart)
#recovery_target_time = '' # the time stamp up to which recovery will proceed
# (change requires restart)
#recovery_target_xid = '' # the transaction ID up to which recovery will proceed
# (change requires restart)
#recovery_target_lsn = '' # the WAL LSN up to which recovery will proceed
# (change requires restart)
#recovery_target_inclusive = on # Specifies whether to stop:
# just after the specified recovery target (on)
# just before the recovery target (off)
# (change requires restart)
#recovery_target_timeline = 'latest' # 'current', 'latest', or timeline ID
# (change requires restart)
#recovery_target_action = 'pause' # 'pause', 'promote', 'shutdown'
# (change requires restart)
#------------------------------------------------------------------------------
# REPLICATION
#------------------------------------------------------------------------------
# - Sending Servers -
# Set these on the master and on any standby that will send replication data.
#max_wal_senders = 10 # max number of walsender processes
# (change requires restart)
#wal_keep_segments = 0 # in logfile segments; 0 disables
#wal_sender_timeout = 60s # in milliseconds; 0 disables
#max_replication_slots = 10 # max number of replication slots
# (change requires restart)
#track_commit_timestamp = off # collect timestamp of transaction commit
# (change requires restart)
# - Master Server -
# These settings are ignored on a standby server.
#synchronous_standby_names = '' # standby servers that provide sync rep
# method to choose sync standbys, number of sync standbys,
# and comma-separated list of application_name
# from standby(s); '*' = all
#vacuum_defer_cleanup_age = 0 # number of xacts by which cleanup is delayed
# - Standby Servers -
# These settings are ignored on a master server.
#primary_conninfo = '' # connection string to sending server
# (change requires restart)
#primary_slot_name = '' # replication slot on sending server
# (change requires restart)
#promote_trigger_file = '' # file name whose presence ends recovery
#hot_standby = on # "off" disallows queries during recovery
# (change requires restart)
#max_standby_archive_delay = 30s # max delay before canceling queries
# when reading WAL from archive;
# -1 allows indefinite delay
#max_standby_streaming_delay = 30s # max delay before canceling queries
# when reading streaming WAL;
# -1 allows indefinite delay
#wal_receiver_status_interval = 10s # send replies at least this often
# 0 disables
#hot_standby_feedback = off # send info from standby to prevent
# query conflicts
#wal_receiver_timeout = 60s # time that receiver waits for
# communication from master
# in milliseconds; 0 disables
#wal_retrieve_retry_interval = 5s # time to wait before retrying to
# retrieve WAL after a failed attempt
#recovery_min_apply_delay = 0 # minimum delay for applying changes during recovery
# - Subscribers -
# These settings are ignored on a publisher.
#max_logical_replication_workers = 4 # taken from max_worker_processes
# (change requires restart)
#max_sync_workers_per_subscription = 2 # taken from max_logical_replication_workers
#------------------------------------------------------------------------------
# QUERY TUNING
#------------------------------------------------------------------------------
# - Planner Method Configuration -
#enable_bitmapscan = on
#enable_hashagg = on
#enable_hashjoin = on
#enable_indexscan = on
#enable_indexonlyscan = on
#enable_material = on
#enable_mergejoin = on
#enable_nestloop = on
#enable_parallel_append = on
#enable_seqscan = on
#enable_sort = on
#enable_tidscan = on
#enable_partitionwise_join = off
#enable_partitionwise_aggregate = off
#enable_parallel_hash = on
#enable_partition_pruning = on
# - Planner Cost Constants -
#seq_page_cost = 1.0 # measured on an arbitrary scale
#random_page_cost = 4.0 # same scale as above
#cpu_tuple_cost = 0.01 # same scale as above
#cpu_index_tuple_cost = 0.005 # same scale as above
#cpu_operator_cost = 0.0025 # same scale as above
#parallel_tuple_cost = 0.1 # same scale as above
#parallel_setup_cost = 1000.0 # same scale as above
#jit_above_cost = 100000 # perform JIT compilation if available
# and query more expensive than this;
# -1 disables
#jit_inline_above_cost = 500000 # inline small functions if query is
# more expensive than this; -1 disables
#jit_optimize_above_cost = 500000 # use expensive JIT optimizations if
# query is more expensive than this;
# -1 disables
#min_parallel_table_scan_size = 8MB
#min_parallel_index_scan_size = 512kB
#effective_cache_size = 4GB
# - Genetic Query Optimizer -
#geqo = on
#geqo_threshold = 12
#geqo_effort = 5 # range 1-10
#geqo_pool_size = 0 # selects default based on effort
#geqo_generations = 0 # selects default based on effort
#geqo_selection_bias = 2.0 # range 1.5-2.0
#geqo_seed = 0.0 # range 0.0-1.0
# - Other Planner Options -
#default_statistics_target = 100 # range 1-10000
#constraint_exclusion = partition # on, off, or partition
#cursor_tuple_fraction = 0.1 # range 0.0-1.0
#from_collapse_limit = 8
#join_collapse_limit = 8 # 1 disables collapsing of explicit
# JOIN clauses
#force_parallel_mode = off
#jit = on # allow JIT compilation
#plan_cache_mode = auto # auto, force_generic_plan or
# force_custom_plan
#------------------------------------------------------------------------------
# REPORTING AND LOGGING
#------------------------------------------------------------------------------
# - Where to Log -
#log_destination = 'stderr' # Valid values are combinations of
# stderr, csvlog, syslog, and eventlog,
# depending on platform. csvlog
# requires logging_collector to be on.
# This is used when logging to stderr:
#logging_collector = off # Enable capturing of stderr and csvlog
# into log files. Required to be on for
# csvlogs.
# (change requires restart)
# These are only used if logging_collector is on:
#log_directory = 'log' # directory where log files are written,
# can be absolute or relative to PGDATA
#log_filename = 'postgresql-%Y-%m-%d_%H%M%S.log' # log file name pattern,
# can include strftime() escapes
#log_file_mode = 0600 # creation mode for log files,
# begin with 0 to use octal notation
#log_truncate_on_rotation = off # If on, an existing log file with the
# same name as the new log file will be
# truncated rather than appended to.
# But such truncation only occurs on
# time-driven rotation, not on restarts
# or size-driven rotation. Default is
# off, meaning append to existing files
# in all cases.
#log_rotation_age = 1d # Automatic rotation of logfiles will
# happen after that time. 0 disables.
#log_rotation_size = 10MB # Automatic rotation of logfiles will
# happen after that much log output.
# 0 disables.
# These are relevant when logging to syslog:
#syslog_facility = 'LOCAL0'
#syslog_ident = 'postgres'
#syslog_sequence_numbers = on
#syslog_split_messages = on
# This is only relevant when logging to eventlog (win32):
# (change requires restart)
#event_source = 'PostgreSQL'
# - When to Log -
#log_min_messages = warning # values in order of decreasing detail:
# debug5
# debug4
# debug3
# debug2
# debug1
# info
# notice
# warning
# error
# log
# fatal
# panic
#log_min_error_statement = error # values in order of decreasing detail:
# debug5
# debug4
# debug3
# debug2
# debug1
# info
# notice
# warning
# error
# log
# fatal
# panic (effectively off)
#log_min_duration_statement = -1 # -1 is disabled, 0 logs all statements
# and their durations, > 0 logs only
# statements running at least this number
# of milliseconds
#log_transaction_sample_rate = 0.0 # Fraction of transactions whose statements
# are logged regardless of their duration. 1.0 logs all
# statements from all transactions, 0.0 never logs.
# - What to Log -
#debug_print_parse = off
#debug_print_rewritten = off
#debug_print_plan = off
#debug_pretty_print = on
#log_checkpoints = off
#log_connections = off
#log_disconnections = off
#log_duration = off
#log_error_verbosity = default # terse, default, or verbose messages
#log_hostname = off
#log_line_prefix = '%m [%p] ' # special values:
# %a = application name
# %u = user name
# %d = database name
# %r = remote host and port
# %h = remote host
# %p = process ID
# %t = timestamp without milliseconds
# %m = timestamp with milliseconds
# %n = timestamp with milliseconds (as a Unix epoch)
# %i = command tag
# %e = SQL state
# %c = session ID
# %l = session line number
# %s = session start timestamp
# %v = virtual transaction ID
# %x = transaction ID (0 if none)
# %q = stop here in non-session
# processes
# %% = '%'
# e.g. '<%u%%%d> '
#log_lock_waits = off # log lock waits >= deadlock_timeout
#log_statement = 'none' # none, ddl, mod, all
#log_replication_commands = off
#log_temp_files = -1 # log temporary files equal or larger
# than the specified size in kilobytes;
# -1 disables, 0 logs all temp files
#log_timezone = 'GMT'
#------------------------------------------------------------------------------
# PROCESS TITLE
#------------------------------------------------------------------------------
#cluster_name = '' # added to process titles if nonempty
# (change requires restart)
#update_process_title = on
#------------------------------------------------------------------------------
# STATISTICS
#------------------------------------------------------------------------------
# - Query and Index Statistics Collector -
#track_activities = on
#track_counts = on
#track_io_timing = off
#track_functions = none # none, pl, all
#track_activity_query_size = 1024 # (change requires restart)
#stats_temp_directory = 'pg_stat_tmp'
# - Monitoring -
#log_parser_stats = off
#log_planner_stats = off
#log_executor_stats = off
#log_statement_stats = off
#------------------------------------------------------------------------------
# AUTOVACUUM
#------------------------------------------------------------------------------
#autovacuum = on # Enable autovacuum subprocess? 'on'
# requires track_counts to also be on.
#log_autovacuum_min_duration = -1 # -1 disables, 0 logs all actions and
# their durations, > 0 logs only
# actions running at least this number
# of milliseconds.
#autovacuum_max_workers = 3 # max number of autovacuum subprocesses
# (change requires restart)
#autovacuum_naptime = 1min # time between autovacuum runs
#autovacuum_vacuum_threshold = 50 # min number of row updates before
# vacuum
#autovacuum_analyze_threshold = 50 # min number of row updates before
# analyze
#autovacuum_vacuum_scale_factor = 0.2 # fraction of table size before vacuum
#autovacuum_analyze_scale_factor = 0.1 # fraction of table size before analyze
#autovacuum_freeze_max_age = 200000000 # maximum XID age before forced vacuum
# (change requires restart)
#autovacuum_multixact_freeze_max_age = 400000000 # maximum multixact age
# before forced vacuum
# (change requires restart)
#autovacuum_vacuum_cost_delay = 2ms # default vacuum cost delay for
# autovacuum, in milliseconds;
# -1 means use vacuum_cost_delay
#autovacuum_vacuum_cost_limit = -1 # default vacuum cost limit for
# autovacuum, -1 means use
# vacuum_cost_limit
#------------------------------------------------------------------------------
# CLIENT CONNECTION DEFAULTS
#------------------------------------------------------------------------------
# - Statement Behavior -
#client_min_messages = notice # values in order of decreasing detail:
# debug5
# debug4
# debug3
# debug2
# debug1
# log
# notice
# warning
# error
#search_path = '"$user", public' # schema names
#row_security = on
#default_tablespace = '' # a tablespace name, '' uses the default
#temp_tablespaces = '' # a list of tablespace names, '' uses
# only default tablespace
#default_table_access_method = 'heap'
#check_function_bodies = on
#default_transaction_isolation = 'read committed'
#default_transaction_read_only = off
#default_transaction_deferrable = off
#session_replication_role = 'origin'
#statement_timeout = 0 # in milliseconds, 0 is disabled
#lock_timeout = 0 # in milliseconds, 0 is disabled
#idle_in_transaction_session_timeout = 0 # in milliseconds, 0 is disabled
#vacuum_freeze_min_age = 50000000
#vacuum_freeze_table_age = 150000000
#vacuum_multixact_freeze_min_age = 5000000
#vacuum_multixact_freeze_table_age = 150000000
#vacuum_cleanup_index_scale_factor = 0.1 # fraction of total number of tuples
# before index cleanup, 0 always performs
# index cleanup
#bytea_output = 'hex' # hex, escape
#xmlbinary = 'base64'
#xmloption = 'content'
#gin_fuzzy_search_limit = 0
#gin_pending_list_limit = 4MB
# - Locale and Formatting -
#datestyle = 'iso, mdy'
#intervalstyle = 'postgres'
#timezone = 'GMT'
#timezone_abbreviations = 'Default' # Select the set of available time zone
# abbreviations. Currently, there are
# Default
# Australia (historical usage)
# India
# You can create your own file in
# share/timezonesets/.
#extra_float_digits = 1 # min -15, max 3; any value >0 actually
# selects precise output mode
#client_encoding = sql_ascii # actually, defaults to database
# encoding
# These settings are initialized by initdb, but they can be changed.
#lc_messages = 'C' # locale for system error message
# strings
#lc_monetary = 'C' # locale for monetary formatting
#lc_numeric = 'C' # locale for number formatting
#lc_time = 'C' # locale for time formatting
# default configuration for text search
#default_text_search_config = 'pg_catalog.simple'
# - Shared Library Preloading -
#shared_preload_libraries = '' # (change requires restart)
#local_preload_libraries = ''
#session_preload_libraries = ''
#jit_provider = 'llvmjit' # JIT library to use
# - Other Defaults -
#dynamic_library_path = '$libdir'
#------------------------------------------------------------------------------
# LOCK MANAGEMENT
#------------------------------------------------------------------------------
#deadlock_timeout = 1s
#max_locks_per_transaction = 64 # min 10
# (change requires restart)
#max_pred_locks_per_transaction = 64 # min 10
# (change requires restart)
#max_pred_locks_per_relation = -2 # negative values mean
# (max_pred_locks_per_transaction
# / -max_pred_locks_per_relation) - 1
#max_pred_locks_per_page = 2 # min 0
#------------------------------------------------------------------------------
# VERSION AND PLATFORM COMPATIBILITY
#------------------------------------------------------------------------------
# - Previous PostgreSQL Versions -
#array_nulls = on
#backslash_quote = safe_encoding # on, off, or safe_encoding
#escape_string_warning = on
#lo_compat_privileges = off
#operator_precedence_warning = off
#quote_all_identifiers = off
#standard_conforming_strings = on
#synchronize_seqscans = on
# - Other Platforms and Clients -
#transform_null_equals = off
#------------------------------------------------------------------------------
# ERROR HANDLING
#------------------------------------------------------------------------------
#exit_on_error = off # terminate session on any error?
#restart_after_crash = on # reinitialize after backend crash?
#data_sync_retry = off # retry or panic on failure to fsync
# data?
# (change requires restart)
#------------------------------------------------------------------------------
# CONFIG FILE INCLUDES
#------------------------------------------------------------------------------
# These options allow settings to be loaded from files other than the
# default postgresql.conf. Note that these are directives, not variable
# assignments, so they can usefully be given more than once.
#include_dir = '...' # include files ending in '.conf' from
# a directory, e.g., 'conf.d'
#include_if_exists = '...' # include file only if it exists
#include = '...' # include file
#------------------------------------------------------------------------------
# CUSTOMIZED OPTIONS
#------------------------------------------------------------------------------
# Add settings for extensions here
+18
View File
@@ -0,0 +1,18 @@
---
- name: Converge
hosts: all
vars_files:
- ../group_vars/all/vars.yml
vars:
keycloak_quarkus_show_deprecation_warnings: false
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
keycloak_quarkus_log: file
keycloak_quarkus_start_dev: true
keycloak_quarkus_hostname_strict: false
keycloak_quarkus_proxy_mode: none
keycloak_quarkus_offline_install: true
keycloak_quarkus_download_path: /tmp/keycloak/
keycloak_quarkus_java_heap_opts: "-Xms640m -Xmx640m"
roles:
- role: keycloak_quarkus
+49
View File
@@ -0,0 +1,49 @@
---
driver:
name: docker
platforms:
- name: instance
image: registry.access.redhat.com/ubi9/ubi-init:latest
pre_build_image: true
privileged: true
command: "/usr/sbin/init"
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "8009/tcp"
- "9000/tcp"
provisioner:
name: ansible
config_options:
defaults:
interpreter_python: auto_silent
ssh_connection:
pipelining: false
playbooks:
prepare: ../default/prepare.yml
inventory:
host_vars:
localhost:
ansible_python_interpreter: "{{ ansible_playbook_python }}"
env:
ANSIBLE_FORCE_COLOR: "true"
PROXY: "${PROXY}"
NO_PROXY: "${NO_PROXY}"
verifier:
name: ansible
scenario:
test_sequence:
- cleanup
- destroy
- create
- prepare
- converge
- idempotence
- side_effect
- verify
- cleanup
- destroy
+1
View File
@@ -0,0 +1 @@
../../roles
+22
View File
@@ -0,0 +1,22 @@
---
- name: Verify
hosts: all
tasks:
- name: Populate service facts
ansible.builtin.service_facts:
- name: Check if keycloak service started
ansible.builtin.assert:
that:
- ansible_facts.services["keycloak.service"]["state"] == "running"
- ansible_facts.services["keycloak.service"]["status"] == "enabled"
- name: Verify health check endpoint is reachable on localhost
ansible.builtin.uri:
url: "http://localhost:8080/realms/master/.well-known/openid-configuration"
method: GET
validate_certs: false
register: keycloak_health_response
until: keycloak_health_response.status == 200
retries: 5
delay: 5
+1 -1
View File
@@ -20,7 +20,7 @@
- name: Download keycloak archive to controller directory
ansible.builtin.get_url: # noqa risky-file-permissions delegated, uses controller host user
url: https://github.com/keycloak/keycloak/releases/download/26.6.2/keycloak-26.6.2.zip
url: https://github.com/keycloak/keycloak/releases/download/26.8.1/keycloak-26.8.1.zip
dest: /tmp/keycloak
mode: '0640'
validate_certs: false
+1 -1
View File
@@ -9,6 +9,6 @@
keycloak_quarkus_additional_env_vars:
- key: KC_FEATURES_DISABLED
value: ciba,device-flow,impersonation,kerberos,docker
keycloak_quarkus_version: 26.6.2
keycloak_quarkus_version: 26.8.1
roles:
- role: keycloak_quarkus
-3
View File
@@ -14,9 +14,6 @@ platforms:
exposed_ports:
- "8080/tcp"
- "9000/tcp"
published_ports:
- 0.0.0.0:8080:8080/TCP
- 0.0.0.0:9000:9000/TCP
provisioner:
name: ansible
playbooks:
+2 -2
View File
@@ -6,7 +6,7 @@
- vars.yml
vars:
sudo_pkg_name: sudo
keycloak_quarkus_version: 26.6.1
keycloak_quarkus_version: 26.7.3
keycloak_quarkus_additional_env_vars:
- key: KC_FEATURES_DISABLED
value: impersonation,kerberos
@@ -31,7 +31,7 @@
ansible.builtin.dnf:
name: "{{ sudo_pkg_name }}"
when:
- ansible_user_id == 'root'
- ansible_facts["user_id"] == 'root'
- name: Gather the package facts
ansible.builtin.package_facts:
@@ -3153,19 +3153,9 @@ class KeycloakAPI:
return False
user_groups = self.get_user_group_details(user_id=userrep["id"], realm=realm)
user_group_names = [user_group["name"] for user_group in user_groups if "name" in user_group]
user_group_paths = [user_group["path"] for user_group in user_groups if "path" in user_group]
groups_to_add = [
group_to_add
for group_to_add in groups_to_add
if group_to_add not in user_group_names and group_to_add not in user_group_paths
]
groups_to_remove = [
group_to_remove
for group_to_remove in groups_to_remove
if group_to_remove in user_group_names or group_to_remove in user_group_paths
]
groups_to_add, groups_to_remove = self.filter_groups_to_add_to_and_remove_from_user(
user_groups, groups_to_add, groups_to_remove
)
if not groups_to_add and not groups_to_remove:
return False
@@ -3206,6 +3196,29 @@ class KeycloakAPI:
groups_to_remove.append(group_name)
return groups_to_add, groups_to_remove
def filter_groups_to_add_to_and_remove_from_user(self, user_groups, groups_to_add, groups_to_remove):
"""
Keep only the group membership changes that a user still needs.
:param user_groups: The user's current groups, as returned by get_user_group_details.
:param groups_to_add: Names or paths of the groups the user must be in.
:param groups_to_remove: Names or paths of the groups the user must not be in.
:return: The groups the user is not in yet, and the groups the user is in and must leave.
"""
user_group_names = [user_group["name"] for user_group in user_groups if "name" in user_group]
user_group_paths = [user_group["path"] for user_group in user_groups if "path" in user_group]
groups_to_add = [
group_to_add
for group_to_add in groups_to_add
if group_to_add not in user_group_names and group_to_add not in user_group_paths
]
groups_to_remove = [
group_to_remove
for group_to_remove in groups_to_remove
if group_to_remove in user_group_names or group_to_remove in user_group_paths
]
return groups_to_add, groups_to_remove
def find_group_by_path(self, target, realm: str = "master"):
"""
Finds a realm group by path, e.g. '/my/group'.
+3 -1
View File
@@ -83,6 +83,8 @@ options:
description:
- A list of protocol mappers to associate with the client scope.
- Each mapper is a dict with the keys C(name), C(protocol), C(protocolMapper), and C(config).
aliases:
- protocolMappers
default: []
suboptions:
name:
@@ -204,7 +206,7 @@ def main():
realm=dict(type='str', default='master'),
protocol=dict(type='str', default='openid-connect', choices=['openid-connect', 'saml']),
attributes=dict(type='dict'),
protocol_mappers=dict(type='list', default=[], options=mapper_spec, elements='dict'),
protocol_mappers=dict(type='list', default=[], options=mapper_spec, elements='dict', aliases=['protocolMappers']),
)
argument_spec.update(meta_args)
+11
View File
@@ -53,6 +53,10 @@ options:
description:
- Name of the group.
- This parameter is required only when creating or updating the group.
description:
type: str
description:
- Description of the group.
realm:
type: str
description:
@@ -298,6 +302,11 @@ end_state:
manage: true
manageMembership: true
view: true
description:
description: A description of the group as string.
type: str
returned: when present
sample: An example group description
"""
from ansible.module_utils.basic import AnsibleModule
@@ -324,6 +333,7 @@ def main():
realm=dict(default="master"),
id=dict(type="str"),
name=dict(type="str"),
description=dict(type="str"),
attributes=dict(type="dict"),
parents=dict(
type="list",
@@ -361,6 +371,7 @@ def main():
state = module.params.get("state")
gid = module.params.get("id")
name = module.params.get("name")
description = module.params.get("description")
attributes = module.params.get("attributes")
parents = module.params.get("parents")
@@ -244,6 +244,12 @@ options:
- Way to identify and track external users from the assertion.
type: str
doNotStoreUsers:
description:
- If V(true), users authenticating through this identity provider will not be stored in the Keycloak database.
- This requires the C(transient-users) feature to be enabled on the Keycloak server (available since Keycloak 23).
type: bool
fromUrl:
description:
- IDP well-known OpenID Connect configuration URL.
@@ -372,6 +378,25 @@ EXAMPLES = r"""
attribute.name: roles
syncMode: INHERIT
- name: Create OIDC identity provider with transient users (do not store users in database)
middleware_automation.keycloak.keycloak_identity_provider:
state: present
auth_keycloak_url: https://auth.example.com
auth_realm: master
auth_username: admin
auth_password: admin
realm: myrealm
alias: oidc-idp
display_name: OpenID Connect IdP
enabled: true
provider_id: oidc
config:
fromUrl: https://the-idp.example.com/realms/idprealm/.well-known/openid-configuration
clientAuthMethod: client_secret_post
clientId: my-client
clientSecret: secret
doNotStoreUsers: true
- name: Create OIDC identity provider, authentication with credentials and advanced claim to group
middleware_automation.keycloak.keycloak_identity_provider:
state: present
+17
View File
@@ -249,6 +249,21 @@ def normalise_org(org):
return org
def merge_domains(desired_domains, current_domains):
"""Overlay the requested domain settings on the existing domain representations.
Keys the module does not manage (for example autoRedirect, added in Keycloak 26.8)
are kept as returned by the server, so they neither break the comparison nor get
reset on update.
"""
current_by_name = {d.get("name"): d for d in current_domains or []}
merged = []
for domain in desired_domains:
merged_domain = dict(current_by_name.get(domain["name"], {}))
merged_domain.update(domain)
merged.append(merged_domain)
return sorted(merged, key=lambda d: d.get("name", ""))
def main():
argument_spec = keycloak_argument_spec()
@@ -334,6 +349,8 @@ def main():
)
continue
old_value = before_org.get(camel(param))
if param == "domains":
new_param_value = merge_domains(new_param_value, old_value)
if new_param_value != old_value:
changeset[camel(param)] = new_param_value
+161 -10
View File
@@ -817,6 +817,74 @@ from ansible_collections.middleware_automation.keycloak.plugins.module_utils.ide
)
SCOPE_TYPES = [
("default", "defaultDefaultClientScopes"),
("optional", "defaultOptionalClientScopes"),
]
def _get_realm_client_scopes(kc, realm, scope_type):
if scope_type == "default":
scopes = kc.get_default_client_scopes(realm)
else:
scopes = kc.get_optional_client_scopes(realm)
return scopes or []
def _build_scope_name_to_id(kc, realm):
return {s["name"]: s["id"] for s in kc.get_client_scopes(realm)}
def _validate_desired_scopes(module, realm, desired_scopes, scope_name_to_id):
for scope_type, _key in SCOPE_TYPES:
for name in (desired_scopes.get(scope_type) or []):
if name not in scope_name_to_id:
module.fail_json(msg=f"Client scope '{name}' does not exist in realm {realm}.")
def _sync_realm_client_scopes(kc, realm, desired_scope_names, scope_type, current_scopes, scope_name_to_id):
current_names = {s["name"] for s in current_scopes}
desired_names = set(desired_scope_names)
for name in current_names - desired_names:
scope_id = next(s["id"] for s in current_scopes if s["name"] == name)
if scope_type == "default":
kc.delete_default_client_scope(scope_id, realm)
else:
kc.delete_optional_client_scope(scope_id, realm)
for name in desired_names - current_names:
scope_id = scope_name_to_id[name]
if scope_type == "default":
kc.add_default_client_scope(scope_id, realm)
else:
kc.add_optional_client_scope(scope_id, realm)
def _apply_realm_client_scopes(module, kc, realm, desired_scopes):
scope_name_to_id = _build_scope_name_to_id(kc, realm)
_validate_desired_scopes(module, realm, desired_scopes, scope_name_to_id)
for scope_type, _key in SCOPE_TYPES:
if scope_type in desired_scopes:
current = _get_realm_client_scopes(kc, realm, scope_type)
_sync_realm_client_scopes(kc, realm, desired_scopes[scope_type],
scope_type, current, scope_name_to_id)
def _get_scope_names_dict(kc, realm, desired_scopes):
result = {}
for scope_type, _key in SCOPE_TYPES:
if scope_type in desired_scopes:
result[scope_type] = sorted(s["name"] for s in _get_realm_client_scopes(kc, realm, scope_type))
return result
def _inject_scope_names(target, scope_names):
for scope_type, key in SCOPE_TYPES:
if scope_type in scope_names:
target[key] = scope_names[scope_type]
def normalise_cr(realmrep):
"""Re-sorts any properties where the order is important so that diff's is minimised and the change detection is more effective.
@@ -838,6 +906,54 @@ def normalise_cr(realmrep):
return realmrep
# Keycloak masks the stored SMTP password with this value when returning a realm representation
SECRET_MASK = "**********"
def _stringify_map_value(value):
"""Convert a value to the string form Keycloak uses for string-to-string map entries."""
if isinstance(value, bool):
return "true" if value else "false"
return str(value)
def _check_mode_desired_realm(before_realm, changeset):
"""Predict the realm representation Keycloak would return after applying changeset.
Keycloak stores realm ``attributes``, ``browserSecurityHeaders`` and ``smtpServer`` as
string-to-string maps and merges ``attributes`` and ``browserSecurityHeaders`` into the
existing values, while ``smtpServer`` is replaced as a whole and returned with its
password masked. A plain ``dict.update()`` of the module parameters therefore never
matches the realm Keycloak returns, so check mode always reported a change.
:param before_realm: the realm representation currently stored in Keycloak
:param changeset: the proposed changes built from the module parameters
:return: the predicted realm representation
"""
desired = before_realm.copy()
desired.update(changeset)
for key in ("attributes", "browserSecurityHeaders"):
if isinstance(changeset.get(key), dict):
merged = dict(before_realm.get(key) or {})
for name, value in changeset[key].items():
if value is None:
merged.pop(name, None)
else:
merged[name] = _stringify_map_value(value)
desired[key] = merged
if isinstance(changeset.get("smtpServer"), dict):
smtp = dict((name, _stringify_map_value(value)) for name, value in changeset["smtpServer"].items() if value is not None)
before_password = (before_realm.get("smtpServer") or {}).get("password")
if "password" in smtp and before_password == SECRET_MASK:
# The stored password cannot be read back, so it cannot be compared
smtp["password"] = before_password
desired["smtpServer"] = smtp
return desired
def sanitize_cr(realmrep):
"""Removes probably sensitive details from a realm representation.
@@ -1073,14 +1189,28 @@ def main():
changeset[camel(realm_param)] = new_param_value
# Extract client scope settings - these require separate API calls
desired_scopes = {}
for scope_type, key in SCOPE_TYPES:
value = changeset.pop(key, None)
if value is not None:
desired_scopes[scope_type] = value
has_scope_changes = bool(desired_scopes)
# Prepare the desired values using the existing values (non-existence results in a dict that is save to use as a basis)
desired_realm = before_realm.copy()
desired_realm.update(changeset)
result["proposed"] = sanitize_cr(changeset)
_inject_scope_names(result["proposed"], desired_scopes)
before_realm_sanitized = sanitize_cr(before_realm)
result["existing"] = before_realm_sanitized
# Validate that all desired scope names exist (early, before check_mode or mutations)
if has_scope_changes and before_realm:
scope_name_to_id = _build_scope_name_to_id(kc, realm)
_validate_desired_scopes(module, realm, desired_scopes, scope_name_to_id)
# Cater for when it doesn't exist (an empty dict)
if not before_realm:
if state == "absent":
@@ -1103,23 +1233,36 @@ def main():
# create it
kc.create_realm(desired_realm)
after_realm = kc.get_realm_by_id(desired_realm["realm"])
result["end_state"] = sanitize_cr(after_realm)
created_realm_name = desired_realm.get("realm") or desired_realm.get("id")
if has_scope_changes:
_apply_realm_client_scopes(module, kc, created_realm_name, desired_scopes)
result["msg"] = f"Realm {desired_realm['realm']} has been created."
after_realm = kc.get_realm_by_id(created_realm_name)
after_realm_sanitized = sanitize_cr(after_realm)
_inject_scope_names(after_realm_sanitized, _get_scope_names_dict(kc, created_realm_name, desired_scopes))
result["end_state"] = after_realm_sanitized
result["msg"] = f"Realm {created_realm_name} has been created."
module.exit_json(**result)
else:
if state == "present":
# Process an update
# Fetch current client scopes before update for comparison
before_scope_names = _get_scope_names_dict(kc, realm, desired_scopes)
_inject_scope_names(before_realm_sanitized, before_scope_names)
# doing an update
result["existing"] = before_realm_sanitized
# Process an update
result["changed"] = True
if module.check_mode:
# We can only compare the current realm with the proposed updates we have
before_norm = normalise_cr(before_realm)
desired_norm = normalise_cr(desired_realm)
desired_norm = normalise_cr(_check_mode_desired_realm(before_realm, changeset))
_inject_scope_names(before_norm, before_scope_names)
_inject_scope_names(desired_norm, {st: sorted(v) for st, v in desired_scopes.items()})
if module._diff:
result["diff"] = dict(before=sanitize_cr(before_norm), after=sanitize_cr(desired_norm))
result["changed"] = before_norm != desired_norm
@@ -1129,15 +1272,23 @@ def main():
# do the update
kc.update_realm(desired_realm, realm=realm)
after_realm = kc.get_realm_by_id(realm=realm)
if has_scope_changes:
_apply_realm_client_scopes(module, kc, realm, desired_scopes)
if before_realm == after_realm:
after_realm = kc.get_realm_by_id(realm=realm)
after_realm_sanitized = sanitize_cr(after_realm)
after_scope_names = _get_scope_names_dict(kc, realm, desired_scopes)
_inject_scope_names(after_realm_sanitized, after_scope_names)
scopes_changed = before_scope_names != after_scope_names
if before_realm == after_realm and not scopes_changed:
result["changed"] = False
result["end_state"] = sanitize_cr(after_realm)
result["end_state"] = after_realm_sanitized
if module._diff:
result["diff"] = dict(before=before_realm_sanitized, after=sanitize_cr(after_realm))
result["diff"] = dict(before=before_realm_sanitized, after=after_realm_sanitized)
result["msg"] = f"Realm {desired_realm['realm']} has been updated."
module.exit_json(**result)
+1 -1
View File
@@ -620,7 +620,7 @@ def get_keycloak_config_key(param_name, provider_id=None):
"""
# Handle elliptic_curve specially - each provider uses a different config key
if param_name == "elliptic_curve" and provider_id in ELLIPTIC_CURVE_CONFIG_KEYS:
return ELLIPTIC_CURVE_CONFIG_KEYS[param_name]
return ELLIPTIC_CURVE_CONFIG_KEYS[provider_id]
if param_name in CONFIG_PARAM_MAPPING:
return CONFIG_PARAM_MAPPING[param_name]
return camel(param_name)
+11 -10
View File
@@ -490,10 +490,10 @@ def main():
desired_user.update(changeset)
if before_user:
before_groups = kc.get_user_groups(user_id=before_user["id"], realm=realm)
before_user["groups"] = before_groups
before_group_details = kc.get_user_group_details(user_id=before_user["id"], realm=realm)
before_user["groups"] = [group["name"] for group in before_group_details if "name" in group]
else:
before_groups = []
before_group_details = []
result["proposed"] = changeset
result["existing"] = before_user
@@ -579,16 +579,17 @@ def main():
if not module.check_mode:
changed |= kc.update_user_groups_membership(userrep=desired_user, groups=groups, realm=realm)
present_groups = [g["name"] for g in groups if g["state"] == "present"]
absent_groups = [g["name"] for g in groups if g["state"] == "absent"]
desired_user["groups"] = (set(before_groups) | set(present_groups)) - set(absent_groups)
if module.check_mode:
# check if group meberships would have changed
changed |= not is_struct_included(
desired_user["groups"], before_groups, user_compare_excludes, empty_list_result=False
groups_to_add, groups_to_remove = kc.filter_groups_to_add_to_and_remove_from_user(
before_group_details, *kc.extract_groups_to_add_to_and_remove_from_user(groups)
)
desired_user["groups"] = [
group["name"]
for group in before_group_details
if "name" in group and group["name"] not in groups_to_remove and group.get("path") not in groups_to_remove
] + groups_to_add
changed |= bool(groups_to_add or groups_to_remove)
else:
after_user["groups"] = kc.get_user_groups(user_id=desired_user["id"], realm=realm)
@@ -989,7 +989,10 @@ def main():
else:
old_mapper = {}
new_mapper = old_mapper.copy()
old_mapper_config = old_mapper.get("config", {})
new_mapper.update(change)
if "config" in change and old_mapper_config:
new_mapper["config"] = {**old_mapper_config, **change["config"]}
# changeset contains all desired mappers: those existing, to update or to create
if changeset.get("mappers") is None:
changeset["mappers"] = list()
@@ -1009,6 +1012,12 @@ def main():
desired_comp = before_comp.copy()
desired_comp.update(changeset)
# Merge config: preserve KC-internal config keys not managed by this module
if "config" in changeset and "config" in before_comp:
merged_config = deepcopy(before_comp["config"])
merged_config.update(changeset["config"])
desired_comp["config"] = merged_config
result["proposed"] = sanitize(changeset)
result["existing"] = sanitize(before_comp)
@@ -1052,7 +1061,10 @@ def main():
old_mapper = {}
new_mapper = old_mapper.copy()
old_default_config = old_mapper.get("config", {})
new_mapper.update(desired_mapper)
if "config" in desired_mapper and old_default_config:
new_mapper["config"] = {**old_default_config, **desired_mapper["config"]}
if new_mapper.get("id") is not None:
kc.update_component(new_mapper, realm)
+12 -1
View File
@@ -257,6 +257,13 @@ options:
default:
- user
scopes:
description:
- The client scopes for which this attribute is required.
- If not set, the attribute is required regardless of the requested scopes.
type: list
elements: str
selector:
description:
- Selector when the attribute should be added.
@@ -583,7 +590,11 @@ def main():
),
"multivalued": dict(type="bool", default=False),
"required": dict(
type="dict", options={"roles": dict(type="list", elements="str", default=["user"])}
type="dict",
options={
"roles": dict(type="list", elements="str", default=["user"]),
"scopes": dict(type="list", elements="str"),
},
),
"selector": dict(type="dict", options={"scopes": dict(type="list", elements="str")}),
},
+8 -6
View File
@@ -33,7 +33,7 @@ Role Defaults
| Variable | Description | Default |
|:---------|:------------|:--------|
|`keycloak_quarkus_version`| keycloak.org package version | `26.6.2` |
|`keycloak_quarkus_version`| keycloak.org package version | `26.8.1` |
|`keycloak_quarkus_offline_install` | Perform an offline install | `False`|
|`keycloak_quarkus_dest`| Installation root path | `/opt/keycloak` |
|`keycloak_quarkus_download_url` | Download URL for keycloak | `https://github.com/keycloak/keycloak/releases/download/{{ keycloak_quarkus_version }}/{{ keycloak_quarkus_archive }}` |
@@ -57,14 +57,16 @@ Role Defaults
|`keycloak_quarkus_service_restartsec`| systemd RestartSec | `10s` |
|`keycloak_quarkus_jvm_package`| RHEL java package runtime | `java-21-openjdk-headless` |
|`keycloak_quarkus_java_home`| JAVA_HOME of installed JRE, leave empty for using specified keycloak_quarkus_jvm_package RPM path | `None` |
|`keycloak_quarkus_java_heap_opts`| Heap memory JVM setting | `-Xms1024m -Xmx2048m` |
|`keycloak_quarkus_java_jvm_opts`| Other JVM settings | same as keycloak |
|`keycloak_quarkus_java_opts`| JVM arguments; if overridden, it takes precedence over `keycloak_quarkus_java_*` | `{{ keycloak_quarkus_java_heap_opts + ' ' + keycloak_quarkus_java_jvm_opts }}` |
|`keycloak_quarkus_java_heap_opts`| Heap memory JVM setting (`JAVA_OPTS_KC_HEAP` when using Keycloak defaults) | `-Xms1024m -Xmx2048m` |
|`keycloak_quarkus_java_jvm_opts`| Optional extra JVM flags (`JAVA_OPTS_APPEND` with Keycloak defaults) | `""` |
|`keycloak_quarkus_java_opts_use_keycloak_defaults`| Let `kc.sh` apply upstream `JAVA_OPTS` (recommended) | `true` |
|`keycloak_quarkus_java_append_opts`| JGroups and extra JVM flags appended after Keycloak defaults | JGroups bind/external settings |
|`keycloak_quarkus_java_opts`| Full `JAVA_OPTS` when `keycloak_quarkus_java_opts_use_keycloak_defaults` is `false` | combined heap, JGroups, and `java_jvm_opts` |
|`keycloak_quarkus_additional_env_vars` | List of additional env variables of { key: str, value: str} to be put in sysconfig file, see https://www.keycloak.org/server/all-config | `[]` |
|`keycloak_quarkus_frontend_url`| Deprecated, use `keycloak_quarkus_hostname` instead. | |
|`keycloak_quarkus_admin_url`| Deprecated, use `keycloak_quarkus_hostname_admin` instead. | |
|`keycloak_quarkus_health_check_url`| Full URL (including scheme, host, path, fragment etc.) used for health check endpoint; keycloak_quarkus_hostname will NOT be prepended; helpful when health checks should happen against http port, but keycloak_quarkus_hostname uses https scheme per default | `{{ keycloak_quarkus_hostname ~ keycloak_quarkus_http_relative_path.rstrip('/') ~ '/' ~ keycloak_quarkus_health_check_url_path }}` |
|`keycloak_quarkus_health_check_url_path`| Path to the health check endpoint; keycloak_quarkus_hostname will be prepended automatically; Note that keycloak_quarkus_health_check_url takes precedence over this property | `realms/{{ keycloak_quarkus_master_realm }}/.well-known/openid-configuration` |
|`keycloak_quarkus_health_check_url`| Full URL for the health check endpoint, targets localhost | Composed from `keycloak_quarkus_http_enabled`, `keycloak_quarkus_http_port`/`keycloak_quarkus_https_port`, and `keycloak_quarkus_http_relative_path` |
|`keycloak_quarkus_health_check_url_path`| Path appended to the health check URL; ignored if keycloak_quarkus_health_check_url is set directly | `realms/{{ keycloak_quarkus_master_realm }}/.well-known/openid-configuration` |
|`keycloak_quarkus_proxy_headers`| Parse reverse proxy headers (`forwarded` or `xforwarded`) | `""` |
|`keycloak_quarkus_config_key_store_file`| Path to the configuration key store; only used if `keycloak_quarkus_config_key_store_password` is not empty | `{{ keycloak.home }}/conf/conf_store.p12` if `keycloak_quarkus_config_key_store_password != ''`, else `''` |
|`keycloak_quarkus_config_key_store_password`| Password of the configuration keystore; if non-empty, `keycloak_quarkus_db_pass` will be saved to the keystore at `keycloak_quarkus_config_key_store_file` instead of being written to the configuration file in clear text | `""` |
+13 -8
View File
@@ -1,6 +1,6 @@
---
### Configuration specific to keycloak
keycloak_quarkus_version: 26.6.2
keycloak_quarkus_version: 26.8.1
keycloak_quarkus_archive: "keycloak-{{ keycloak_quarkus_version }}.zip"
keycloak_quarkus_download_url: "https://github.com/keycloak/keycloak/releases/download/{{ keycloak_quarkus_version }}/{{ keycloak_quarkus_archive }}"
keycloak_quarkus_installdir: "{{ keycloak_quarkus_dest }}/keycloak-{{ keycloak_quarkus_version }}"
@@ -47,15 +47,17 @@ keycloak_quarkus_jgroups_bind_address: "{{ ansible_facts['default_ipv4']['addres
keycloak_quarkus_jgroups_external_addr: "{{ keycloak_quarkus_jgroups_bind_address }}"
keycloak_quarkus_jgroups_external_port: "{{ keycloak_quarkus_jgroups_port }}"
keycloak_quarkus_java_heap_opts: "-Xms1024m -Xmx2048m"
keycloak_quarkus_java_jvm_opts: >
-XX:MetaspaceSize=96M -XX:MaxMetaspaceSize=256m -Dfile.encoding=UTF-8 -Dsun.stdout.encoding=UTF-8
-Dsun.err.encoding=UTF-8 -Dstdout.encoding=UTF-8 -Dstderr.encoding=UTF-8 -XX:+ExitOnOutOfMemoryError
-Djava.security.egd=file:/dev/urandom -XX:+UseParallelGC -XX:GCTimeRatio=4
-XX:AdaptiveSizePolicyWeight=90 -XX:FlightRecorderOptions=stackdepth=512
# Optional extra JVM flags appended after Keycloak's kc.sh defaults (see JAVA_OPTS_APPEND).
keycloak_quarkus_java_jvm_opts: ""
keycloak_quarkus_jgroups_opts: >
-Djgroups.bind.address={{ keycloak_quarkus_jgroups_bind_address }}
-Djgroups.external_port={{ keycloak_quarkus_jgroups_external_port }}
-Djgroups.external_addr={{ keycloak_quarkus_jgroups_external_addr }}
# When true, sysconfig sets JAVA_OPTS_KC_HEAP / JAVA_OPTS_APPEND so kc.sh applies upstream JAVA_OPTS
# (including security-related defaults). Set false to set JAVA_OPTS explicitly via keycloak_quarkus_java_opts.
keycloak_quarkus_java_opts_use_keycloak_defaults: true
keycloak_quarkus_java_append_opts: >-
{{ (keycloak_quarkus_jgroups_opts ~ ' ' ~ keycloak_quarkus_java_jvm_opts) | regex_replace('\s+', ' ') | trim }}
keycloak_quarkus_java_opts: "{{ ' '.join((keycloak_quarkus_jgroups_opts, keycloak_quarkus_java_heap_opts, keycloak_quarkus_java_jvm_opts)) }}"
keycloak_quarkus_additional_env_vars: []
@@ -91,7 +93,7 @@ keycloak_quarkus_systemd_wait_for_timeout: 60
keycloak_quarkus_systemd_wait_for_delay: 10
### keycloak frontend url
keycloak_quarkus_hostname:
keycloak_quarkus_hostname: ""
keycloak_quarkus_hostname_admin: ""
### Set the path relative to / for serving resources. The path must start with a /
@@ -188,7 +190,10 @@ keycloak_quarkus_restart_health_check_delay: 10
keycloak_quarkus_restart_health_check_retries: 25
keycloak_quarkus_validate_certs: true
keycloak_quarkus_health_check_url_path: "realms/{{ keycloak_quarkus_master_realm }}/.well-known/openid-configuration"
keycloak_quarkus_health_check_url: "{{ keycloak_quarkus_hostname.rstrip('/').removesuffix(keycloak_quarkus_http_relative_path.rstrip('/')) ~ keycloak_quarkus_http_relative_path.rstrip('/') ~ '/' ~ keycloak_quarkus_health_check_url_path }}"
keycloak_quarkus_health_check_url: >-
{{ 'http' if keycloak_quarkus_http_enabled else 'https' }}://localhost:{{
keycloak_quarkus_http_port if keycloak_quarkus_http_enabled else keycloak_quarkus_https_port }}{{
keycloak_quarkus_http_relative_path.rstrip('/') }}/{{ keycloak_quarkus_health_check_url_path }}
keycloak_quarkus_restart_pause: 15
keycloak_quarkus_force_install: false
+29 -11
View File
@@ -2,7 +2,7 @@ argument_specs:
main:
options:
keycloak_quarkus_version:
default: "26.6.2"
default: "26.8.1"
description: "keycloak.org package version"
type: "str"
keycloak_quarkus_archive:
@@ -89,6 +89,7 @@ argument_specs:
description: "Deprecated, use `keycloak_quarkus_http_host`"
type: "str"
keycloak_quarkus_hostname:
default: ""
description: >-
Address at which is the server exposed.
Can be a full URL, or just a hostname. When only hostname is provided, scheme, port and context path are resolved from the request.
@@ -115,12 +116,17 @@ argument_specs:
description: "HTTP port"
type: "int"
keycloak_quarkus_health_check_url:
default: "{{ keycloak_quarkus_hostname.rstrip('/').removesuffix(keycloak_quarkus_http_relative_path.rstrip('/')) ~ keycloak_quarkus_http_relative_path.rstrip('/') ~ '/' ~ keycloak_quarkus_health_check_url_path }}"
description: "Full URL (including scheme, host, path, fragment etc.) used for health check endpoint; keycloak_quarkus_hostname will NOT be prepended; helpful when health checks should happen against http port, but keycloak_quarkus_hostname uses https scheme per default"
default: >-
{{ 'http' if keycloak_quarkus_http_enabled else 'https' }}://localhost:{{
keycloak_quarkus_http_port if keycloak_quarkus_http_enabled else keycloak_quarkus_https_port }}{{
keycloak_quarkus_http_relative_path.rstrip('/') }}/{{ keycloak_quarkus_health_check_url_path }}
description: >-
Full URL for the health check endpoint, targets localhost since
the check runs on the managed host itself
type: "str"
keycloak_quarkus_health_check_url_path:
default: "realms/{{ keycloak_quarkus_master_realm }}/.well-known/openid-configuration"
description: "Path to the health check endpoint; keycloak_quarkus_hostname will be prepended automatically; Note that keycloak_quarkus_health_check_url takes precedence over this property"
description: "Path appended to the health check URL; ignored if keycloak_quarkus_health_check_url is set directly"
type: "str"
keycloak_quarkus_https_key_file_enabled:
default: false
@@ -225,15 +231,27 @@ argument_specs:
description: "Heap memory JVM setting"
type: "str"
keycloak_quarkus_java_jvm_opts:
default: >
-XX:MetaspaceSize=96M -XX:MaxMetaspaceSize=256m -Dfile.encoding=UTF-8 -Dsun.stdout.encoding=UTF-8 -Dsun.err.encoding=UTF-8
-Dstdout.encoding=UTF-8 -Dstderr.encoding=UTF-8 -XX:+ExitOnOutOfMemoryError -Djava.security.egd=file:/dev/urandom -XX:+UseParallelGC
-XX:GCTimeRatio=4 -XX:AdaptiveSizePolicyWeight=90 -XX:FlightRecorderOptions=stackdepth=512
description: "Other JVM settings"
default: ""
description: >-
Optional JVM flags appended via JAVA_OPTS_APPEND when
keycloak_quarkus_java_opts_use_keycloak_defaults is true
type: "str"
keycloak_quarkus_java_opts_use_keycloak_defaults:
default: true
description: >-
When true, sysconfig sets JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND so
Keycloak kc.sh applies upstream JAVA_OPTS defaults. When false, sets
JAVA_OPTS from keycloak_quarkus_java_opts instead.
type: "bool"
keycloak_quarkus_java_append_opts:
default: >-
{{ (keycloak_quarkus_jgroups_opts ~ ' ' ~ keycloak_quarkus_java_jvm_opts) | regex_replace('\s+', ' ') | trim }}
description: "JVM flags appended after Keycloak defaults (JGroups and java_jvm_opts)"
type: "str"
keycloak_quarkus_java_opts:
default: "{{ ' '.join((keycloak_quarkus_jgroups_opts, keycloak_quarkus_java_heap_opts, keycloak_quarkus_java_jvm_opts)) }}"
description: "JVM arguments, by default heap_opts + jvm_opts, if overriden it takes precedence over them"
description: >-
Full JAVA_OPTS string used when keycloak_quarkus_java_opts_use_keycloak_defaults is false
type: "str"
keycloak_quarkus_additional_env_vars:
default: "[]"
@@ -524,7 +542,7 @@ argument_specs:
downstream:
options:
rhbk_version:
default: "26.4.11"
default: "26.6.7"
description: "Red Hat Build of Keycloak version"
type: "str"
rhbk_archive:
@@ -0,0 +1,8 @@
{% if keycloak_quarkus_java_opts_use_keycloak_defaults | default(true) | bool %}
JAVA_OPTS_KC_HEAP="{{ keycloak_quarkus_java_heap_opts }}"
{% if keycloak_quarkus_java_append_opts | trim | length > 0 %}
JAVA_OPTS_APPEND="{{ keycloak_quarkus_java_append_opts }}"
{% endif %}
{% else %}
JAVA_OPTS="{{ keycloak_quarkus_java_opts }}"
{% endif %}
@@ -7,7 +7,7 @@ KC_BOOTSTRAP_ADMIN_PASSWORD='{{ keycloak_quarkus_bootstrap_admin_password }}'
{% endif %}
PATH="{{ keycloak_quarkus_java_home | default(keycloak_sys_pkg_java_home, true) }}/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
JAVA_HOME="{{ keycloak_quarkus_java_home | default(keycloak_sys_pkg_java_home, true) }}"
JAVA_OPTS="{{ keycloak_quarkus_java_opts }}"
{% include 'java-sysconfig.j2' %}
# Custom ENV variables
{% for env in keycloak_quarkus_additional_env_vars %}
@@ -50,8 +50,12 @@ https-trust-store-password={{ keycloak_quarkus_https_trust_store_password }}
{% endif %}
# Client URL configuration
{% if keycloak_quarkus_hostname | length > 0 %}
hostname={{ keycloak_quarkus_hostname }}
{% endif %}
{% if keycloak_quarkus_hostname_admin | length > 0 %}
hostname-admin={{ keycloak_quarkus_hostname_admin }}
{% endif %}
hostname-strict={{ keycloak_quarkus_hostname_strict | lower }}
hostname-backchannel-dynamic={{ keycloak_quarkus_hostname_backchannel_dynamic | lower }}
@@ -7,7 +7,7 @@ KC_BOOTSTRAP_ADMIN_PASSWORD='{{ keycloak_quarkus_bootstrap_admin_password }}'
{% endif %}
PATH="{{ keycloak_quarkus_java_home | default(keycloak_sys_pkg_java_home, true) }}/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
JAVA_HOME="{{ keycloak_quarkus_java_home | default(keycloak_sys_pkg_java_home, true) }}"
JAVA_OPTS="{{ keycloak_quarkus_java_opts }}"
{% include 'java-sysconfig.j2' %}
# Custom ENV variables
{% for env in keycloak_quarkus_additional_env_vars %}