Compare commits

..
916 Commits
Author SHA1 Message Date
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
ansible-middleware-core 0fb476c6a1 Bump version to 3.1.1 2026-09-11 15:08:05 +00:00
Ranabir ChakrabortyandGitHub a071cd1c2d Merge pull request #416 from RanabirChakraborty/changelog/3.1.0
Update changelog for release 3.1.0
2026-09-11 20:34:19 +05:30
ansible-middleware-coreandRanabir Chakraborty 6b2d4a8552 Update changelog for release 3.1.0
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-09-11 20:29:58 +05:30
Ranabir ChakrabortyandGitHub 08ee1c33bc Merge pull request #412 from cihlamar/AMW-628
Replace deprecated top-level fact variables with ansible_fact
2026-09-11 20:01:40 +05:30
Ranabir ChakrabortyandGitHub e103524781 Merge pull request #384 from NilsBergmann/feature/authv2-formaction
authentication_v2: Fix validation for FormActions
2026-09-11 20:00:09 +05:30
Ranabir ChakrabortyandGitHub 45863b3023 Merge pull request #414 from hcherukuri/main
Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified mappers are merged in
2026-09-11 12:44:16 +05:30
Ranabir ChakrabortyandGitHub 9ac8274434 Merge pull request #413 from cihlamar/AMW-578
Replace deprecated community.general.yaml callback with result
2026-09-10 21:07:57 +05:30
Harsha Cherukuri 0716f622ad Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified mappers are merged in 2026-09-10 09:03:29 -04:00
Harsha CherukuriandGitHub 14cba062b4 Merge pull request #411 from RanabirChakraborty/AMW-626
AMW-626 keycloak_user_rolemapping raises 403 error code while listing asignable Roles if invoker lacks view-realm Role
2026-09-10 08:57:52 -04:00
Martin Cihlar 9d56a54bd8 AMW-628 Replace deprecated top-level fact variables with ansible_facts syntax 2026-09-10 13:26:02 +02:00
Martin Cihlar 8c3c4d8cbc AMW-578 Replace deprecated community.general.yaml callback with result_format 2026-09-10 10:38:00 +02:00
Nils Bergmann 638f694120 authentication_v2: Fix validation for form-flows and client-flows 2026-09-09 10:36:56 +02:00
Ranabir Chakraborty 86bd6c77d6 AMW-626 keycloak_user_rolemapping raises 403 error code while listing asignable Roles if invoker lacks view-realm Role 2026-09-09 13:24:37 +05:30
Ranabir ChakrabortyandGitHub 6644207e5d Merge pull request #407 from Yabk/bugfix/keycloak_group_parents
keycloak_group: fix subgroup lookup on Keycloak older than 25
2026-09-09 12:40:51 +05:30
Ranabir ChakrabortyandGitHub 5ba8098c15 Merge pull request #408 from cihlamar/AMW-625
Add use_netrc option to prevent .netrc overriding bearer token
2026-09-09 12:33:09 +05:30
Martin Cihlar d6ceb63914 AMW-625 add use_netrc option to prevent .netrc overriding bearer token auth
When ~/.netrc contains an entry matching the Keycloak host, open_url()
silently replaces the OIDC Bearer header with Basic auth, causing 401
errors. Add use_netrc option (default false) to all keycloak modules
and pass it through to both open_url() call sites.

Includes molecule test scenario (netrc) that verifies both behaviors:
- default use_netrc=false ignores .netrc (fix works)
- use_netrc=true picks up .netrc and gets 401 (proves the bug)

Fixes: https://github.com/ansible-middleware/keycloak/issues/403
2026-09-07 09:09:39 +02:00
Yabk 529b667321 keycloak_group: fix subgroup lookup on Keycloak older than 25
The parents branch of get_group_by_name() queried
GET /admin/realms/{realm}/groups/{id}/children?search=&exact=true
unconditionally. That endpoint only accepts GET from Keycloak 23 on, so
older servers (RH-SSO 7.x included) failed with 405 Method Not Allowed,
and 23/24 ignore search/exact and return only the first 10 children, so
subgroups past the tenth were silently reported as absent.

The lookup now goes through get_subgroups(), which already detects the
server generation, and that helper takes an optional search argument so
the search optimization is kept where the server supports it.
2026-09-04 12:56:23 +02:00
Harsha CherukuriandGitHub 8d5526aeb6 Merge pull request #406 from RanabirChakraborty/AMW-622
AMW-622 keycloak collection spelling and grammar checking for PRs
2026-09-03 13:48:04 -04:00
Ranabir ChakrabortyandGitHub afc12b6ae2 Merge pull request #405 from hcherukuri/main
Fix issue #397 #398 crash on first role assignment
2026-09-03 22:34:37 +05:30
Ranabir Chakraborty 0868b58e90 AMW-622 keycloak collection spelling and grammar checking for PRs 2026-09-03 22:18:47 +05:30
Harsha Cherukuri 2ffe3a8f7b Fix keycloak_user_federation for issue #398 2026-09-03 10:02:35 -04:00
Harsha CherukuriandGitHub 6814939116 Merge pull request #402 from stblassitude/fix/keycloak_authentication_v2-subflow-keyerror
In a flow definition, handle non-existing keys correctly
2026-09-03 09:47:01 -04:00
Harsha Cherukuri 24350903ed Fix issue #397 crash on first role assignment 2026-09-03 09:43:17 -04:00
Harsha CherukuriandGitHub 89cb1691ae Merge pull request #404 from hcherukuri/main
Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter
2026-09-03 09:38:14 -04:00
Harsha Cherukuri 79852e61fc Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter 2026-09-03 08:23:38 -04:00
Stefan Bethke 8007d8039a Handle non-existing keys correctly
See issue #401 for details.
2026-09-02 10:35:01 +02:00
Ranabir ChakrabortyandGitHub 85d494731a Merge pull request #399 from santanoce/bugfix/keycloak_user
keycloak_user: fix attributes always reporting changed=True
2026-09-01 18:43:41 +05:30
Ranabir ChakrabortyandGitHub d41fc161be Merge pull request #392 from cihlamar/AMW-612
Normalize hostname that includes http_relative_path suffix
2026-09-01 18:42:10 +05:30
Harsha CherukuriandGitHub 4e1d14c4a1 Merge pull request #400 from RanabirChakraborty/AMW-615
AMW-615 Inconsistent support of authentication via client credentials
2026-08-31 22:34:42 -04:00
Ranabir Chakraborty e9f74fa4a9 AMW-615 Inconsistent support of authentication via client credentials 2026-08-31 23:40:02 +05:30
santanoce 23d96186f5 keycloak_user: fix attributes always reporting changed=True 2026-08-30 12:44:17 +02:00
Martin Cihlar b48b0b7334 AMW-612 Fix health URL duplication when hostname includes http_relative_path
Use removesuffix to strip overlapping path from hostname before
re-appending http_relative_path, preventing /auth/auth/ duplication.
Add molecule test for the relative path scenario.
2026-08-27 13:14:28 +02:00
Martin CihlarandGitHub 9446e53b6e Merge pull request #393 from ansible-middleware/dependabot/github_actions/ansible-collections/partner-certification-checker/dot-github/workflows/certification-reusable.yml-4.1.0
Bump ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml from 4.0.0 to 4.1.0
2026-08-27 11:50:45 +02:00
Ranabir ChakrabortyandGitHub a29e1a0c0e Merge pull request #387 from ansible-middleware/dependabot/github_actions/EndBug/add-and-commit-11
Bump EndBug/add-and-commit from 10 to 11
2026-08-26 22:45:27 +05:30
Ranabir ChakrabortyandGitHub f082e8adb1 Merge pull request #374 from RISE-GmbH/369-add_integration_tests_for_keycloak_authentication_v2
369 add integration tests for keycloak_authentication_v2
2026-08-26 22:45:08 +05:30
Ranabir ChakrabortyandGitHub a4cdf1b154 Merge pull request #395 from ansible-middleware/bump/3.0.12
Bump version to 3.0.12
2026-08-24 22:40:30 +05:30
ansible-middleware-core 4112ac7d71 Bump version to 3.0.12 2026-08-24 17:08:25 +00:00
Ranabir ChakrabortyandGitHub a965f47fb8 Merge pull request #394 from ansible-middleware/changelog/3.0.11
Update changelog for release 3.0.11
2026-08-24 22:37:01 +05:30
ansible-middleware-core 15356606f3 Update changelog for release 3.0.11
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-08-24 17:05:40 +00:00
dependabot[bot]andGitHub 8021fd735d 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.0.0 to 4.1.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/f182febf0568baf1151f66549401167fd10b25d2...f4bf7ba4d3f008b2db8fc6a812fa3f89fdf42c2e)

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

Signed-off-by: dependabot[bot] <support@github.com>
2026-08-24 12:45:47 +00:00
Ranabir ChakrabortyandGitHub 412f3f405d Merge pull request #389 from hcherukuri/main
Fix cert workflow
2026-08-18 18:39:45 +05:30
Harsha Cherukuri e5f6f92c5d Fix cert workflow 2026-08-18 08:46:50 -04:00
dependabot[bot]andGitHub 3d9c71a2e6 Bump EndBug/add-and-commit from 10 to 11
Bumps [EndBug/add-and-commit](https://github.com/endbug/add-and-commit) from 10 to 11.
- [Release notes](https://github.com/endbug/add-and-commit/releases)
- [Commits](https://github.com/endbug/add-and-commit/compare/v10...v11)

---
updated-dependencies:
- dependency-name: EndBug/add-and-commit
  dependency-version: '11'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-08-17 12:46:38 +00:00
Thomas Bargetz 742c44039c 369 add integration tests for keycloak_authentication_v2 2026-08-17 07:40:31 +02:00
Harsha CherukuriandGitHub 9c347d1bf0 Merge pull request #376 from RISE-GmbH/375-increase_number_of_subflow_levels
375 increase maximum of sub levels to 25
2026-08-14 11:28:40 -04:00
Harsha CherukuriandGitHub 6023cff8ca Merge pull request #381 from snecklifter/fix/changelog-sanity-dotfile
Remove changelogs/fragments/.gitignore to fix changelog sanity test
2026-08-13 13:56:27 -04:00
Harsha CherukuriandGitHub fd13175e45 Merge pull request #377 from snecklifter/feat/keycloak-organization-module
Add keycloak_organization and keycloak_organization_info modules
2026-08-13 13:55:33 -04:00
Harsha CherukuriandGitHub c831534a48 Merge pull request #379 from ansible-middleware/dependabot/github_actions/actions/checkout-7
Bump actions/checkout from 2 to 7
2026-08-12 17:53:24 -04:00
Chris BrownandClaude Opus 4.6 192061d1b5 Remove changelogs/fragments/.gitignore to fix changelog sanity test
The changelog sanity test rejects dotfiles in the fragments directory.
The .gitignore was only present to keep the empty directory tracked
by git. The directory is recreated by antsibull-changelog when
fragments are added, so it does not need to exist in the repo.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-08-12 21:43:02 +01:00
Ranabir ChakrabortyandGitHub bba9d8bb23 Merge pull request #380 from ansible-middleware/dependabot/github_actions/EndBug/add-and-commit-10
Bump EndBug/add-and-commit from 4 to 10
2026-08-12 21:01:55 +05:30
dependabot[bot]andGitHub 7a1dbad76f Bump EndBug/add-and-commit from 4 to 10
Bumps [EndBug/add-and-commit](https://github.com/endbug/add-and-commit) from 4 to 10.
- [Release notes](https://github.com/endbug/add-and-commit/releases)
- [Commits](https://github.com/endbug/add-and-commit/compare/v4...v10)

---
updated-dependencies:
- dependency-name: EndBug/add-and-commit
  dependency-version: '10'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-08-10 17:05:00 +00:00
dependabot[bot]andGitHub 50e1d93184 Bump actions/checkout from 2 to 7
Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 7.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v2...v7)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-08-10 17:04:56 +00:00
Ranabir ChakrabortyandGitHub 786ef844f8 Merge pull request #378 from hcherukuri/main
Add certification checks to the upstream repo
2026-08-10 22:31:41 +05:30
Harsha Cherukuri 8d44d73394 Add certification checks to the upstream repo
Declare module Python requirement for certification sanity
2026-08-10 10:11:24 -04:00
Chris BrownandClaude Opus 4.6 c8253fdbf8 Add keycloak_organization and keycloak_organization_info modules
Keycloak 26 introduced Organizations as a stable feature for B2B
multi-tenancy within a single realm. This adds declarative Ansible
module support so organizations can be managed like other Keycloak
resources instead of requiring direct REST API calls.

New modules:
- keycloak_organization: CRUD for organizations with full check_mode,
  diff_mode, and idempotency support. Manages name, alias, description,
  enabled state, domains, and attributes.
- keycloak_organization_info: read-only module to list/search
  organizations by name with exact or partial matching.

Also adds 6 API methods to the KeycloakAPI class and comprehensive
Molecule integration tests covering create, idempotency, update,
info queries, attributes, and delete flows.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-08-07 07:26:58 +01:00
Thomas Bargetz 9abf2e832b 375 increase maximum of sub levels to 10 2026-07-30 12:56:51 +02:00
Harsha CherukuriandGitHub 9e5946a2a4 Merge pull request #373 from RanabirChakraborty/AMW-594
AMW-594 Upstream release is failing due to recent rules change
2026-07-28 13:21:08 -04:00
Ranabir Chakraborty ef2f24e9fc AMW-594 Upstream release is failing due to recent rules change 2026-07-28 21:28:35 +05:30
Harsha CherukuriandGitHub 866c5e2255 Merge pull request #371 from RISE-GmbH/368-avoid_pruning_of_undefined_realm_attributes
368 keycloak_realm: Control whether undefined realm attributes are pruned
2026-07-28 09:10:49 -04:00
Harsha CherukuriandGitHub a0b924b593 Merge pull request #372 from hcherukuri/main
Add community.general.keycloak_realm_users_info into keycloak collection
2026-07-28 08:46:31 -04:00
Thomas Bargetz 95c6fe1b50 386 add integration tests 2026-07-27 11:01:35 +02:00
9bb680b8e6 Update plugins/modules/keycloak_realm_users_info.py
Co-authored-by: Felix Fontein <felix@fontein.de>
2026-07-26 21:02:08 -04:00
Thomas Bargetz 1f0a7c289f 368 introduce the parameter prune_undefined_realm_attributes to control whether undefined realm attributes are pruned 2026-07-24 10:20:17 +02:00
Harsha Cherukuri ff51c4098a Add community.general.keycloak_realm_users_info into keycloak collection 2026-07-23 22:31:32 -04:00
Ranabir ChakrabortyandGitHub f2792e32ba Merge pull request #364 from cihlamar/AMW-299
Fix health check URL to include HTTP relative path
2026-07-22 19:49:44 +05:30
Martin Cihlar 4f62617f2c Fix health check URL to include HTTP relative path
- Include keycloak_quarkus_http_relative_path in health_url construction
- Use rstrip('/') to handle both default '/' and custom paths like '/auth'
- Replace hardcoded 'master' realm with keycloak_quarkus_master_realm variable
- Add keycloak_quarkus_validate_certs option for SSL certificate validation
- Update documentation in meta and README

Fixes #299
2026-07-22 11:24:57 +02:00
Harsha CherukuriandGitHub edb38ebb3d Merge pull request #366 from RanabirChakraborty/AMW-592
AMW-592 AMW Github Actions are failing because of latest molecule
2026-07-20 15:38:03 -04:00
Ranabir Chakraborty d25bf46a6a AMW-592 AMW Github Actions are failing because of latest molecule 2026-07-21 00:27:35 +05:30
Helmut WolfandGitHub 74ca1e05ef Merge pull request #363 from world-direct/fix/no_log-provider-secrets
fix(keycloak_quarkus): avoid leaking maven provider password in logs
2026-07-01 09:38:16 +02:00
Helmut WolfandClaude Opus 4.8 b9181abb24 fix(keycloak_quarkus): avoid leaking maven provider password in logs
The Validate providers / Download custom providers via http / Copy local
providers tasks loop over all providers and print the item (including
maven.password) in cleartext, even for skipped iterations. Add the same
conditional no_log the maven download/copy tasks already use so entries
carrying a secret are censored while url/local providers stay visible.

Refs ansible-middleware/keycloak#362

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-01 09:23:48 +02:00
Helmut WolfandGitHub d4eafe1b30 Merge pull request #361 from world-direct/fix/360
fix: fact renaming regression (store_items), closes #360
2026-06-30 08:35:09 +02:00
Helmut Wolf 19bd41a86a fix: fact renaming regression (store_items), closes #360 2026-06-30 08:15:48 +02:00
ansible-middleware-core b44d754b8c Bump version to 3.0.11 2026-06-25 12:29:55 +00:00
ansible-middleware-core 404d2f6a1b Update changelog for release 3.0.10
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-06-25 12:29:32 +00:00
Ranabir ChakrabortyandGitHub bfcb125d87 Merge pull request #359 from RanabirChakraborty/vars_fix
Fixing vars naming issue
2026-06-25 13:38:46 +05:30
Ranabir Chakraborty 1164bf008d Fixing vars naming issue 2026-06-25 12:32:49 +05:30
Ranabir ChakrabortyandGitHub f3353d1686 Merge pull request #358 from hcherukuri/main
Removing from __future__ import annotations broke runtime type hints using Sequence and union syntax, causing sanity import failures and molecule module errors
2026-06-25 10:38:20 +05:30
Harsha Cherukuri e4c3ec8046 Removing from __future__ import annotations broke runtime type hints using Sequence and union syntax, causing sanity import failures and molecule module errors. 2026-06-24 23:19:59 -04:00
Harsha Cherukuri 82022b9031 Replace from __future__ import annotations with the required future-import. 2026-06-24 23:19:59 -04:00
Harsha CherukuriandGitHub 0307985282 Merge pull request #356 from RanabirChakraborty/AMW-571
AMW-571 keycloak_identity_provider hide_on_login_page not working
2026-06-24 23:19:24 -04:00
Harsha CherukuriandGitHub b0d1114684 Merge pull request #357 from RanabirChakraborty/lint_issue_fix
Fixing linting issues
2026-06-24 23:18:59 -04:00
Ranabir Chakraborty 728d5288ec Fixing linting issues 2026-06-25 03:22:25 +05:30
Ranabir Chakraborty eaeedd8d74 AMW-571 keycloak_identity_provider hide_on_login_page not working 2026-06-23 22:43:37 +05:30
Harsha CherukuriandGitHub 86a6bc63bb Merge pull request #354 from RanabirChakraborty/remove_deprecate
Remove deprecated ansible-basic-sphinx-ext
2026-06-23 08:26:40 -04:00
Ranabir Chakraborty d557665dc9 Remove deprecated ansible-basic-sphinx-ext 2026-06-23 14:52:59 +05:30
Harsha CherukuriandGitHub bd82a85dea Merge pull request #353 from RanabirChakraborty/AMW-568
Fix downstream SSO collection errors
2026-06-20 15:43:59 -04:00
Ranabir Chakraborty 1f82f50127 Fix downstream SSO collection errors 2026-06-20 21:14:34 +05:30
Ranabir ChakrabortyandGitHub adf0f7fc36 Merge pull request #352 from RanabirChakraborty/fix_password
Fixing password
2026-06-20 13:02:14 +05:30
Ranabir Chakraborty 0a9e6c66eb Fixing password 2026-06-20 13:01:44 +05:30
ansible-middleware-core da3d5e0ed6 Bump version to 3.0.10 2026-06-11 15:16:22 +00:00
ansible-middleware-core f172e019b4 Update changelog for release 3.0.9
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-06-11 15:16:05 +00:00
Harsha CherukuriandGitHub e764cfd6f1 Merge pull request #344 from RanabirChakraborty/rhbk_version_fix
AMW-551 Providing correct rhbk version
2026-06-11 09:48:33 -04:00
Ranabir Chakraborty 01b00dfb2e Providing correct rhbk version 2026-06-11 18:58:23 +05:30
Harsha CherukuriandGitHub 1908794569 Merge pull request #349 from felix-grzelka/consistent-naming-of-client-scope
Consistent naming of client scope
2026-06-10 09:07:00 -04:00
Harsha Cherukuri c8bcff39ef Fix keycloak client module 2026-06-10 08:22:52 -04:00
Felix Grzelka 0fad56294b fix typo 2026-06-10 11:14:23 +00:00
ansible-middleware-core b2b52ddfb5 Bump version to 3.0.9 2026-06-09 14:43:40 +00:00
ansible-middleware-core 7369a5724c Update changelog for release 3.0.8
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-06-09 14:43:23 +00:00
Felix Grzelka 942f0ae896 fix rename payload -> roles 2026-06-09 07:14:32 +00:00
Felix Grzelka 92d6dddd49 rename to role_owner_client_id 2026-06-08 13:21:27 +00:00
Felix Grzelka a1bb84ea5b fix some missed ones 2026-06-08 12:20:32 +00:00
Felix Grzelka 1ec94b961f rename files to match new convention 2026-06-08 12:00:52 +00:00
Felix Grzelka ba3f716e5c fix scope_id etc. 2026-06-08 12:00:52 +00:00
Felix Grzelka 808d137e4c s/clientscope/client_scope/ 2026-06-08 12:00:52 +00:00
Harsha CherukuriandGitHub 1794d4ff9b Merge pull request #348 from felix-grzelka/fix-normalize_keycloak_url
Remove normalize_keycloak_url
2026-06-05 07:40:20 -04:00
Felix Grzelka e898a2511a rm other use of normalize_keycloak_url 2026-06-05 07:29:53 +00:00
Felix Grzelka dd2cfaa87d remove normalize_keycloak_url 2026-06-04 13:20:03 +00:00
Harsha CherukuriandGitHub b114c7b252 Merge pull request #345 from cihlamar/standardize-readme-gitignore-lint
Standardize README and .ansible-lint configuration
2026-06-03 12:42:23 -04:00
Martin Cihlar 9920dc93c9 Standardize README and .ansible-lint configuration
- Update role links in README to full GitHub URLs
- Add profile: production to .ansible-lint for production-level linting
2026-06-03 17:11:56 +02:00
ansible-middleware-core 5cb555d6c2 Bump version to 3.0.8 2026-06-01 14:50:07 +00:00
ansible-middleware-core 3ab0f2b259 Update changelog for release 3.0.7
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-06-01 14:49:51 +00:00
Harsha CherukuriandGitHub 9394e2598f Merge pull request #341 from hcherukuri/main
Migrate Keycloak modules from the community.general collection to Keycloak collection.
2026-06-01 10:23:18 -04:00
Harsha Cherukuri 123906d739 Added PRs #11841 and #11749, and updated version references from community.general to Keycloak. 2026-05-30 09:29:04 -04:00
Harsha Cherukuri bdc090de64 Move community.general keycloak modules into keycloak collection 2026-05-28 13:14:54 -04:00
Ranabir ChakrabortyandGitHub d4a92c9f4f Merge pull request #343 from RanabirChakraborty/common_module_fix
Fixing common module usage
2026-05-28 20:55:21 +05:30
Ranabir Chakraborty 926ea0192d Fixing common module usgae 2026-05-28 20:13:34 +05:30
Ranabir ChakrabortyandGitHub 88c825c997 Merge pull request #342 from RanabirChakraborty/JN_to_UD
Jboss Network replace with Unified Downloads
2026-05-28 18:46:17 +05:30
Ranabir Chakraborty 0e3a9e3741 Jboss Network replace with Unified Downloads 2026-05-28 18:45:36 +05:30
Harsha CherukuriandGitHub 7495385ccb Merge pull request #338 from world-direct/fix/336_downloads
fix #336: https://github.com/ansible-middleware/common/pull/38
2026-05-27 14:44:14 -04:00
Helmut Wolf 494a522ab2 fix #336: https://github.com/ansible-middleware/common/pull/38 2026-05-27 20:03:36 +02:00
Ranabir ChakrabortyandGitHub 64e7fa3129 Merge pull request #339 from hcherukuri/main
Fix molecule tests
2026-05-27 21:06:37 +05:30
Harsha Cherukuri 15a0c6ee46 Fix molecule tests 2026-05-27 11:10:41 -04:00
ansible-middleware-core e4d1a79d1f Bump version to 3.0.7 2026-05-26 17:30:50 +00:00
ansible-middleware-core f4588dbbdf Update changelog for release 3.0.6
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-05-26 17:30:30 +00:00
Ranabir ChakrabortyandGitHub a9a771c6bc Merge pull request #337 from RanabirChakraborty/AMW-540
AMW-540 Fix the upstream collection requirements with common v1.2.4
2026-05-26 22:37:54 +05:30
Ranabir Chakraborty f00c714798 AMW-540 Fix the upstream collection requirements with common v1.2.4 2026-05-26 21:58:05 +05:30
Harsha CherukuriandGitHub 50750ef125 Update requirements.yml 2026-05-26 12:28:04 -04:00
ansible-middleware-core b631b07cae Bump version to 3.0.6 2026-05-20 18:44:49 +00:00
ansible-middleware-core 195e104f5e Update changelog for release 3.0.5
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-05-20 18:44:31 +00:00
Ranabir ChakrabortyandGitHub 047ddcaa92 Merge pull request #335 from RanabirChakraborty/AMW-528
AMW-528 Deployment fails in keycloak_quarkus due to missing escalation variables
2026-05-21 00:09:58 +05:30
Ranabir Chakraborty 0b2f2786dd AMW-528 Deployment fails in keycloak_quarkus due to missing escalation variables 2026-05-20 23:51:34 +05:30
ansible-middleware-core 4cc360052e Bump version to 3.0.5 2026-05-20 13:38:22 +00:00
ansible-middleware-core c6e3337778 Update changelog for release 3.0.4
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-05-20 13:38:01 +00:00
Harsha CherukuriandGitHub d1b295f551 Merge pull request #332 from cihlamar/AMW-522
Fix certification requirements for Keycloak
2026-05-20 09:36:11 -04:00
Martin Cihlar 5e13f4ea50 Fix certification requirements for Keycloak
- Add .ansible-lint, .DS_Store to build_ignore in galaxy.yml
- Add Release and Upgrade Notes section to README

[AMW-522](https://redhat.atlassian.net/browse/AMW-522)
2026-05-20 11:00:58 +02:00
Harsha CherukuriandGitHub 06cf664b08 Merge pull request #331 from RanabirChakraborty/SET-1341
SET-1341 Without ansible-core tag tests are failing in keycloak
2026-04-30 03:33:48 -04:00
Ranabir Chakraborty e5690d7513 SET-1341 Without ansible-core tag tests are failing in keycloak 2026-04-28 22:15:14 +05:30
Ranabir ChakrabortyandGitHub fb76736441 Merge pull request #330 from nwintering/main
Check that `data/tmp` directory has correct ownership
2026-04-28 18:24:19 +05:30
nwintering 6d00dcff48 check that tmp directory has correct permissions 2026-04-27 15:35:03 +02:00
Harsha Cherukuri eaf9964aab Fix docs pipeline 2026-04-24 10:50:10 -04:00
Harsha CherukuriandGitHub 180f075a9f Merge pull request #324 from RanabirChakraborty/AMW-518
AMW-518 Validating arguments against arg spec 'main' fails unexpectedly.
2026-04-24 10:34:55 -04:00
Harsha CherukuriandGitHub 1013a05f8c Merge pull request #328 from hcherukuri/main
Fix sanity and molecule tests
2026-04-24 10:26:26 -04:00
Harsha Cherukuri 22f1ce516d Fix sanity and molecule tests 2026-04-24 10:07:24 -04:00
Harsha CherukuriandGitHub 7be872cc48 Merge pull request #326 from paulomenon/add/example-playbooks-client-scope-auth-flow
Add/example playbooks client scope auth flow
2026-04-24 08:29:16 -04:00
Harsha CherukuriandGitHub 55248de9ae Merge pull request #325 from paulomenon/fix/keycloak-context-default
Fix keycloak_context default from /auth to empty string for Quarkus-based Keycloak
2026-04-24 08:29:00 -04:00
Harsha CherukuriandGitHub c6d4dfb8bb Merge pull request #327 from hcherukuri/main
Fix CI
2026-04-24 08:16:25 -04:00
Harsha Cherukuri c8f4065eb5 Fix CI 2026-04-24 08:00:45 -04:00
pamenon 06e096ac50 Add module documentation to collection and role READMEs
Document all six modules (including the two new ones) in the main
collection README under a new 'Included modules' section. Add the
three new example playbooks to the Config Playbooks section. Update
the keycloak_realm role README with a 'Related Modules' table and
inline examples for keycloak_client_scope and
keycloak_authentication_flow usage.

Made-with: Cursor
2026-04-23 12:54:22 +01:00
pamenon c6189bfc51 Add keycloak_client_scope and keycloak_authentication_flow modules with example playbooks
The collection was missing modules for managing client scopes and
authentication flows, forcing users to write raw uri calls against
the Keycloak Admin REST API. This adds two new modules that leverage
the existing KeycloakAPI helper methods:

- keycloak_client_scope: create/update/delete client scopes with
  protocol mappers (supports check_mode and diff)
- keycloak_authentication_flow: create/delete authentication flows
  with execution steps, or copy existing flows (supports check_mode
  and diff)

Also adds three example playbooks using the new modules:
- keycloak_client_scope.yml
- keycloak_authentication_flow.yml
- keycloak_realm_client.yml

Made-with: Cursor
2026-04-23 12:53:03 +01:00
pamenon 03fffaaf5f Fix keycloak_context default from /auth to empty string
The /auth context path was used by legacy WildFly-based Keycloak but
is no longer needed for Quarkus-based Keycloak (17+) or RHBK. The
current default of /auth forces users to explicitly pass an empty
keycloak_context to avoid broken API URLs.

This changes the default to an empty string, updates argument_specs
and README documentation, and removes the now-unnecessary
keycloak_context: '' overrides from all molecule converge files.

Users on legacy WildFly-based Keycloak can still set
keycloak_context: /auth explicitly.

Made-with: Cursor
2026-04-23 12:25:03 +01:00
Ranabir Chakraborty a337a1d70c AMW-518 Validating arguments against arg spec 'main' fails unexpectedly. 2026-04-17 19:24:46 +05:30
Ranabir ChakrabortyandGitHub 28168a9a4f Merge pull request #307 from sgoericke/fix-client-id
manage_client_roles.yml: use "client.id" instead of "client.name" to fix client role creation.
2026-04-09 23:37:31 +05:30
Helmut WolfandGitHub 64469b6fac Merge pull request #320 from world-direct/fix/ispn_config
fix: include ispn config file conditionally
2026-01-15 08:05:26 +01:00
Ranabir ChakrabortyandGitHub 75e308b710 Merge pull request #321 from RanabirChakraborty/AMW-467
AMW-467 Download keycloak binary from password protected HTTP location
2026-01-14 21:59:45 +05:30
Ranabir Chakraborty 9cdf24ce28 AMW-467 Download keycloak binary from password protected HTTP location 2026-01-13 23:48:01 +05:30
Helmut Wolf a00a602c3c fix: include ispn config file conditionally 2026-01-13 10:17:04 +01:00
Ranabir ChakrabortyandGitHub a5a75c6d46 Merge pull request #317 from SLedunois/main
v26.4.x compability
2026-01-12 23:34:28 +05:30
Helmut WolfandSimon Ledunois 7212e572cd chore(defaults): raise default keycloak/rhbk versions to 26.4.7 2026-01-12 10:28:47 +01:00
Helmut WolfandSimon Ledunois bc669ce0cd chore(deps): Update default SQL driver versions
As per https://access.redhat.com/articles/7027683
2026-01-12 10:28:47 +01:00
Simon LEDUNOIS 3c097ebf09 chore: add molecule test for quarkus ha 26.4- 2026-01-12 10:28:47 +01:00
Simon Ledunois 9562bf727e chore: manage infinispan configuration file 2026-01-12 10:28:47 +01:00
Simon Ledunois 6c3e327294 chore: upgrade to 26.4.7 2026-01-12 10:28:47 +01:00
Ranabir ChakrabortyandGitHub be0c8a4ae3 Merge pull request #319 from RanabirChakraborty/fixing-lint
Removing parseable from lint file as Additional properties are not allowed
2026-01-09 22:16:00 +05:30
Ranabir Chakraborty 6bf10cc3e9 Removing parseable from lint file as Additional properties are not allowed 2026-01-09 22:14:03 +05:30
ansible-middleware-core d0161dbeef Bump version to 3.0.4 2025-12-16 15:53:14 +00:00
ansible-middleware-core bf5c805fcd Update changelog for release 3.0.3
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2025-12-16 15:52:59 +00:00
Ranabir ChakrabortyandGitHub 2b1c07d87e Merge pull request #306 from fxwgr/patch0
Declared proxy_mode as deprecated, updated quarkus and realm readme
2025-12-16 20:08:58 +05:30
Andreas Wagner f1305e5aac Updated quarkus and realm readme, declared proxy_mode as deprecated
Updated argument_specs and declared keycloak_quarkus_proxy_mode as deprecated
2025-11-14 11:55:24 +01:00
Ranabir ChakrabortyandGitHub 412e17e9ea Merge pull request #312 from RanabirChakraborty/ci_label_fix
keycloak collection CI label is showing no status
2025-10-04 20:46:52 +05:30
Ranabir Chakraborty fa87c004e3 keycloak collection CI label is showing no status 2025-10-04 20:19:09 +05:30
Ranabir ChakrabortyandGitHub 6c9bddbd61 Merge pull request #308 from tinsjourney/fix_config_key_store_password
Fix config_key_store_file description to match variable name
2025-09-25 21:47:46 +05:30
Ranabir ChakrabortyandGitHub 4602d254cf Merge pull request #310 from world-direct/fix/309
ansible-core 2.19 compatibility
2025-09-18 18:58:54 +05:30
Helmut Wolf 8b2ef22023 fix ansible-core v2.19.0: initialize keycloak_quarkus_hostname_admin to an empty string 2025-07-22 12:11:09 +02:00
Helmut Wolf 66228c3a13 ansible 2.19.0: fix error
'item' is undefined error, https://github.com/ansible-middleware/keycloak/issues/309#issuecomment-3101960407
2025-07-22 12:09:14 +02:00
Stephane Vigan 556d155533 Fix config_key_store_file description to match variable name 2025-07-21 16:15:59 +02:00
Sven Goericke 07063353b8 fixed wrong variable lookup 2025-07-16 13:50:07 +02:00
Guido GrazioliandGitHub c1bf9727f9 Merge pull request #293 from world-direct/fix/292
Update to keycloak 26.3.0
2025-07-09 11:38:56 +02:00
Helmut Wolf f79fd227eb chore: bump KC/RHBK to v26.3.0/v26.2.5 2025-07-07 11:09:35 +02:00
Helmut Wolf 19564987ca fix(quarkus): update infinispan-client configuration to include port in server-list and hosts 2025-07-07 11:05:44 +02:00
Helmut Wolf 1ff25325a7 fix(ispn): use legacy JGroups stack configuration for < 26.2 only 2025-07-07 11:05:44 +02:00
Guido GrazioliandGitHub 0099f1cf07 Merge pull request #303 from fxwgr/main
Allow to install provider jars from remote paths
2025-07-04 12:47:10 +02:00
Guido GrazioliandGitHub 725ec8e37b Merge pull request #304 from SLedunois/client_secret
keycloak_realm: allow secret in keycloak_clients
2025-07-04 12:46:40 +02:00
Andreas Wagner bbe568baa5 Added support for copy remote_src function for providers 2025-07-02 16:39:49 +02:00
LEDUNOIS Simon dcd448443f feat: allow secret in keycloak_clients 2025-07-02 14:36:25 +00:00
ansible-middleware-core 3780a4e3c0 Bump version to 3.0.3 2025-07-01 16:56:26 +00:00
ansible-middleware-core e60a5b7cf6 Update changelog for release 3.0.2
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2025-07-01 16:56:10 +00:00
Guido GrazioliandGitHub 6143ae25e2 Merge pull request #296 from RanabirChakraborty/keycloak_force_install_quarkus_role
Fix `keycloak_quarkus_force_install` parameter being ignored by install
2025-07-01 18:45:34 +02:00
Ranabir Chakraborty ef6d8890fb keycloak_quarkus_force_install does not ignore bootstrapped 2025-07-01 21:55:39 +05:30
Guido GrazioliandGitHub 55185a1439 Merge pull request #302 from tinsjourney/fix_federation_provider_type
keycloak_realm: federation default provider type should be a string
2025-07-01 17:50:34 +02:00
Guido GrazioliandGitHub bb64b97e43 Merge pull request #298 from tinsjourney/alternate_download_fix
Fix alternate download location being ignored (JBossNeworkAPI always used)
2025-07-01 16:10:35 +02:00
Stephane Vigan a9c9e05569 Default provider type should be a string 2025-07-01 10:27:00 +02:00
Stephane Vigan 8b27cb0706 Fix case where archive is always downalod from JBoss Nework API
Even is we set keycloak_quarkus_alternate_download_url
previous block was run and we always try to download
archive from JBoss Network Api.
2025-06-26 10:42:25 +02:00
Guido GrazioliandGitHub 41127504dc Merge pull request #287 from guidograzioli/kc_26_caches
Session storage / distributed caches
2025-06-13 11:43:00 +02:00
Guido Grazioli bcc961999c implement Single site - Sessions stored in external Infinispan 2025-06-05 12:02:43 +02:00
Guido GrazioliandGitHub b8907d765d Merge pull request #289 from guidograzioli/288_jdk_21
Use jdk21 as default in debian
2025-06-05 09:30:26 +02:00
Guido Grazioli 5c5e84b63e Use jdk21 as default in debian 2025-06-04 20:53:28 +02:00
Guido Grazioli 3d4bd734f1 document new parameters 2025-05-29 22:20:08 +02:00
Guido Grazioli 3de96a6666 single site remote cache 2025-05-29 21:37:11 +02:00
Guido Grazioli de0ea02272 ci: move intermittent test back 2025-05-29 21:03:03 +02:00
Guido GrazioliandGitHub b6e585f503 Merge pull request #284 from guidograzioli/caches
Refactor test scenarios
2025-05-29 20:45:37 +02:00
Guido Grazioli 18de37706f tune Xmx Xms jvm args 2025-05-29 20:37:39 +02:00
Guido Grazioli b569e4e713 update remote cache test 2025-05-29 20:14:04 +02:00
Guido GrazioliandGitHub 919d55f806 Merge pull request #286 from RanabirChakraborty/AMW-398
Use tags to decorate the role workflow
2025-05-27 11:12:07 +02:00
Guido Grazioli 476bc0ec0b update test config 2025-05-23 14:59:50 +02:00
Helmut WolfandGitHub 2954bf81e8 Merge pull request #285 from world-direct/fix/keycloak_config_rebuild
Run config rebuild after SPI providers update
2025-05-21 09:26:07 +02:00
Ranabir Chakraborty 0403939c03 AMW-398 Use tags to decorate the role workflow 2025-05-20 21:40:32 +05:30
Helmut Wolf 88e4ea8d99 fix: MVN provider invokes KC config rebuild 2025-05-20 13:53:56 +02:00
Guido Grazioli 0a5fc3ae25 restructure molecule tests 2025-05-20 10:35:01 +02:00
Guido GrazioliandGitHub f4a1798f26 Merge pull request #283 from world-direct/feature/282
RHBK v26.2 (#282)
2025-05-19 18:37:01 +02:00
Helmut Wolf d23ae39c25 chore(molecule): RHBK v26.2 (#282) 2025-05-19 14:44:34 +02:00
Helmut Wolf 8f95bcb9e6 feat(HA): Change default ispn discovery mechanism to JDBCPING as per v26.2.* (#282) 2025-05-19 14:44:34 +02:00
Helmut Wolf f8c75de5d5 chore: RHBK v26.2: Bump KC version to v26.2.4 2025-05-19 14:44:34 +02:00
Helmut Wolf 8093b1af2a chore: RHBK v26.2: Bump RHBK version to v26.2.4 2025-05-19 14:12:22 +02:00
Helmut Wolf a70aece0d9 chore: RHBK v26.2: Update recommended JDBC driver versions 2025-05-19 14:12:22 +02:00
Guido GrazioliandGitHub d427a6b721 Merge pull request #281 from jonathanspw/keycloak_quarkus_jgroups_ip
New parameter to set the jgroups host IP address
2025-05-13 19:04:56 +02:00
Jonathan Wright c614af127e Add var to set the jgroups IP per host
This is useful if the default route does not
represent the network you want/need to use for
cluster communication.
2025-05-13 09:48:46 -05:00
Guido Grazioli 0936d415c7 ci: update test linking removed url 2025-05-09 15:20:57 +02:00
Guido GrazioliandGitHub a120b1c9b5 Merge pull request #280 from world-direct/feature/279_provider_checksums
New `checksum` property for keycloak_quarkus_providers
2025-05-06 17:49:41 +02:00
Helmut Wolf 5cd400b053 feat: introduce checksum for keycloak_quarkus_providers (#279) 2025-05-06 15:16:50 +02:00
ansible-middleware-core e0c4b1e1ff Bump version to 3.0.2 2025-05-02 09:49:08 +00:00
ansible-middleware-core 88be789260 Update changelog for release 3.0.1
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2025-05-02 09:48:54 +00:00
Guido GrazioliandGitHub 868dac4f72 Merge pull request #277 from guidograzioli/26_0_11_update
Version update to 26.0.8 / rhbk 26.0.11
2025-05-02 11:42:01 +02:00
Guido Grazioli c45f7c0d60 Update remote cache default 2025-05-02 11:33:28 +02:00
Guido GrazioliandGitHub 77c5b893b1 Merge pull request #276 from guidograzioli/275_envvars_handler
Trigger rebuild handler on envvars file change
2025-05-02 11:25:27 +02:00
Guido Grazioli 9974ab2ee1 update molecule scenario 2025-05-02 11:18:57 +02:00
Guido Grazioli b8a2ebc699 update keycloak version 2025-05-02 10:55:17 +02:00
Guido Grazioli 5beb5dcda4 Add trigger on envvars file change 2025-05-02 10:50:01 +02:00
ansible-middleware-core d97044523d Bump version to 3.0.1 2025-04-23 11:47:54 +00:00
ansible-middleware-core 2abc580041 Update changelog for release 3.0.0
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2025-04-23 11:47:38 +00:00
Guido GrazioliandGitHub 2379e10091 Merge pull request #274 from guidograzioli/273_extra_envvars_rebuild
Load environment vars during kc rebuild
2025-04-23 10:47:36 +02:00
Guido Grazioli c86dff66ba double quote sysconfig envvars 2025-04-22 20:18:48 +02:00
Guido Grazioli f750e93d02 Add bash to preinstalled packages 2025-04-22 14:51:15 +02:00
Guido Grazioli 1a4590b0b8 Load envvars in kc rebuild 2025-04-18 17:59:16 +02:00
Guido GrazioliandGitHub 5e9535c866 Merge pull request #271 from guidograzioli/honor_http_host_setting
Rename and honour parameter `keycloak_quarkus_http_host`
2025-04-18 09:11:11 +02:00
Guido Grazioli b8028d376a Rename and honor parameter keycloak_quarkus_http_host 2025-04-16 14:16:07 +02:00
Guido GrazioliandGitHub 20797e4cad Merge pull request #270 from guidograzioli/jdbc_params_rename
Rename parameters to follow upstream
2025-04-16 13:55:19 +02:00
Guido Grazioli 70d61ce8de rename ispn parameters 2025-04-16 11:58:04 +02:00
Guido Grazioli 69a947c0b6 rename _admin to _hostname_admin 2025-04-16 11:34:12 +02:00
Guido Grazioli c7ce7be6c4 drop ajp port parameter 2025-04-16 10:42:07 +02:00
Guido Grazioli e9061b29ef Rename parameters from jdbc to db 2025-04-16 10:31:48 +02:00
Guido GrazioliandGitHub c92bf19720 Merge pull request #269 from Preskton/patch-1
Update example playbooks to use new `bootstrap` var
2025-04-14 12:52:51 +02:00
Guido GrazioliandGitHub 1ca0b30a81 Merge pull request #268 from RanabirChakraborty/AMW-384
keycloak_realm: change url variables to defaults
2025-04-14 10:49:01 +02:00
Preston DosterandGitHub 7738e0feb1 Update keycloak_quarkus_dev.yml 2025-04-13 10:18:27 -05:00
Preston DosterandGitHub 671cf4eb53 Updating example playbooks to use bootstrap admin password
It looks like the underlying `quarkus` provider has changed to use `keycloak_quarkus_bootstrap_admin_password`.
2025-04-13 10:17:22 -05:00
Ranabir Chakraborty f146eb5fda AMW-384 Keycloak realm variable keycloak_url with hard-coded http 2025-04-11 21:49:01 +05:30
Guido GrazioliandGitHub a10bc95bfc Merge pull request #266 from guidograzioli/major_bump_3
Bump major and ansible-core versions
2025-04-09 20:28:52 +02:00
Guido Grazioli 314e2f26b2 Fix spell in parameter name 2025-04-09 18:08:18 +02:00
Guido Grazioli f628b84fb0 disable restart health check because of selfsigned cert 2025-04-09 17:21:49 +02:00
Guido Grazioli ac0ceca35f Update to ubi9 2025-04-09 09:45:22 +02:00
Guido Grazioli 744766fe3b update doc generation to 2.16 2025-04-08 15:36:38 +02:00
Guido Grazioli 7f980c44d2 Bump major and ansible-core versions 2025-04-08 11:58:47 +02:00
Guido GrazioliandGitHub 532dc12a60 Merge pull request #254 from world-direct/feature/253_rhbk_v26
Role support for keycloak/RHBK v26
2025-04-08 11:47:35 +02:00
Guido GrazioliandGitHub 173a85638f Merge pull request #257 from NilsDeckert/main
Skip certificate checking
2025-04-01 15:27:39 +02:00
Guido GrazioliandGitHub 81f019f8b5 Merge pull request #264 from guidograzioli/linter_reserved_words
Variables names must not be Ansible reserved names
2025-04-01 15:25:10 +02:00
Guido Grazioli 5db96afa56 Variables names must not be Ansible reserved names 2025-04-01 15:20:37 +02:00
Helmut Wolf fa36721207 Improve string interpolation 2025-01-20 09:44:27 +01:00
Helmut Wolf 86284b12c2 Fix molecule tests 2025-01-09 12:17:07 +01:00
Nils Deckert b3e93dd89b Skip certificate checking 2024-12-20 17:21:49 +01:00
Helmut Wolf e029e1c2fd keycloak_quarkus: Introduce keycloak_quarkus_health_check_url 2024-12-13 12:12:02 +01:00
Helmut Wolf d0f19b59dc keycloak_quarkus: Add http_management_port and http_management_relative_path options
RHBK v26 exposes health endpoints and metrics on this port moving forward.
Note that the scheme of the MGMT interface is defined by the overall keycloak configuration: if https is enabled and configured, th MGMT interface is exposed via https and NOT via http; this might be breaking some configured load balancer health checks
2024-12-13 12:11:35 +01:00
Helmut Wolf 213449ec58 RHBK v26: Add hostname v2 (KC/RHBK v26 Support #253)
Cf. https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html-single/upgrading_guide/index#new_hostname_options - especially the removed options
2024-12-13 12:11:35 +01:00
Helmut Wolf 277e1336ee RHBK v26: Migrate to keycloak_quarkus_bootstrap_admin_user[_password] (Process for creation of admin account changed #248) 2024-12-13 12:11:35 +01:00
Helmut Wolf 58233549a7 keycloak.conf: Remove config-keystore-type (KC/RHBK v26 Support #253)
Cf. <https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html-single/upgrading_guide/index#keystore_and_trust_store_default_format_change>
2024-12-13 12:11:35 +01:00
Helmut Wolf 0c58ae48ff RHBK v26: Update ispn session usages (KC/RHBK v26 Support #253)
Cf. <https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html-single/upgrading_guide/index#restricting_the_size_of_session_caches>
2024-12-13 12:11:35 +01:00
Helmut Wolf bf0bd9e1da RHBK v26: Update mssqj jdbc driver (KC/RHBK v26 Support #253)
As per <https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html-single/server_configuration_guide/index#db-installing-the-microsoft-sql-server-driver>
2024-12-13 12:11:35 +01:00
Helmut Wolf 5d15d37890 RHBK v26: Raise default KC+RHBK versions to v26.x (#253) 2024-12-13 12:11:35 +01:00
Guido GrazioliandGitHub 910a2aa5d4 Merge pull request #252 from world-direct/feature/cache_buster
Add theme cache invalidation handler
2024-12-12 09:36:18 +01:00
Helmut Wolf 5f534ca566 keycloak_quarkus: Add theme cache invalidation handler 2024-12-12 09:05:09 +01:00
Guido GrazioliandGitHub 692fb59797 Merge pull request #251 from RanabirChakraborty/increase_access_token_lifespan
Access token lifespan is too short for ansible run
2024-12-11 16:19:13 +01:00
Ranabir Chakraborty d1859aaff2 Access token lifespan is too short for ansible run 2024-12-03 22:40:25 +05:30
Guido GrazioliandGitHub 0d0e52f9ff Merge pull request #250 from world-direct/feature/249
Rebuild config and restart service for local providers
2024-11-25 08:40:54 +01:00
Helmut Wolf 68a0f88423 keycloak_quarkus: Rebuild config and restart service for local providers (#249) 2024-11-22 08:08:09 +01:00
ansible-middleware-core 333d55ad73 Bump version to 2.4.4 2024-10-16 07:24:57 +00:00
ansible-middleware-core f6fdae4aa8 Update changelog for release 2.4.3
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2024-10-16 07:24:42 +00:00
Guido GrazioliandGitHub b8c11f3ca8 Merge pull request #241 from guidograzioli/update_24_0_5
Update keycloak to 24.0.5
2024-10-16 09:02:43 +02:00
Guido Grazioli 1279937bb0 Update keycloak to 24.0.5 2024-10-16 08:56:53 +02:00
Guido GrazioliandGitHub c57753f608 Merge pull request #240 from guidograzioli/update_modules
update keycloak modules
2024-10-14 15:12:44 +02:00
Guido Grazioli be19ec1289 update tests 2024-10-14 14:36:58 +02:00
Guido Grazioli 5f1b43f37b update docs 2024-10-14 10:34:20 +02:00
Guido Grazioli c6bb815979 update keycloak modules 2024-10-14 10:22:10 +02:00
ansible-middleware-core ac4511bea9 Bump version to 2.4.3 2024-09-26 08:52:17 +00:00
ansible-middleware-core c8021f3102 Update changelog for release 2.4.2
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2024-09-26 08:52:04 +00:00
Guido GrazioliandGitHub 0386254073 Merge pull request #239 from guidograzioli/238_controller_download_path
New parameter `keycloak_quarkus_download_path`
2024-09-26 10:35:18 +02:00
Guido Grazioli b2edea8777 linter 2024-09-26 10:22:54 +02:00
Guido Grazioli fc0ee5a896 refactor default test for keycloak-quarkus offline 2024-09-26 10:22:42 +02:00
Guido Grazioli eb66d4a412 update prereqs validation 2024-09-26 10:22:28 +02:00
Guido Grazioli f170257205 Add local download path 2024-09-24 09:21:10 +02:00
Guido GrazioliandGitHub 3f4617c32c Merge pull request #237 from guidograzioli/236_waitfor_port_number
Add wait_for_port number parameter
2024-07-31 17:30:35 +02:00
Guido Grazioli 34caf6a490 add wait_for_port number parameter 2024-07-31 17:18:30 +02:00
Guido GrazioliandGitHub fa6ac99b34 Merge pull request #235 from guidograzioli/keycloak_realm_test
add verify steps for quarkus/keycloak_realm
2024-07-31 15:04:35 +02:00
Guido Grazioli a35c963a65 add verify steps for quarkus/keycloak_realm 2024-07-18 13:01:01 +02:00
Guido Grazioli 11aab0f5e2 add verify steps for quarkus/keycloak_realm 2024-07-18 12:53:49 +02:00
ansible-middleware-core fa2319d5da Bump version to 2.4.2 2024-07-02 14:23:53 +00:00
ansible-middleware-core 7c520dcdd2 Update changelog for release 2.4.1
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2024-07-02 14:23:37 +00:00
Guido Grazioli 35b3b090f6 ci: update READMEs 2024-07-02 15:59:16 +02:00
Guido Grazioli 94f1b8b355 ci: update README 2024-07-02 15:46:05 +02:00
Guido Grazioli e40f554936 ci: add traffic wf 2024-06-27 11:02:32 +02:00
Guido Grazioli 64e2a95685 ci: add traffic wf 2024-06-27 11:01:38 +02:00
Guido Grazioli c6fac7bb70 ci: add traffic wf 2024-06-27 11:00:29 +02:00
ansible-middleware-core 5f059e8d63 Bump version to 2.4.1 2024-06-04 15:44:35 +00:00
ansible-middleware-core e927ddbb6c Update changelog for release 2.4.0
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2024-06-04 15:44:20 +00:00
Guido Grazioli a82bdfbbb6 Bump to 2.4.0 2024-06-04 17:36:20 +02:00
Guido GrazioliandGitHub c850484e67 Merge pull request #234 from gionn/fix-restart-health-check-default
Enable by default health check on restart
2024-06-04 17:25:52 +02:00
Giovanni Toraldo a4deaa005a Enable by default health check on restart 2024-06-04 17:00:11 +02:00
Guido Grazioli 4fb44091d6 ci: fix missing symlink 2024-05-30 08:44:04 +02:00
Guido GrazioliandGitHub 883127d280 Merge pull request #232 from guidograzioli/linter_ansible_215
Update minimum ansible-core version > 2.15
2024-05-22 10:04:41 +02:00
Guido Grazioli e69e5b7ba4 readme 2024-05-21 12:41:31 +02:00
Guido Grazioli bf1871182b linter 2024-05-21 12:35:33 +02:00
Guido Grazioli adfee5f6e1 ci 2024-05-21 12:34:11 +02:00
Guido Grazioli ef53ca545a update yamllint 2024-05-21 12:31:40 +02:00
Guido Grazioli 2092c2d23a Update minimum ansible-core version > 2.15 2024-05-21 12:27:45 +02:00
ansible-middleware-core 8ca73364e9 Bump version to 2.3.1 2024-05-20 10:22:09 +00:00
ansible-middleware-core df1939e387 Update changelog for release 2.3.0
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2024-05-20 10:21:55 +00:00
Guido GrazioliandGitHub 0de0b654ee Merge pull request #227 from world-direct/feature/226
`proxy-header` enhancement
2024-05-16 16:49:06 +02:00
Helmut Wolf 62cbaa3596 Introduce keycloak_quarkus_show_deprecation_warnings, disabled in molecule tests 2024-05-16 16:30:57 +02:00
Helmut Wolf 92c24e49e7 #226: add proper default value for proxy-headers 2024-05-16 12:45:24 +02:00
Helmut Wolf cc012767a4 #226 - add deprecation warning 2024-05-16 12:45:24 +02:00
Helmut Wolf 4d31117c16 Fix RHBK version 2024-05-16 12:45:24 +02:00
Helmut Wolf 0fd8eb52d2 #226: CR changes 2024-05-16 12:45:24 +02:00
Helmut Wolf 6f2ed4d53b Fix #226 - minor proxy-header enhancement 2024-05-16 12:45:24 +02:00
Guido GrazioliandGitHub 1519d46f0e Merge pull request #231 from ansible-middleware/feature/182_restart_handler
Restart handler strategy behaviour
2024-05-16 11:25:02 +02:00
Guido Grazioli 4b21569f36 parameterize health check; refactor serial_then_parallel 2024-05-16 11:16:20 +02:00
Guido Grazioli f63b20b9d4 Update verify steps 2024-05-15 20:01:58 +02:00
Guido Grazioli fdcf1b2ed2 Add molecule scenario for HA restart 2024-05-15 19:53:33 +02:00
Guido Grazioli c22389c86f address review reqs 2024-05-15 15:58:21 +02:00
Guido GrazioliandHelmut Wolf 2d573c2b62 Add restart strategies, and allow custom task include
Co-authored-by: Helmut Wolf <hwo@world-direct.at>
Co-authored-by: Guido Grazioli <ggraziol@redhat.com>
2024-05-15 13:48:00 +02:00
Helmut Wolf 1e9a669dea #221 - add keycloak_quarkus_health_check_url_path config option 2024-05-15 10:28:46 +02:00
Helmut Wolf db831fa339 #182 - CR changes 2024-05-15 10:17:32 +02:00
Helmut Wolf d57be1f188 Close #182, #221: improve restart handler logic 2024-05-15 09:47:03 +02:00
Guido Grazioli 5adb28dcd8 Bump to 2.3.0 2024-05-15 09:22:45 +02:00
Guido GrazioliandGitHub 477ce5eaa3 Merge pull request #223 from world-direct/feature/222_mvn_providers
Feature/222  keycloak_quarkus: Add support for custom providers hosted on MVN
2024-05-15 09:17:23 +02:00
Helmut Wolf d2ece93c12 #222 Migrate to middleware_automation.common.maven_artifact 2024-05-14 20:33:29 +02:00
Guido GrazioliandGitHub 1a23350a8f Merge pull request #229 from world-direct/feature/228_sysconfig_custom_env_variables
Allow to add extra custom env vars in sysconfig file
2024-05-14 17:06:49 +02:00
Helmut Wolf 26316ddc50 #222: add support for local providers to be uploaded 2024-05-14 11:59:16 +02:00
Helmut Wolf 6d01ffbb77 Close #228: add support for custom env vars in sysconfig file 2024-05-14 11:10:38 +02:00
Helmut Wolf d87c8ca8ac wip 2024-05-14 10:14:43 +02:00
Helmut Wolf d8e9620a8a #222: Molecule tests 2024-05-14 10:14:43 +02:00
Helmut Wolf 4b902adc8d #222: Add support for maven providers 2024-05-14 10:14:15 +02:00
Guido GrazioliandGitHub 1b69191a6e Merge pull request #225 from world-direct/feature/224_policy_files
#224:  keycloak_quarkus: Add support for policy files
2024-05-14 09:11:51 +02:00
Helmut Wolf 6682853a2d #224: Add missing argument specs 2024-05-14 08:58:57 +02:00
Helmut Wolf 9f4623b05a #224: keycloak_quarkus: Add support for policy files 2024-05-14 08:36:55 +02:00
Guido GrazioliandGitHub 599ce0179c Merge pull request #220 from guidograzioli/rhbk_alternate_download_location
Download from alternate URL with optional http authentication
2024-05-10 15:33:51 +02:00
Guido Grazioli 8f14be37d7 add functionality 2024-05-10 10:17:37 +02:00
Guido GrazioliandGitHub 3076c3d5ce Merge pull request #218 from Footur/update-keycloak-v24.0.4
Update Keycloak to version 24.0.4
2024-05-09 11:08:47 +02:00
Guido GrazioliandGitHub 6610a310ff Merge pull request #217 from guidograzioli/major_upgrade_test
Port downstream upgrade
2024-05-09 11:08:23 +02:00
Footur fcf629d05e Update Keycloak to version 24.0.4 2024-05-09 09:24:47 +02:00
Guido Grazioli 4bbc8e0256 update systemd service name in verify 2024-05-08 19:14:04 +02:00
Guido Grazioli 4c96cbe7f6 use sane version to be upgraded 2024-05-08 19:09:59 +02:00
Guido Grazioli 22f5ad902f add test to github actions 2024-05-08 19:05:24 +02:00
Guido Grazioli 3c22417674 Port downstream upgrade 2024-05-08 19:03:30 +02:00
Guido GrazioliandGitHub cd36eacb07 Merge pull request #215 from world-direct/feature/214_sqlserver_jdbc_version
Close #214: RHBK 24.*: Update sqlserver JDBC version
2024-05-08 18:45:03 +02:00
Helmut Wolf a019823871 Close #214: RHBK 24.*: Update sqlserver JDBC version 2024-05-08 17:15:50 +02:00
Guido GrazioliandGitHub 3863508df5 Merge pull request #213 from guidograzioli/2_2_3_linter
Linter warnings fix pass
2024-05-07 10:30:16 +02:00
Guido Grazioli 1115ee409a Linter warnings fix pass 2024-05-07 10:18:43 +02:00
Guido Grazioli b497e946cc Bump tp 2.2.3 2024-05-07 09:47:12 +02:00
Guido GrazioliandGitHub 5067c03201 Merge pull request #211 from guidograzioli/keycloak_rebuild_java_home
`kc.sh build` uses configured jdk
2024-05-06 13:13:20 +02:00
Guido Grazioli a45b18dc85 kc.sh build uses configured jdk 2024-05-06 13:08:41 +02:00
Guido Grazioli 70834ccf13 downstream: remove problematic owner of downloaded zipfile 2024-05-06 12:03:44 +02:00
Guido Grazioli 2a7395c444 downstream: update default to rhbk 24.0.3 2024-05-06 11:20:00 +02:00
ansible-middleware-core 4da0e83ae9 Bump version to 2.2.3 2024-05-06 08:11:28 +00:00
ansible-middleware-core b427cb8a24 Update changelog for release 2.2.2
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2024-05-06 08:11:11 +00:00
Guido GrazioliandGitHub fa39e9b824 Merge pull request #210 from Footur/copy-key-material
Enable copying of key material
2024-05-06 08:28:09 +02:00
Footur 320a5f0d9a Copy the TLS private key from memory
This change should avoid storing plain private keys on disk due to
security risks. It also makes it easier to encrypt the data with SOPS.
2024-05-05 13:58:19 +02:00
Footur 7141e1c9b2 Test: Installation of key material via Ansible role 2024-05-05 12:11:51 +02:00
Footur 9bc1ae69e9 Enable copying of key material
This commit updates the configuration to use the standard Red Hat
Enterprise Linux (RHEL) default path for TLS certificates, which is
/etc/pki/tls.

Also, it copies the private key and certificate to the target host.
2024-05-03 16:34:57 +02:00
Guido GrazioliandGitHub bfbbacc72b Merge pull request #209 from guidograzioli/205_controller_become
controller priv escalation
2024-05-03 14:45:55 +02:00
Guido Grazioli feec4d9f8b controller priv escalation 2024-05-03 13:03:18 +02:00
Guido GrazioliandGitHub ba127153ff Merge pull request #207 from InfoSec812/Issue_206-_-fix-misnamed-params-and-allow-invalid-certs
jdbc_download and validate_certs params update
2024-05-03 08:47:38 +02:00
Deven Phillips b14d75dfab jdbc_download and validate_certs params update
- Added jdbc_download customization to both keycloak releases
- Added option to allow invalid certificates to download JDBC drivers
2024-05-02 14:33:36 -04:00
ansible-middleware-core 1d6a6eb7ee Bump version to 2.2.2 2024-05-02 17:00:01 +00:00
ansible-middleware-core 1ab3ebc2a4 Update changelog for release 2.2.1
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2024-05-02 16:59:47 +00:00
Guido GrazioliandGitHub d16c23faf9 Merge pull request #204 from InfoSec812/Issue_203-_-fix-input-validation-when-clause
Fix logic in when clause
2024-05-02 18:46:05 +02:00
Deven Phillips 978494524f Fix errors introduced 2024-05-02 12:31:16 -04:00
Deven Phillips 1a73c39a91 Fix logic in when clause 2024-05-02 12:09:36 -04:00
ansible-middleware-core 9e6a6f6076 Bump version to 2.2.1 2024-05-01 14:44:15 +00:00
ansible-middleware-core 55f6881b2f Update changelog for release 2.2.0
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2024-05-01 14:44:01 +00:00
Guido GrazioliandGitHub 41cbcc41e8 Merge pull request #202 from InfoSec812/Issue_200-_-customize-jdbc-driver-downloads
Customize jdbc driver downloads, optional authentication
2024-05-01 10:01:32 +02:00
Deven Phillips c2904bf20d Use FQCN for fail module 2024-04-30 14:48:10 -04:00
Deven Phillips e76b33e1db Merge remote-tracking branch 'upstream/main' into Issue_200-_-customize-jdbc-driver-downloads 2024-04-30 14:29:26 -04:00
Deven Phillips a7b9f0ef97 Add option to override JDBC download parameters 2024-04-30 14:27:42 -04:00
Guido Grazioli eafc4586d6 ci: turn historicized docs off 2024-04-30 13:09:27 +02:00
Guido GrazioliandGitHub 8493adc5c8 Merge pull request #201 from guidograzioli/custom_providers
Providers config and custom providers
2024-04-30 12:47:53 +02:00
Guido Grazioli 43b9ffcb64 Providers config and custom providers 2024-04-30 10:45:20 +02:00
Guido Grazioli a33393a477 ci: downstream molecule fixes 2024-04-25 14:11:05 +02:00
Guido Grazioli 278a70d627 ci: downstream molecule fixes 2024-04-25 13:57:31 +02:00
Guido Grazioli 6967385c7f ci: downstream molecule fixes 2024-04-25 13:03:03 +02:00
Guido Grazioli ac23e04d6a ci: downstream molecule fixes 2024-04-25 08:16:56 +02:00
Guido Grazioli 4c056d886e ci: downstream molecule fixes 2024-04-24 21:20:16 +02:00
Guido Grazioli 213a9a0766 ci: downstream molecule fixes 2024-04-24 17:56:15 +02:00
Guido GrazioliandPelisse Romain 2925ea8cf1 Add wait_for systemd logic 2024-04-24 16:17:05 +02:00
Guido GrazioliandGitHub 82498ab3f5 Merge pull request #195 from InfoSec812/Issue-193_-_add-option-for-hostname-strict-https
Added hostname-strict-https option
2024-04-19 16:05:46 +02:00
Guido GrazioliandGitHub 16accd5e30 Merge branch 'main' into Issue-193_-_add-option-for-hostname-strict-https 2024-04-19 16:00:09 +02:00
Deven Phillips 04bb465992 Added argument specs 2024-04-19 09:55:08 -04:00
Guido GrazioliandGitHub b978e8bb88 Merge pull request #197 from world-direct/feature/190_remove_KEYCLOAK_ADMIN_envs
#190: remove `keycloak_quarkus_admin_user[_pass]` once keycloak is bootstrapped
2024-04-19 14:44:05 +02:00
Helmut Wolf 289b4767e0 #190: remove keycloak_quarkus_admin_user[_pass] once keycloak is bootstrapped 2024-04-19 13:42:28 +02:00
Guido GrazioliandGitHub 9a961f743b Merge pull request #196 from guidograzioli/172_vaults
Keystore based vault SPI
2024-04-19 09:06:38 +02:00
Deven Phillips b8cba487ac Add better error trapping for booleans 2024-04-18 13:15:46 -04:00
Guido Grazioli ff198bcd3e workaround debug logfile too long for slurp 2024-04-18 11:06:14 +02:00
Guido Grazioli d06dcea998 Add argument specs, update README 2024-04-18 10:49:38 +02:00
Guido Grazioli 89db3fa36f Implement vault config 2024-04-18 10:44:17 +02:00
Guido Grazioli cd8d61afc3 Update molecule test for keystore vault 2024-04-18 10:43:48 +02:00
Deven Phillips 47e6644fdd Ensure that value for keycloak_quarkus_hostname_strict_https is boolean, otherwise ignore it 2024-04-17 16:57:52 -04:00
Deven Phillips 3e28b3f4f7 Added hostname-strict-https option 2024-04-17 16:52:18 -04:00
Guido GrazioliandGitHub f7bcac79d0 Merge pull request #194 from guidograzioli/keycloak_24_update
Update keycloak to 24.0
2024-04-17 18:16:34 +02:00
Guido Grazioli 10057262bc 'fix' changelog 2024-04-17 18:07:42 +02:00
Guido Grazioli 5808d055ae Update keycloak to 24.0 2024-04-17 17:53:13 +02:00
Guido Grazioli 8060dd7fb8 Bump minor and start 2.2 2024-04-17 17:51:33 +02:00
Guido GrazioliandGitHub 4f8ed5194c Merge pull request #189 from world-direct/feature/188_config_keystore
#188: add support for configuration key store
2024-04-17 17:50:30 +02:00
ansible-middleware-core 462389cf0f Bump version to 2.1.3 2024-04-17 15:49:15 +00:00
ansible-middleware-core 903938ca16 Update changelog for release 2.1.2
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2024-04-17 15:49:00 +00:00
Guido Grazioli 74636e8629 ci: final round of linting 2024-04-17 17:29:38 +02:00
Guido Grazioli 6706fd9bf5 ci: bump and fix final linter warnings 2024-04-17 17:24:57 +02:00
Helmut Wolf e991bd32c8 Fix typos 2024-04-17 17:09:44 +02:00
Helmut Wolf d469d389f3 Fix linter issues 2024-04-17 17:09:44 +02:00
Helmut Wolf c38642e0cd #188: fail early when no keytool installed 2024-04-17 17:09:44 +02:00
Helmut Wolf 0ee29eb483 #188: keycloak_quarkus: allow setting "sensitive options" using a Java KeyStore file #188 2024-04-17 17:09:44 +02:00
Helmut Wolf 60ca798e1a Rename keycloak_quarkus_*_store_* attributes 2024-04-17 17:09:44 +02:00
Helmut Wolf 921364b451 Fix docs 2024-04-17 17:09:44 +02:00
Guido Grazioli 50d189ee14 ci: more linter fixes 2024-04-17 16:56:56 +02:00
Guido Grazioli 5b459f3dde ci: more linter fixes 2024-04-17 16:48:24 +02:00
Guido GrazioliandGitHub f0318b2ecf Merge pull request #192 from guidograzioli/xxx_linter_1
Comprehensive linter warning fixes
2024-04-17 16:26:18 +02:00
Guido Grazioli 1f910bd400 Comprehensive linter warning fixes 2024-04-17 16:19:34 +02:00
Guido Grazioli d17c364257 downstream: ci sudo workaround 2024-04-17 12:14:25 +02:00
Guido Grazioli 1ff6f237a9 Bump 2.1.1 2024-04-17 11:58:11 +02:00
Guido Grazioli 0c0c4e19ea downstream: update rhbk to 2.0.10 2024-04-17 11:57:44 +02:00
Guido Grazioli 7bedb08f6e ci: update release wf params 2024-04-17 11:14:38 +02:00
Guido Grazioli 5464a01a62 ci: update doc links, test triggers 2024-04-17 11:08:04 +02:00
ansible-middleware-core 2cf3e2470d Bump version to 2.1.2 2024-04-17 08:58:56 +00:00
ansible-middleware-core ad6021c29a Update changelog for release 2.1.1
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2024-04-17 08:58:43 +00:00
Guido GrazioliandGitHub 05ebd90121 Merge pull request #191 from guidograzioli/190_sysconfig_worldreadable
Unrelax configuration file permissions
2024-04-17 10:51:45 +02:00
Guido Grazioli 1229a0b023 Unrelax configuration file permissions 2024-04-17 10:46:23 +02:00
Guido GrazioliandGitHub 4ba9014edb Merge pull request #187 from roumano/parse_proxy_headers
Permit parse reverse proxy headers
2024-04-17 10:36:50 +02:00
Christian Iuga ea57f8b689 remove unwanted extra code 2024-04-16 13:41:09 +02:00
Christian Iuga 3fbae4882e move keycloak_quarkus_proxy_headers into keycloak.conf 2024-04-16 13:39:33 +02:00
Christian Iuga 27717d7b4e Avoid cmd-line arguments
Fix https://github.com/ansible-middleware/keycloak/pull/187#discussion_r1565779164
2024-04-15 15:50:55 +02:00
Christian Iuga 4aa862101c Add new variable keycloak_quarkus_proxy_headers into meta/argument_specs.yml
Fix comment https://github.com/ansible-middleware/keycloak/pull/187#discussion_r1565772058
2024-04-15 15:48:02 +02:00
Christian Iuga 8e2f3eb77f Permit parse reverse proxy headers
- Via created a new optional variable : keycloak_quarkus_proxy_headers
- Fix enhancement #183
- see https://www.keycloak.org/server/reverseproxy about the official documentation
2024-04-15 14:41:56 +02:00
Guido GrazioliandGitHub 10d4cb8db7 Merge pull request #186 from guidograzioli/185_java_heap_options
JVM arguments go in JAVA_OPTS
2024-04-09 17:16:17 +02:00
Guido Grazioli 8f8de33350 JVM arguments go IN JAVA_OPTS 2024-04-08 16:47:49 +02:00
Guido GrazioliandGitHub 7dceb7f819 Merge pull request #184 from avskor/issue-125
Fix permissions on controller-side downloaded artifacts
2024-04-08 09:15:52 +02:00
avskor c2e456e1d5 Fix #125. Permission error when the become variable is set to true in the playbook 2024-04-04 11:22:18 +03:00
Guido GrazioliandGitHub 4421375dd5 Merge pull request #181 from guidograzioli/multi_distro_refactor
Multi distro refactor
2024-03-25 16:42:29 +01:00
Guido Grazioli 2bbf7d9cc4 revert JVM var that cannot be overridden 2024-03-25 16:30:13 +01:00
Guido Grazioli 467cfda0f7 same changes for keycloak-legacy 2024-03-25 16:00:18 +01:00
Guido Grazioli e17505fe42 update molecule for debian container 2024-03-25 15:37:02 +01:00
Guido Grazioli 0e4df659f4 add test 2024-03-25 14:35:28 +01:00
Guido Grazioli 3400b64b10 add to ci 2024-03-25 14:34:25 +01:00
Guido Grazioli 3b1534d700 refactor 2024-03-25 10:19:28 +01:00
Guido Grazioli dd6171f024 Add ansible_family based vars loading 2024-03-25 10:19:08 +01:00
Guido GrazioliandGitHub c1da6ea38d Merge pull request #180 from guidograzioli/keycloak_realm_default
Use `keycloak_realm` as default for sub-entities
2024-03-25 09:40:30 +01:00
Guido Grazioli 56e4a43cf9 add keycloak_realm default to sub entities 2024-03-25 09:30:25 +01:00
Guido GrazioliandGitHub 7a0a99a31c Merge pull request #178 from Aeyk/ubuntu
Ubuntu compatibility
2024-03-18 09:09:07 +01:00
aeykandGitHub fdce0bd922 Merge branch 'main' into ubuntu 2024-03-17 05:35:09 -04:00
Malik Kennedy b9d9874a00 feat: ubuntu compatibility 2024-03-17 09:15:38 +00:00
Guido Grazioli 1cecf51f37 downstream: more updates to custom xml 2024-03-14 11:41:52 +01:00
Guido Grazioli 0cea03dfc0 downstream: simplify overridexml test 2024-03-14 10:37:09 +01:00
Guido Grazioli 0c079740e1 downstream: molecule custom xml that works with rhsso 2024-03-14 10:13:46 +01:00
Guido Grazioli 96804d8086 downstream: rhsso has new patch filename pattern 2024-03-13 17:55:30 +01:00
Guido GrazioliandGitHub a875166fe0 Merge pull request #176 from growi/templates_comment_filter
Utilize comment filter for `ansible_managed` annotations
2024-03-13 14:24:19 +01:00
Björn Großewinkelmann a97c349f41 Utilize comment filter for {{ ansible_maanged }} annotations
Signed-off-by: Björn Großewinkelmann <bgrossew@redhat.com>
2024-03-13 00:19:42 +01:00
Romain PelisseandPelisse Romain a59a1fb8dd Rework Molecule prepare phase to install sudo only if root on target 2024-03-12 12:48:46 +01:00
Guido Grazioli d74820190f ci: rename keycloak_quarkus infinispan jinja2 template 2024-02-28 17:10:02 +01:00
ansible-middleware-core 6541b5e386 Bump version to 2.1.1 2024-02-28 15:58:47 +00:00
ansible-middleware-core 1e1665adb0 Update changelog for release 2.1.0
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2024-02-28 15:58:33 +00:00
Guido GrazioliandGitHub 33a839fec6 Merge pull request #171 from guidograzioli/170_quarkus_java_home_typo
keycloak_quarkus: fix custom JAVA_HOME parameter name
2024-02-27 19:35:31 +01:00
Guido Grazioli d97ddbde3c add test 2024-02-27 19:27:07 +01:00
Guido Grazioli 7f021a849e Linter 2024-02-27 17:17:24 +01:00
Guido Grazioli 167bf512c5 fix typo in variable name 2024-02-27 17:17:14 +01:00
Guido GrazioliandGitHub beee25dec2 Merge pull request #169 from ansible-middleware/mol_sudo
Adapt molecule tests to work with none root user on target (sudo)
2024-02-26 18:39:42 +01:00
Romain Pelisse 5bd39a0d0e molecule: use block to skip assets download entirely if needed 2024-02-26 16:46:30 +01:00
Romain Pelisse 7324f48e8d molecule: cleanup prepare to use one play 2024-02-26 16:46:30 +01:00
Romain Pelisse b3ca517583 molecule: adapt sudo setup to work when ansible is not connecting as root on the target 2024-02-26 16:46:26 +01:00
Guido GrazioliandGitHub b1848046dc Merge pull request #168 from Footur/update-keycloak-v23.0.7
Update Keycloak to version 23.0.7
2024-02-26 10:19:54 +01:00
Guido GrazioliandGitHub 983a1fb8f2 Merge pull request #167 from guidograzioli/xa_enable_recovery
Set enable-recovery when xa transactions are enabled
2024-02-26 10:19:44 +01:00
Footur d4fb20b230 Update Keycloak to version 23.0.7 2024-02-22 17:10:22 +01:00
Guido Grazioli f7bef0a956 set enable-recovery when xa transactions are enabled 2024-02-22 16:28:24 +01:00
Guido GrazioliandGitHub f62a97709a Merge pull request #163 from world-direct/feature/162_keycloak_quarkus_sticky-session-encoder
keycloak_quarkus: `sticky-session`s for infinispan routes
2024-02-08 21:31:12 +01:00
Guido GrazioliandGitHub 9593752e62 Merge pull request #161 from world-direct/feature/160_keycloak_quarkus_logging
keycloak_quarkus: Allow configuring log rotate options in quarkus configuration
2024-02-08 21:27:48 +01:00
Guido GrazioliandGitHub d6c29ed4fc Merge pull request #159 from world-direct/feature/inifinispan_ha
#158: Feature/inifinispan TCPPING
2024-02-08 21:24:53 +01:00
Helmut Wolf df81dc5497 #158: move TCPPING config to ispn config file 2024-02-08 16:26:48 +01:00
Helmut Wolf 4adab64dc0 #158: support for TCPPING 2024-02-08 16:26:48 +01:00
Helmut Wolf e0d4920a49 feature/162: keycloak_quarkus: make spi-sticky-session-encoder-infinispan-should-attach-route configurable in keycloak.conf 2024-02-08 16:19:14 +01:00
Helmut Wolf c2009a0a12 feature/160: CR changes 2024-02-08 16:10:32 +01:00
Helmut Wolf 0c5047bcc1 feature/160: keycloak_quarkus: Allow easier log setting configuration 2024-01-22 13:53:28 +01:00
Helmut Wolf 63f83d7744 add initial support for templating cache-ispn.xml 2024-01-22 12:38:29 +01:00
Guido GrazioliandGitHub 64fa8bb788 Merge pull request #157 from world-direct/fix/156_infinispan
keycloak_quarkus: renamed infinispan host list configuration
2024-01-22 08:14:36 +01:00
Helmut Wolf 688ec956fc fix #156: quarkus 3 ispn config renamings 2024-01-19 09:54:54 +01:00
ansible-middleware-core e866d1f4e4 Bump version to 2.0.3 2024-01-17 08:50:31 +00:00
ansible-middleware-core 2985f808ea Update changelog for release 2.0.2
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2024-01-17 08:50:24 +00:00
Guido GrazioliandGitHub 30309582f3 Update README.md 2024-01-16 09:17:47 +01:00
Guido GrazioliandGitHub 40229631e6 Merge pull request #150 from world-direct/fix/149
keycloak_quarkus: allow ports <1024 (e.g. :443) in systemd unit
2024-01-16 09:04:54 +01:00
Helmut Wolf 8adc018cb3 fix/#149: keycloak_quarkus: Allow ports <1024 (e.g., :443) 2024-01-16 08:33:34 +01:00
Guido GrazioliandGitHub 053d0f9873 Merge pull request #152 from world-direct/fix/151
keycloak_quarkus: allow configuration of `hostname-strict-backchannel`
2024-01-16 00:42:12 +01:00
Guido GrazioliandGitHub eb80ed0bd4 Merge pull request #148 from world-direct/feature/rhbk_mssql_driver
keycloak_quarkus: Add support for sqlserver jdbc driver
2024-01-16 00:41:47 +01:00
Guido GrazioliandGitHub d138b4b2ff Merge pull request #145 from world-direct/feature/keycloak_quarkus_systemd
keycloak_quarkus: systemd restart behavior
2024-01-16 00:41:35 +01:00
Helmut Wolf 922e4c10f5 #145 - CR changes 2024-01-15 14:40:46 +01:00
Guido GrazioliandGitHub 313bd8452a Merge pull request #154 from world-direct/fix/#153
fix/#153: keycloak_quarkus: Use `keycloak_quarkus_java_opts`
2024-01-15 09:57:34 +01:00
Helmut Wolf b1b31427d5 fix/#153: keycloak_quarkus: Use keycloak_quarkus_java_opts
Note: when multiple -X options of the same kind are provided, the last option seems to take precendence as per <https://stackoverflow.com/a/26727332>:

> java -Xmx1G -XX:+PrintFlagsFinal -Xmx2G 2>/dev/null | grep MaxHeapSize
2024-01-10 16:30:02 +01:00
Helmut Wolf b057f0297a fix/#151: keycloak_quarkus: allow configuration of hostname-strict-backchannel 2024-01-09 08:46:11 +01:00
Helmut Wolf bfd9db6703 fix/147: keycloak_quarkus: RBKC: Add support for sqlserver jdbc driver 2024-01-08 17:51:11 +01:00
Helmut Wolf 1d5ce87c16 keycloak_quarkus: Remove legacy (?) keycloak_management_url 2023-12-19 09:55:02 +01:00
Helmut Wolf 83bcb6712a keycloak_quarkus: add systemd control options
* keycloak_quarkus_service_restart_always
* keycloak_quarkus_service_restart_on_failure
* keycloak_quarkus_service_restartsec
2023-12-19 09:30:30 +01:00
Guido GrazioliandGitHub dab388d744 Merge pull request #142 from RanabirChakraborty/AMW-170
AMW-170 Ansible Hub links for rhbk are broken
2023-12-12 15:32:00 +01:00
Ranabir Chakraborty ed6dbd60fb AMW-170 Ansible Hub links for rhbk are broken 2023-12-11 22:12:39 +05:30
ansible-middleware-core db19fd5d19 Bump version to 2.0.2 2023-12-07 14:30:27 +00:00
ansible-middleware-core 473fb212c3 Update changelog for release 2.0.1
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2023-12-07 14:30:17 +00:00
Guido Grazioli 98b82ccb4f ci: runner playbook no keypair 2023-12-07 11:15:12 +01:00
Guido Grazioli 0fbf454279 ci: test alternate certs dir 2023-12-07 11:00:28 +01:00
Guido Grazioli d469d5df8b ci: downstream update sample playbooks 2023-12-06 18:52:46 +01:00
Guido Grazioli a23bf4c540 ci: downstream use correct version 2023-12-06 18:24:29 +01:00
Guido Grazioli ac0b421456 downstream: fix rhbk install path 2023-12-06 16:34:55 +01:00
Guido Grazioli 5b8fcb67dc ci: update sample quarkus playbook 2023-12-06 16:03:37 +01:00
Guido Grazioli acdee7fa63 ci: downstream arg specs for realm role 2023-12-06 15:40:28 +01:00
Guido GrazioliandGitHub 86576de6e8 Merge pull request #141 from guidograzioli/rhbk_arg_specs
downstream: add rhbk bits
2023-12-06 10:16:05 +01:00
Guido Grazioli 89944a6cd1 downstream: add rhbk bits 2023-12-06 09:57:33 +01:00
Guido GrazioliandGitHub 33e6d428b5 Merge pull request #140 from guidograzioli/molecule_jbcs_to_nginx
use nginx instead of jbcs for https_revproxy test
2023-12-05 20:09:08 +01:00
Guido Grazioli f365351abf use nginx instead of jbcs for https_revproxy test 2023-12-05 19:53:26 +01:00
Guido GrazioliandGitHub 75899dfa77 Merge pull request #139 from guidograzioli/128_hostname_strict
keycloak_quarkus: add hostname-strict parameter
2023-12-05 12:44:02 +01:00
Guido Grazioli 593c4df861 keycloak_quarkus: add hostname-strict parameter 2023-12-05 10:48:48 +01:00
Guido GrazioliandGitHub 4a72e3818c Merge pull request #138 from guidograzioli/fix_keycloak_23_booleans
Update template to lowercase booleans
2023-12-05 10:39:38 +01:00
Guido Grazioli 72ca9f5dfa switch pull_req_target to pull_req 2023-12-05 10:26:20 +01:00
Guido Grazioli 842e61c43e Update template to lowercase booleans 2023-12-05 10:13:12 +01:00
Guido GrazioliandGitHub 1728b20cd3 Merge pull request #133 from Footur/update-keycloak
Update Keycloak to version 23.0.1
2023-12-01 14:11:04 +01:00
FooturandGitHub c01ffed113 Merge branch 'ansible-middleware:main' into update-keycloak 2023-12-01 14:02:45 +01:00
Guido GrazioliandGitHub fea7ae0c6f Merge pull request #134 from guidograzioli/linter_yaml_2
Linter yaml 2
2023-12-01 12:42:10 +01:00
Guido Grazioli 94530640c1 update wf 2023-12-01 12:37:20 +01:00
Guido Grazioli d6f020ab44 linter fixes 2023-12-01 12:36:20 +01:00
Footur 55c02d7fc5 Update Keycloak to version 23.0.1 2023-12-01 10:34:04 +01:00
Guido GrazioliandGitHub 5e8e8c67e8 Merge pull request #132 from saadsb20/patch-1
Add prefix check for keycloak_quarkus_http_relative_path
2023-11-30 12:52:18 +01:00
Saâd BouryalnandGitHub 88935abb62 Validate relative path
validate the relative path ... must begin with /
2023-11-30 12:26:22 +01:00
Saâd BouryalnandGitHub 3a1d9099a7 reverte change 2023-11-30 12:01:49 +01:00
Saâd BouryalnandGitHub a439ccab5e fix health_url 2023-11-29 15:36:00 +01:00
ansible-middleware-core e086ee8d29 Bump version to 2.0.1 2023-11-20 17:10:52 +00:00
ansible-middleware-core 2841c7a951 Update changelog for release 2.0.0
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2023-11-20 17:10:43 +00:00
Guido GrazioliandGitHub d947e85745 Merge pull request #129 from JMuff22/patch-1
Update admin password variable in keycloak_quarkus.yml
2023-11-17 16:55:35 +01:00
Jake MuffandGitHub 143084d726 Update admin password variable in keycloak_quarkus.yml 2023-11-16 10:19:47 +02:00
Guido GrazioliandGitHub 23bda1b4c5 Merge pull request #127 from RanabirChakraborty/AMWSUP-17
AMWSUP-17 keycloak Ansible Hub documentation link broken
2023-11-13 18:27:55 +01:00
Guido Grazioli efc3e547fe ci: https_revproxy molecule verify step 2023-11-13 18:24:06 +01:00
Guido Grazioli 8af5d6e556 ci: https_revproxy molecule verify step 2023-11-13 18:10:40 +01:00
Guido Grazioli a0f6a4931f ci: https_revproxy molecule verify step 2023-11-13 16:47:03 +01:00
Guido Grazioli 49c5071733 ci: fix envvars 2023-11-13 16:38:11 +01:00
Ranabir Chakraborty 7a1eeec6b6 AMWSUP-17 keycloak Ansible Hub documentation link broken 2023-11-13 18:18:52 +05:30
Guido GrazioliandGitHub 69bd5b6ca8 Merge pull request #119 from guidograzioli/min_ansible_version
Update minimum ansible-core version > 2.14
2023-11-13 11:37:53 +01:00
Guido GrazioliandGitHub cee02cfd36 Merge pull request #116 from Footur/keystore
[keycloak_quarkus] Enable config of a key store and trust store
2023-11-13 11:37:36 +01:00
Guido Grazioli ea086e8a62 ci: add missing header to molecule test 2023-11-13 11:37:18 +01:00
Guido GrazioliandGitHub 24787e4607 Merge pull request #115 from gionn/114-add-more-configs
Add support for more http-related configs
2023-11-13 11:36:50 +01:00
Giovanni Toraldo 0e510c093a Set default keycloak_quarkus_http_relative_path as per upstream docs 2023-11-13 10:07:01 +01:00
Giovanni Toraldo 880d70ffb9 enable https_revproxy test 2023-11-07 10:21:05 +01:00
Giovanni Toraldo c8f968a587 cleanup vars 2023-11-07 10:20:01 +01:00
Giovanni Toraldo 8eb5185287 use relative path to build health url 2023-11-07 10:20:01 +01:00
Giovanni Toraldo 316cde4759 Add support for more http-related configs
* keycloak_quarkus_http_relative_path var now populate http-relative-path config [breaking change]
* http-relative-path defaults to / [breaking change]
* enable configuration of hostname-url and hostname-admin-url
2023-11-07 10:20:01 +01:00
Guido GrazioliandGitHub 92639e40cb Merge pull request #124 from jacobdotcosta/issue-57
feat: jboss port offset configuration
2023-11-06 16:03:02 +01:00
A.CandGitHub 027ac1a78e Merge branch 'main' into issue-57 2023-11-06 15:10:05 +01:00
Antonio Costa 5543217c6a rebase for changes made in PR 120 2023-11-06 15:02:28 +01:00
Guido GrazioliandAntonio Costa 61730b981b ddisable new test 2023-11-06 15:02:28 +01:00
Guido GrazioliandAntonio Costa 03175e283b molecule test for keycloakx with proxy 2023-11-06 15:02:28 +01:00
FooturandAntonio Costa 62e5380d38 Update Keycloak to version 22.0.5 2023-11-06 15:02:28 +01:00
Antonio Costa a538828f0d feat: add a destination variable for the log link
docs: argument specs for the keycloak_quarkus_log_target

docs: added parameter to the roles README

fix: role variable is keycloak_log_target and not keycloak_quarkus_log_target
2023-11-06 15:02:25 +01:00
Guido GrazioliandAntonio Costa 12147b4769 linter 2023-11-06 15:01:39 +01:00
Guido GrazioliandGitHub cad87557d6 Merge pull request #121 from guidograzioli/quarkus_rev_proxy_test
internal: molecule test for keycloakx with proxy
2023-11-03 11:16:10 +01:00
Guido Grazioli 363c5d9f9e ddisable new test 2023-11-03 10:58:25 +01:00
Guido GrazioliandGitHub 19a2013fa8 Merge pull request #122 from Footur/update-keycloak
Update Keycloak to version 22.0.5
2023-11-03 10:56:18 +01:00
Guido GrazioliandGitHub b819c98ab3 Merge pull request #120 from jacobdotcosta/issue-79
feat: add a destination variable for the log link
2023-11-03 10:55:21 +01:00
Antonio Costa 9ddd6d7d5e feat: jboss port offset configuration 2023-10-30 09:27:30 +01:00
Footur 6f26fa3da4 Update Keycloak to version 22.0.5 2023-10-27 15:32:15 +02:00
Antonio Costa 6970236201 feat: add a destination variable for the log link
docs: argument specs for the keycloak_quarkus_log_target

docs: added parameter to the roles README

fix: role variable is keycloak_log_target and not keycloak_quarkus_log_target
2023-10-26 09:18:07 +02:00
Guido Grazioli e5f0a3efe1 molecule test for keycloakx with proxy 2023-10-25 18:51:49 +02:00
Guido Grazioli 41c1306602 linter 2023-10-25 18:20:03 +02:00
Guido GrazioliandGitHub c67b301f97 Merge pull request #118 from gionn/fixup-molecule-hera
Do not require hosts edit for running quarkus molecule suite locally
2023-10-16 16:41:07 +02:00
Giovanni ToraldoandGitHub d945c51172 apply review suggestions 2023-10-16 15:52:04 +02:00
Guido GrazioliandGitHub d6c57a17a8 Merge pull request #117 from Footur/update-keycloak
Update Keycloak to version 22.0.4
2023-10-16 15:29:29 +02:00
Guido Grazioli bf1cb3695e Update minimum ansible-core version > 2.14 2023-10-16 15:27:24 +02:00
Giovanni Toraldo 307eee771f Do not require hosts edit for running quarkus molecule suite 2023-10-16 12:59:44 +02:00
Footur e842462a22 Enable config of a key store and trust store 2023-10-13 16:30:58 +02:00
Footur 0f7bbc7ef9 Update Keycloak to version 22.0.4 2023-10-13 16:24:46 +02:00
ansible-middleware-core 00e6cb6b0e Bump version to 1.3.1 2023-09-25 10:57:25 +00:00
ansible-middleware-core dded412bd0 Update changelog for release 1.3.0
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2023-09-25 10:56:54 +00:00
Guido GrazioliandGitHub 5b70d3db2a Merge pull request #113 from gionn/fix-port-restart
Fix validation failure upon port configuration change
2023-09-25 11:56:11 +02:00
Giovanni ToraldoandGitHub e3ce4bd574 fixup linter 2023-09-23 18:38:49 +02:00
Guido GrazioliandGitHub af0dc3c5f1 Merge pull request #112 from Footur/keycloak-update-22.0.3
keycloak_quarkus: Update Keycloak to version 22.0.3
2023-09-22 18:38:53 +02:00
Giovanni Toraldo f3104285bc Enforce service restart when needed before service checking 2023-09-22 16:30:16 +02:00
footur cb25c28bb8 Update Keycloak to version 22.0.3 2023-09-22 15:42:06 +02:00
Guido Grazioli 3bb32ed075 ci: update release wf 2023-09-21 12:33:29 +02:00
Guido GrazioliandGitHub 80e4df8dce Merge pull request #111 from gionn/fix-108
Fix admin login redirect when running locally
2023-09-19 19:23:39 +02:00
Giovanni Toraldo 194101f010 add new playbook example for localhost quarkus 2023-09-19 17:14:17 +02:00
Giovanni Toraldo f0f90b8930 apply review suggestions 2023-09-19 17:05:00 +02:00
Giovanni Toraldo 38ff519624 update arguments 2023-09-19 14:00:15 +02:00
Giovanni Toraldo 9c361c9628 add in README 2023-09-19 13:56:51 +02:00
Giovanni Toraldo 9a46b455f6 Fix admin login redirect when running locally 2023-09-19 13:53:32 +02:00
Guido GrazioliandGitHub aa7902b9c3 Merge pull request #110 from guidograzioli/molecule_quarkus_devmod
Add molecule quarkus keycloak in dev-mode test
2023-09-19 12:39:25 +02:00
Guido Grazioli 0f17e09731 add new test to CI 2023-09-19 12:25:38 +02:00
Guido Grazioli 942b5fce0f add molecule quarkus keycloak in dev-mode test 2023-09-19 12:23:34 +02:00
Guido GrazioliandGitHub bef20b6a57 Merge pull request #109 from msherman13/feature/msherman/quarkus_none_proxy
keycloak_quarkus: skip proxy config if `keycloak_quarkus_proxy_mode` is `none`
2023-09-19 10:46:24 +02:00
Miles Sherman d673fcf48a update documentation for change to keycloak_quarkus_proxy_mode handling 2023-09-18 17:21:45 +00:00
Miles Sherman b72460e464 quarkus role: do not populate proxy to config if keycloak_quarkus_proxy_mode is undefined or set to 'none' 2023-09-18 14:46:56 +00:00
Guido Grazioli 6c65fadf31 Bump version to 1.3.0 2023-08-30 11:13:17 +02:00
Guido GrazioliandGitHub d12f62b89d Merge pull request #106 from schmaxit/main
Run service as `keycloak_service_user`
2023-08-30 11:07:25 +02:00
Guido Grazioli 7bb9647d0d update systemd unit to use standalone.sh directly 2023-08-30 10:58:37 +02:00
Guido Grazioli 0199e554b5 overridexml test uses runas feature 2023-08-30 10:16:41 +02:00
Massimo SchiavonandGitHub 276444ce0e Add default for keycloak_service_runas 2023-08-29 22:02:18 +02:00
Massimo Schiavon 40c015d3e1 always create pidfile folder
add keycloak_service_runas feature flag
fix previous installs permissions
2023-08-29 21:41:38 +02:00
github-actions df7fab8f41 Bump version to 1.2.9 2023-08-28 15:56:38 +00:00
github-actions 6330f08b28 Update changelog for release 1.2.8
Signed-off-by: github-actions <ggraziol@redhat.com>
2023-08-28 15:55:52 +00:00
Guido Grazioli 5c8d7d9554 ci: update release workflow 2023-08-28 17:45:52 +02:00
Guido GrazioliandGitHub 2513ac2c43 Merge pull request #107 from Footur/keycloak-update-22.0.1
Update Keycloak to version 22.0.1
2023-08-28 08:59:53 +02:00
footur 6e6bf2ff71 Fix JRE version in README 2023-08-27 21:57:25 +02:00
Guido Grazioli 11621516e3 update workflows 2023-08-25 11:40:27 +02:00
footur 7c05ee5239 Update Keycloak to version 22.0.1 2023-08-25 11:38:45 +02:00
Guido Grazioli 5251826477 ci: update workflows 2023-08-24 13:57:38 +02:00
Guido Grazioli 0783000849 ci: update workflows 2023-08-24 13:53:22 +02:00
Guido Grazioli ca2dbe78c2 ci: update workflows 2023-08-24 13:46:50 +02:00
Guido Grazioli 52d9286ea3 ci: update workflows 2023-08-24 13:20:49 +02:00
Massimo Schiavon c8ebbe72d2 change default pidfile location
Signed-off-by: Massimo Schiavon <schmaxit@users.noreply.github.com>
2023-08-09 09:31:47 +02:00
Massimo SchiavonandGitHub 91ec411699 create pidfile folder if needed 2023-08-08 17:49:43 +02:00
Massimo SchiavonandGitHub 07b1c514bb Add User and Group directives in systemd unit file 2023-08-08 16:52:23 +02:00
Guido GrazioliandGitHub 345c50fb85 Merge pull request #105 from JoelKle/JoelKle-patch-1
Update bindep.txt package python3-devel to support RHEL9
2023-08-08 15:30:30 +02:00
JoelandGitHub db0aafd465 Update bindep.txt to support RHEL9
On RHEL9 the rpm package `python39-devel` doesn't exists. The real name is `python3-devel`.
2023-08-08 11:05:25 +02:00
Guido GrazioliandGitHub b950cdb8b4 Merge pull request #103 from guidograzioli/quarkus_java_17
keycloak_quarkus: set openjdk 17 as default
2023-07-31 10:48:26 +02:00
Guido Grazioli 5b01123846 fix verify for molecule default scenario 2023-07-31 10:39:47 +02:00
Guido Grazioli 84d6e7baca set java-17 for keycloak_quarkus 2023-07-31 10:29:28 +02:00
Guido GrazioliandGitHub ea735ea79e Merge pull request #100 from Footur/keycloak-update-22.0.0
Update keycloak_quarkus to Keycloak version 22.0.0
2023-07-31 09:50:38 +02:00
Guido GrazioliandGitHub 9db1cbd564 Merge pull request #91 from schmaxit/main
Undefine `keycloak_db_valid_conn_sql` default
2023-07-31 09:22:01 +02:00
Guido GrazioliandGitHub 7933592725 Revert README.md 2023-07-31 09:19:47 +02:00
Guido GrazioliandGitHub 3170af8b2b Merge pull request #102 from guidograzioli/bugzilla_2224411
fix_java_11_tzdata
2023-07-31 09:17:34 +02:00
Guido Grazioli f400a5bbf8 fix_java_11_tzdata 2023-07-31 09:01:54 +02:00
Guido Grazioli 5385fbb8e9 ci: update molecule 2023-07-31 08:40:17 +02:00
Guido Grazioli 7fea211639 ci: update molecule 2023-07-31 08:38:36 +02:00
Guido Grazioli 8738240a24 docs: add missing param in defaults comment 2023-07-28 09:57:37 +02:00
footur f195d164d1 Enable Ansible verbosity in the CI test 2023-07-14 13:21:27 +02:00
footur 7c4d420fea Update Keycloak to version 22.0.0 2023-07-14 11:36:54 +02:00
Massimo SchiavonandGitHub d45071bf58 Merge branch 'ansible-middleware:main' into main 2023-07-03 09:54:47 +02:00
Guido GrazioliandGitHub 10876ba615 Merge pull request #99 from Footur/update-keycloak
Update the Keycloakx version in the README
2023-06-23 15:20:36 +02:00
Guido GrazioliandGitHub f3815403c8 Merge pull request #98 from world-direct/fix/missing_if
Fix #97 - proper checks for keycloak_jgroups_subnet
2023-06-23 15:18:20 +02:00
FooturandGitHub 18d686b43a Merge branch 'ansible-middleware:main' into update-keycloak 2023-06-23 12:36:16 +02:00
footur 26a9249d07 Update the Keycloakx version in the README 2023-06-23 12:32:35 +02:00
Helmut Wolf fae3079751 Fix #97 - proper checks for keycloak_jgroups_subnet 2023-06-23 11:40:15 +02:00
Guido Grazioli a82e654cc4 Bump to 1.2.8 2023-06-19 17:26:15 +02:00
github-actions cebec9c717 Update changelog for release 1.2.7 2023-06-19 15:23:06 +00:00
Guido GrazioliandGitHub ad59cd8cb3 Merge pull request #95 from guidograzioli/aap_11169
add certified collection notice
2023-06-19 17:05:12 +02:00
Guido Grazioli 926353f395 add certified collection notice 2023-06-19 16:41:35 +02:00
Guido GrazioliandGitHub fed86ac0c3 Merge pull request #92 from Footur/update-keycloak
Update keycloakx to v21.1.1
2023-06-19 11:15:16 +02:00
footur 5f1f8b5762 [CI] Use ansible-lint in v6.17.0 2023-06-17 13:16:10 +02:00
FooturandGitHub bab3069712 Merge branch 'ansible-middleware:main' into update-keycloak 2023-06-16 10:20:56 +02:00
footur fc6e00974d Define the varbosity of Ansible in Molecule 2023-06-16 10:19:31 +02:00
footur 83525dbed0 Update the Keycloakx version in Molecule 2023-06-16 10:15:59 +02:00
Guido Grazioli 7ec695ee15 Fix wrong task message 2023-06-10 19:27:48 +02:00
Guido Grazioli 14e7b402b7 fix typo in templates 2023-06-10 18:37:58 +02:00
Guido GrazioliandGitHub 832432b86c Merge pull request #93 from guidograzioli/override_jgroups_subnet_match
Allow to override jgroups subnet
2023-06-10 16:47:36 +02:00
Guido Grazioli 8f697f6a53 Bump to 1.2.7 2023-06-10 16:45:13 +02:00
Guido Grazioli 1dd579a6d1 Allow to override jgroups subnet 2023-06-10 16:31:19 +02:00
footur 3340428194 Remove the "--auto-build" flag – it's deprecated
Signed-off-by: footur <3769085+Footur@users.noreply.github.com>
2023-06-10 15:18:31 +02:00
footur 18e60daa93 Update Keycloakx to v21.1.1
Signed-off-by: footur <3769085+Footur@users.noreply.github.com>
2023-06-10 15:16:58 +02:00
Massimo SchiavonandGitHub 874215a592 remove empty string default for keycloak_db_valid_conn_sql
rely on defaults set in keycloak_jdbc dict
2023-06-09 10:51:13 +02:00
github-actions 97bea7ba39 Update changelog for release 1.2.6 2023-06-07 12:29:15 +00:00
Guido Grazioli e99a0db174 Add missing type conversion in templates 2023-06-07 12:25:58 +02:00
Guido GrazioliandGitHub 3b03c54fed Merge pull request #90 from guidograzioli/background-validation-millis
handle WFLYCTL0117 when validation_millis is 0
2023-06-07 11:56:55 +02:00
Guido Grazioli ced4ce7828 handle WFLYCTL0117 when validation_millis is 0 2023-06-07 11:56:12 +02:00
Guido Grazioli 6986190159 Bumo to v1.2.6 2023-06-01 10:27:46 +02:00
Guido GrazioliandGitHub db480d0bc9 Merge pull request #88 from world-direct/feature/improve_service_restart_behavior
Improve service restart behavior configuration
2023-06-01 10:18:26 +02:00
Helmut Wolf bc4cb5c52a Introduce keycloak_service_restart_always alongside keycloak_service_restart_on_failure 2023-05-31 20:29:24 +02:00
Guido GrazioliandGitHub 8f042d3e29 Merge pull request #89 from schmaxit/main
Change xa_datasource_class value for mariadb jdbc configuration
2023-05-31 17:24:53 +02:00
Guido GrazioliandGitHub 24eaacc1ac Merge pull request #87 from world-direct/feature/profiles
Keycloak: add feature enabling/disabling
2023-05-31 17:19:08 +02:00
Helmut Wolf 623db426e0 Keycloak: add feature enabling/disabling 2023-05-31 16:41:57 +02:00
Massimo SchiavonandGitHub b77c166945 change xa_datasource_class for mariadb jdbc configuration 2023-05-31 11:12:24 +02:00
github-actions b7eef6a720 Update changelog for release 1.2.5 2023-05-26 21:00:15 +00:00
Guido GrazioliandGitHub 203e6c06ac Merge pull request #86 from guidograzioli/admin_url
Allow to configure administration endpoint URL
2023-05-26 19:46:59 +02:00
Guido Grazioli aaae1d1129 Allow to configure admin_url 2023-05-26 16:31:13 +02:00
Guido GrazioliandGitHub cca20a067d Merge pull request #85 from guidograzioli/datasource_validation
Add configuration for database connection pool validation
2023-05-26 16:09:51 +02:00
Guido Grazioli 2be35f9a67 typo in readme 2023-05-26 14:28:52 +02:00
Guido Grazioli 19f1750a33 Add db pool validation configuration 2023-05-25 11:47:19 +02:00
Guido GrazioliandGitHub c3d8bbc94e Merge pull request #84 from guidograzioli/hostname_spi
Allow to force backend URLs to frontend URLs
2023-05-25 11:34:37 +02:00
Guido Grazioli c4b4be3c3b add variable for force_frontend_url 2023-05-25 11:10:18 +02:00
Guido Grazioli 98e1633c43 ci: new linter rules take 2 2023-05-22 16:24:28 +02:00
Guido Grazioli fd375a141d ci: update linter settings, fix new linter issues 2023-05-22 16:12:25 +02:00
Guido GrazioliandGitHub 0cf7b3ac49 Merge pull request #81 from world-direct/fix/80
Close #80 - introduce systemd restart behavior
2023-05-22 15:41:30 +02:00
Helmut Wolf 370d424b24 Close #80 - introduce systemd restart behavior 2023-05-22 11:30:11 +02:00
Guido Grazioli 01fd2cc4fd Bump to 1.2.5 2023-05-09 16:44:16 +02:00
github-actions 7471e07921 Update changelog for release 1.2.4 2023-05-09 13:49:15 +00:00
Guido GrazioliandGitHub e8e0f6718b Merge pull request #78 from world-direct/fix/74
Close #74 - add `sqlserver` support to keycloak role
2023-05-09 15:31:01 +02:00
Guido Grazioli e4811221be ci: fix release wf, bump to 1.2.4 2023-05-09 15:25:41 +02:00
Guido GrazioliandGitHub 6cb4aac556 Merge pull request #77 from world-direct/fix/76
Close #76 - Keycloak role: fix deprecation warning for `ipaddr`
2023-05-09 15:14:07 +02:00
Helmut Wolf aad373a8e9 Close #74 - add sqlserver support to keycloak role 2023-05-09 13:14:42 +02:00
Helmut Wolf fd0a4e4492 Close #76 - Keycloak role: fix deprecation warning for ipaddr 2023-05-09 11:45:25 +02:00
Guido Grazioli 706677910b ci: update apt before installing hub 2023-05-05 11:07:42 +02:00
Guido Grazioli a3bffe9401 Bump to 1.2.3 2023-05-03 15:23:46 +02:00
Guido Grazioli f566917bc2 ci: rename galaxy tag 2023-05-03 08:54:20 +02:00
Guido Grazioli 44ad3b8e6d add galaxy tag 2023-05-02 18:05:12 +02:00
Guido Grazioli 1a450ea1d7 ci: add galaxy tags 2023-05-02 17:00:26 +02:00
Guido GrazioliandGitHub b0a01a8e46 Merge pull request #73 from jonathanspw/main
add configurability for XA transactions
2023-04-24 16:48:20 +02:00
Jonathan WrightandGitHub 020bc86955 document keycloak_quarkus_transaction_xa_enabled 2023-04-24 08:52:36 -05:00
Jonathan WrightandGitHub d72d46c945 fix typo 2023-04-24 08:50:16 -05:00
Jonathan Wright c7d2bdcee3 add configurability for XA transactions 2023-04-21 15:12:59 -05:00
Guido Grazioli 43d978370d bump to 1.2.2 2023-04-14 15:50:48 +02:00
Guido GrazioliandGitHub 3d37def38d Merge pull request #71 from guidograzioli/downstream_offline_patching_fix
Fix undefined facts when offline patching sso
2023-04-14 15:31:13 +02:00
Guido Grazioli 8d16e241c1 fix undefined facts when offline patching sso 2023-04-14 14:58:40 +02:00
Guido Grazioli 6ac0c18842 fix: drop xml element not available in 7.6 2023-04-12 11:12:32 +02:00
Guido Grazioli 6334daf244 ci: fix typo and indent for TCPPING discovery 2023-04-12 10:59:21 +02:00
github-actions 87ad97d57f Update changelog for release 1.2.1 2023-04-11 07:07:07 +00:00
Guido Grazioli 242b1cea0a version bump to 1.2.1 2023-04-01 12:20:29 +02:00
Guido GrazioliandGitHub c0b72b6890 Merge pull request #69 from guidograzioli/keycloak_realm_attrs
Pass attributes to realm clients
2023-04-01 12:20:06 +02:00
Guido Grazioli 1cfa229a5f Pass attributes to realm clients 2023-04-01 11:45:40 +02:00
Guido GrazioliandGitHub f013a99832 Merge pull request #68 from guidograzioli/ha_internal_infinispan
Allow to setup keycloak HA cluster without remote cache store
2023-04-01 10:34:00 +02:00
Guido Grazioli 6bfe046f5e fix templates path 2023-04-01 10:13:01 +02:00
Guido Grazioli 526f64e5eb standalone ha without remote store 2023-04-01 10:06:03 +02:00
Guido Grazioli a2c17f545e docs: downstream hide build status 2023-03-29 10:32:14 +02:00
Guido Grazioli 40c29d07b8 ci: update main README.md 2023-03-24 15:19:28 +01:00
Guido Grazioli 91a18bf571 ci: downstream test offline/online handling 2023-03-17 11:43:34 +01:00
Guido Grazioli ecb6cbb9bf ci: downstream test asset management 2023-03-17 11:25:40 +01:00
github-actions 05dccdaf3b Update changelog for release 1.2.0 2023-03-16 14:21:04 +00:00
Guido Grazioli 398c3c478e docs: use role, not name, in sample keycloak_realm playbook 2023-03-15 18:05:01 +01:00
Guido Grazioli ed24ca637a docs: update sample keycloak_realm playbook 2023-03-15 17:56:08 +01:00
Guido Grazioli 23ce09d595 sso: remove conditional on apply_patches 2023-03-15 17:23:04 +01:00
Guido Grazioli 59b69a6592 Downstream patching: add missing becomes 2023-03-10 15:38:56 +01:00
Guido Grazioli bf89b1895a minor fixes to downstream rhn install/patch download 2023-03-10 15:22:15 +01:00
Guido Grazioli 2ce7104077 ci: docs need ansible-core 2.14 2023-03-10 14:34:12 +01:00
Guido GrazioliandGitHub d438648e39 Merge pull request #64 from guidograzioli/runtimes_common_patching
Switch to middleware_automation.common for rh-sso patching
2023-03-10 12:23:34 +01:00
Guido Grazioli 49566455d6 add missing file 2023-03-10 11:59:14 +01:00
Guido Grazioli 1f2a88982d linter 2023-03-10 11:54:37 +01:00
Guido Grazioli a554736246 Use middleware_automation.common for rh-sso patching 2023-03-10 11:52:02 +01:00
Guido GrazioliandGitHub 7bbe5ae386 Merge pull request #63 from guidograzioli/runtimes_common
Switch middleware_automation.redhat_csp_download for middleware_automation.common
2023-03-08 17:57:34 +01:00
Guido Grazioli 7c9cc7ce36 remove non-printing chars from arg_specs 2023-03-08 17:40:03 +01:00
Guido Grazioli ce18c91b67 revert downstream playbook rename 2023-03-08 17:32:32 +01:00
Guido Grazioli d15324c1c8 fix indent typo 2023-03-08 17:00:38 +01:00
Guido Grazioli 527d3eb264 Fix typo 2023-03-08 16:02:54 +01:00
Guido Grazioli ccf773057b Replace main download 2023-03-08 15:58:25 +01:00
Guido Grazioli e530ccdc31 Replace metadata 2023-03-08 15:58:09 +01:00
Guido GrazioliandGitHub 6852871aeb Merge pull request #62 from guidograzioli/jgroups
Allow to configure TCPPING for discovery
2023-03-08 15:30:31 +01:00
Guido Grazioli 68bcff36f6 only try to create cluster node list when tcpping is selected 2023-03-08 14:59:55 +01:00
Guido Grazioli a7c9304c68 fix typo 2023-03-08 11:06:01 +01:00
Guido Grazioli 6e9a17bbf5 initial tcpping support 2023-03-08 09:23:34 +01:00
Guido GrazioliandGitHub 0052025917 Merge pull request #61 from guidograzioli/drop_community_general
Drop community.general from dependencies
2023-03-08 08:51:31 +01:00
Guido Grazioli 7050dafcbd add doc_fragments 2023-03-07 18:01:02 +01:00
Guido Grazioli 65e4b3b813 add hardforked modules 2023-03-07 17:56:05 +01:00
Guido Grazioli 00ae087732 drop community.general from tasks/meta 2023-03-07 17:07:27 +01:00
Guido GrazioliandGitHub e15ebd3233 Merge pull request #60 from guidograzioli/modcluster_proxy_list
Provide config for multiple modcluster proxies
2023-03-07 15:51:55 +01:00
Guido Grazioli d27d15efa9 modcluster proxies string wants space-separated list 2023-03-07 14:16:44 +01:00
Guido Grazioli 41eed509ea add modcluster testing to default scenario 2023-03-07 12:51:16 +01:00
Guido Grazioli 0d2624cfff linter: role arg_specs dont support removed_in_version and removed_from_collection 2023-03-07 12:30:29 +01:00
Guido Grazioli f980d4d1e1 Provide config for multiple modcluster proxies 2023-03-07 12:21:50 +01:00
Guido Grazioli 2959cb3cf0 Bump to 1.2.0 2023-03-07 08:10:42 +01:00
github-actions 821c256f04 Update changelog for release 1.1.1 2023-03-07 07:05:59 +00:00
Guido Grazioli 7abdd83ea4 ci: linter 2023-03-03 10:54:50 +01:00
Guido GrazioliandGitHub 007094ab5b Merge pull request #53 from bbarun/patch-1
Update keycloak.conf.j2
2023-03-03 10:41:58 +01:00
Božo BarunandGitHub 5cdaa7aabb Update keycloak.conf.j2
The documentation states that the path is relative to the /conf directory, which is true. So if one changes the contents of this file it would have no effect because the path would be non-existent. To make things worse, there would be no obvious error stating this and the configuration would be loaded from the defaults.
2023-01-26 15:27:57 +01:00
Guido Grazioli 808b944f19 Bump to v1.1.1 2023-01-09 09:46:47 +01:00
github-actions ae95d69435 Update changelog for release 1.1.0 2023-01-09 08:36:24 +00:00
Guido GrazioliandGitHub 73d7a46307 Merge pull request #51 from ansible-middleware/tweak_start_retries_and_delay
Variables to override service start retries and delay
2023-01-02 07:46:05 +01:00
Romain Pelisse 9196b234b6 Add missing 'java' keywords to galaxy.yml 2022-12-29 12:40:21 +01:00
Romain Pelisse 46d5af90ba Allow overrides for service start retries and delay 2022-12-29 12:40:21 +01:00
Guido GrazioliandGitHub 8ed82d937c Merge pull request #50 from ansible-middleware/mol_one_req
molecule: centralize requirements
2022-12-21 07:07:13 +01:00
Guido Grazioli 842cb7bf23 molecule: update overridden template 2022-12-19 23:32:35 +01:00
Guido Grazioli cd1c2ae3e7 keycloak: switch http-invoker from security-realm to http-authentication-factory 2022-12-19 23:09:43 +01:00
Guido Grazioli 2a219222bc Add missing ejb application-security-domain 2022-12-19 22:23:45 +01:00
Guido Grazioli ab3247fc3b docs: update resources 2022-12-19 12:08:05 +01:00
Romain Pelisse 320f167bea molecule: centralize requirements 2022-12-19 08:56:25 +01:00
Guido Grazioli 5563317718 ci: update overridexml molecule override template 2022-12-16 16:28:11 +01:00
Guido GrazioliandGitHub e209507a3f Merge pull request #46 from guidograzioli/keycloak_19
Update keycloak to 18.0.2 - sso to 7.6.1
2022-12-16 12:51:39 +01:00
Guido GrazioliandGitHub b9560458d8 Merge branch 'main' into keycloak_19 2022-12-15 15:50:29 +01:00
Guido Grazioli d7829f77df update sso version in molecule tests 2022-12-15 15:47:12 +01:00
Guido GrazioliandGitHub e17fda2da9 Merge pull request #47 from ansible-middleware/no_log
allows user to switch no_log to True for debugging purpose
2022-12-15 15:33:10 +01:00
Guido Grazioli 34cab23abe update configuration templates 2022-12-15 15:32:33 +01:00
Guido Grazioli 7c8db06378 set keycloak to 18.0.2, sso to 7.6.1 2022-12-15 14:38:04 +01:00
Romain Pelisse 699ab1a5c4 allows user to switch no_log to True for debugging purpose 2022-12-15 14:36:31 +01:00
Guido Grazioli 007464d6b3 Update keycloak to 19.0.3 2022-12-13 15:53:53 +01:00
Guido Grazioli 2054082b40 get rid of rhn_ids dict 2022-12-13 15:31:08 +01:00
Guido GrazioliandGitHub 9157f83f96 Merge pull request #45 from generalpax/patch-1
keycloak_quarkus: variable to enable development mode
2022-12-13 15:23:46 +01:00
Guido Grazioli 6e4b224fe1 molecule: quarkus update verify urls 2022-12-13 15:07:11 +01:00
Guido Grazioli 2594fd9186 update molecule scenario 2022-12-13 14:48:12 +01:00
Guido Grazioli 853d4ab96b rebase and update documentation 2022-12-13 14:28:17 +01:00
KatzyandGuido Grazioli 2df5fd22cf Update main.yml 2022-12-13 14:25:52 +01:00
KatzyandGuido Grazioli 422986a8fd Enable this role to start keycloak in dev mode 2022-12-13 14:25:52 +01:00
KatzyandGuido Grazioli ad4d5dae68 Update keycloak.service.j2 2022-12-13 14:25:52 +01:00
KatzyandGuido Grazioli e624870e38 Fix hardcoded health_url to parameterized 2022-12-13 14:25:52 +01:00
Guido Grazioli 63dc369148 Add missing deps declarations 2022-12-13 12:31:03 +01:00
Guido Grazioli f4fe9df97c ci: add noqa to commands 2022-12-13 11:49:36 +01:00
Guido Grazioli b3b016bf3b Drop deprecated builtin.command arg 2022-12-13 11:39:57 +01:00
Guido Grazioli 3d0cfc9e42 ci: add bogus lint rule to warnings 2022-12-13 11:28:56 +01:00
Guido Grazioli 89fa82eddb ci: add new docs reqs 2022-12-13 11:27:18 +01:00
Guido Grazioli c0d4c6211e ci: drop --docker from ansible-test sanity 2022-12-13 11:24:28 +01:00
Guido Grazioli bdc1ad8b51 Add validation of realm client and id 2022-12-13 11:20:51 +01:00
Guido Grazioli db111aaf3a add fqcn to firewalld tasks 2022-12-13 10:50:53 +01:00
Guido Grazioli ab1c06a2e8 ci: set new ansible rule as warning 2022-10-19 17:27:00 +02:00
Guido GrazioliandGitHub c8a2283cc6 Merge pull request #44 from kabroxiko/patch-1
keycloak_quarkus: fix /var/log/keycloak symlink to keycloak log directory
2022-10-19 17:25:10 +02:00
kabroxikoandGitHub bea5062287 fix: Wrong file location
Fix:

Wrong quarkus log link and folder creation.

Replace:
keycloak -> /opt/keycloak/keycloak-19.0.2//opt/keycloak/keycloak-19.0.2/data/log

For:
keycloak -> /opt/keycloak/keycloak-19.0.2/data/log
2022-10-08 21:05:49 -03:00
Guido Grazioli 65da436d74 restart handler: orchestrate 2022-09-28 16:48:40 +02:00
Guido Grazioli be582171ce restart handler: orchestrate 2022-09-28 16:30:26 +02:00
Guido Grazioli a7fbce2990 New variable for binding of management ports 2022-09-28 15:33:30 +02:00
Guido Grazioli dfc1912a99 jdbc_driver: switch from uri to get_url 2022-09-27 15:36:14 +02:00
Guido Grazioli ec47a1c5a8 downstream: correctly interpolate defaults 2022-09-19 22:41:18 +02:00
Guido Grazioli 52e38f7398 Bump to 1.1.0 2022-09-19 22:10:03 +02:00
Guido Grazioli 69a8860551 Break dependency on wildfly/eap 2022-09-19 22:07:23 +02:00
Guido GrazioliandGitHub 9f8b1c6d76 Merge pull request #42 from guidograzioli/downstream_rename
Rename variables from `infinispan_` prefix to `keycloak_infinispan_`
2022-09-19 17:38:02 +02:00
Guido Grazioli 5e89139870 Downstream variables 2022-09-19 17:11:56 +02:00
Guido Grazioli 38b5a02e95 Rename infinispan_ vars to keycloak_infinispan_, prepare downstrea 2022-09-19 15:42:01 +02:00
Guido Grazioli 9b2ea35184 ci: linter, workflows, galaxy, molecule 2022-09-19 15:41:12 +02:00
Romain PelisseandPelisse Romain ded44b084d quarkus scenario skip part if hera is used 2022-08-03 09:15:44 +02:00
github-actions 1b1127ed91 Update changelog for release 1.0.7 2022-07-06 12:10:08 +00:00
Guido GrazioliandGitHub 9252433cc8 Merge pull request #39 from xabarin-forks/use_absolute_path_for_certs
keycloak_quarkus: use absolute path for certificate files
2022-07-05 14:06:02 +02:00
Xabier Davila adb0a4da45 Fix molecule tests 2022-07-04 08:31:10 +02:00
Xabier Davila 41caa49cfc Use absolute path for certificate files 2022-07-01 10:31:18 +02:00
Guido GrazioliandGitHub d47e045f5e Merge pull request #38 from xabarin-forks/use_sudo_for_tasks_that_need_it
Use become for tasks that will otherwise fail
2022-06-30 16:43:11 +02:00
Xabier Davila 4baa61e0cf Use sudo for tasks that will otherwise fail 2022-06-30 16:15:48 +02:00
Guido Grazioli 065fb53eb2 Bump to 1.0.7 2022-06-01 17:33:29 +02:00
github-actions 713437343d Update changelog for release 1.0.6 2022-06-01 13:12:11 +00:00
Guido Grazioli 46f445560b Bump to 1.0.6 2022-05-31 19:10:20 +02:00
Guido GrazioliandGitHub 76cbb4c676 keycloak_quarkus: add https to molecule test setup (#36)
* keycloak_quarkus: add https to molecule test setup

* move converge pre_tasks to prepare phase

* Update zipfile unarchive to cater for existing certs
2022-05-31 12:07:18 -05:00
Guido GrazioliandGitHub 469036e9e7 keycloak_quarkus: set logfile path correctly under keycloak home (#35) 2022-05-31 03:47:29 -05:00
Guido GrazioliandGitHub 8454f5c341 keycloak_quarkus: add selected java to PATH in systemd unit (#34) 2022-05-31 03:43:55 -05:00
github-actions d5a63f55f9 Update changelog for release 1.0.5 2022-05-25 15:37:36 +00:00
Guido Grazioli 09a34567a7 Bump to 1.0.5, add EE setup ref 2022-05-19 09:38:47 +02:00
Harsha CherukuriandGitHub bc63cbf649 Merge pull request #32 from guidograzioli/config_options
Update config options: keycloak and quarkus
2022-05-18 13:53:26 -04:00
Guido Grazioli 281767f505 add missing variable spec 2022-05-18 10:05:34 +02:00
Guido Grazioli 8bede6791e update 18.0.0, add JAVA_HOME check, runas systemd unit 2022-05-18 09:29:28 +02:00
Guido Grazioli 0ddbc66448 Add keycloak X playbook, update roles README 2022-05-17 19:30:13 +02:00
Guido Grazioli 31420fc24c update config options: keycloak and quarkus 2022-05-17 18:59:10 +02:00
github-actions 2cc835219c Update changelog for release 1.0.4 2022-05-11 12:23:41 +00:00
Guido Grazioli 9e3cd22484 Bump to 1.0.4 2022-05-11 14:05:43 +02:00
Guido Grazioli 9278d3440e ci: linter version update fixes 2022-05-11 11:33:52 +02:00
Guido Grazioli 3b45c133b8 fix incorrect downloaded archive filemode 2022-05-11 10:38:52 +02:00
github-actions 95c346d4b3 Update changelog for release 1.0.3 2022-05-09 15:51:47 +00:00
Guido Grazioli f4674a8762 ci: release triggers with correct tag version 2022-05-09 17:34:19 +02:00
Guido Grazioli 3714145526 keycloak: fix jdbc assert 2022-05-09 17:26:20 +02:00
Guido Grazioli 4167edda63 ci: use tar creating token, allow dispatch of docs 2022-05-09 17:22:52 +02:00
Guido Grazioli 7d57857a1f ci: use github custom action 2022-05-09 16:00:00 +02:00
Guido Grazioli 8341416ee0 keycloak: default jvm to headless variant, add jdbc validation 2022-05-09 15:57:12 +02:00
Guido GrazioliandGitHub fbc0d7ab99 Merge pull request #31 from guidograzioli/ensure_java_home
Make sure systemd unit starts with selected java JVM
2022-04-28 15:05:45 +02:00
Guido Grazioli 78d5499abf fix: linter 2022-04-28 12:15:48 +02:00
Guido Grazioli 9987f6a044 update molecule test and verify for jvm 2022-04-28 11:33:40 +02:00
Guido Grazioli e3bb10d901 fix: ensure correct jvm java_home is set 2022-04-28 11:33:23 +02:00
Guido GrazioliandGitHub 7028b068b6 Merge pull request #30 from guidograzioli/custom_keycloak_template
Add `keycloak_config_override_template` parameter for passing custom xml configuration
2022-04-12 12:26:49 +02:00
Guido Grazioli 0751b97b87 Add custom xml parameter and test scenario 2022-04-12 12:07:06 +02:00
Guido GrazioliandGitHub 548db6fc4b Merge pull request #29 from guidograzioli/quarkus
New role for installing keycloak >= 17.0.0 (quarkus)
2022-04-11 14:03:47 +02:00
Guido Grazioli dc33cbc358 quarkus: add README, update parameters doc 2022-04-11 13:48:59 +02:00
Romain PelisseandPelisse Romain 9bb9816a01 Switch playbooks hosts to all 2022-04-11 10:50:22 +02:00
Guido Grazioli 33c8f74122 add molecule test for keycloak_quarkus 2022-04-07 14:07:45 +02:00
Guido Grazioli cf92da9e94 update keycloak_realm to test nicely with keycloak_quarkus 2022-04-07 14:07:28 +02:00
Guido Grazioli 419c862341 add role keycloak_quarkus 2022-04-07 14:07:08 +02:00
Guido Grazioli c7b6bc1d61 ci: docs wf uses custom action 2022-04-07 08:53:43 +02:00
Guido Grazioli a62f26648f bump version, use git describe for -devel changelogs 2022-04-04 17:35:22 +02:00
Guido Grazioli 29aaafb9e4 ci: changelogs skip unlabeled PRs 2022-04-01 21:41:52 +02:00
Guido Grazioli 9d57057272 docs: fix unbalanced quotes in release workflow 2022-04-01 13:23:10 +02:00
github-actions fddfa9a493 Update changelog for release 1.0.2 2022-04-01 10:57:28 +00:00
Guido Grazioli 5cbe905dda docs: restructuredtext link needs separator 2022-04-01 12:53:56 +02:00
Guido Grazioli 4e6ea2f1ca ci: release wf uses deep clone 2022-04-01 12:14:09 +02:00
Guido Grazioli 28ff78d809 docs: changelog pasted into github release page 2022-04-01 10:57:42 +02:00
Guido Grazioli 9365d38162 docs: add role index to toctree 2022-03-31 16:51:25 +02:00
Guido Grazioli d3f9b0ca86 docs: add PR link to previous releases 2022-03-31 16:12:04 +02:00
Guido Grazioli bada6f4073 docs: add changelog breaking_change type 2022-03-31 15:54:30 +02:00
Guido Grazioli b91c9e17fc docs: fix typo in href target generation 2022-03-31 15:40:16 +02:00
Guido Grazioli b974bf1967 docs: absolute links in READMEs 2022-03-31 15:30:23 +02:00
Guido Grazioli 9ee6788f98 docs: workaround unstaged file when checking out gh-pages 2022-03-31 15:13:30 +02:00
Guido Grazioli c166c643fc docs: set -devel version for main branch 2022-03-31 15:04:55 +02:00
Guido GrazioliandGitHub abd922417c Merge pull request #27 from guidograzioli/changelogs
docs: add changelogs
2022-03-31 14:58:23 +02:00
Guido Grazioli 5a45d1f4f8 add prerelease to docs wf, generate on release wf 2022-03-31 14:56:41 +02:00
Guido Grazioli 6091477294 ci: generate changelog fragments from PR messages 2022-03-30 17:49:03 +02:00
Guido Grazioli 63f31fe258 Add gitignore to ansible-test sanity excludes 2022-03-25 18:22:55 +01:00
Guido Grazioli fc780599b0 add antsibull generated changelog 2022-03-25 11:45:11 +01:00
Guido Grazioli 494a1c518b docs: add changelogs 2022-03-25 11:17:58 +01:00
Guido Grazioli f736ad5632 misc: switch default keycloak_rhsso_apply_patches to false 2022-03-25 10:11:22 +01:00
Guido GrazioliandGitHub b0a11013fa Merge pull request #25 from guidograzioli/keycloak_frontend_url_default
Set the frontend URL to play well with other defaults
2022-03-25 10:06:07 +01:00
Guido GrazioliandGitHub 10ff1763c1 Merge pull request #26 from guidograzioli/keycloak_admin_password_var
move admin pwd param from vars to defaults and assert
2022-03-25 09:57:21 +01:00
Guido Grazioli 85b0a2549a update tests with pwd, apply change to keycloak_realm 2022-03-25 00:34:41 +01:00
Guido Grazioli d854791183 set admin pass to valid length 2022-03-24 18:07:33 +01:00
Guido Grazioli a67081a68d move admin pwd param from vars to defaults, add assert 2022-03-24 17:44:13 +01:00
Guido Grazioli 8173be4b58 Set the frontend URL to play well with other defaults 2022-03-24 17:00:30 +01:00
Guido Grazioli 6270762a3a trigger EE rebuild when released 2022-03-23 15:42:41 +01:00
Guido Grazioli 5828c0a7bb fix: spelling 2022-03-23 12:30:32 +01:00
Guido Grazioli e773e12e24 use proper service name in task names 2022-03-17 10:45:55 +01:00
Guido GrazioliandPelisse Romain 33e80a0cd4 remove unused set_fact 2022-03-11 16:27:23 +01:00
Guido GrazioliandPelisse Romain bf26c727a8 misc: simply fastpackages logic and reduce play time 2022-03-11 16:27:23 +01:00
Guido Grazioli d5bf0a195a docs: fix typo 2022-03-11 15:31:48 +01:00
Guido Grazioli c5b38e8bac docs: add testing and releasing contributor pages 2022-03-11 15:15:18 +01:00
Guido Grazioli 266f2bc00b Bump to v1.0.1 2022-03-11 15:11:21 +01:00
Guido GrazioliandPelisse Romain cfdc043770 Update docs, fix patch apply steps and cli vars 2022-03-11 15:03:55 +01:00
Guido GrazioliandPelisse Romain 707d8cfb11 add rhsso_cli tasks, change shape of rhsso_rhn_ids 2022-03-11 15:03:55 +01:00
Guido GrazioliandGitHub f5cd6d8061 Merge pull request #17 from guidograzioli/replace_serial_with_runonce
Replace use of serial with run_once
2022-03-08 12:32:54 +01:00
Guido Grazioli b88c43933c Replace use of serial with run_once
run_once on first node when database config enabled (so the first
node creates the tables), then wakeup all other nodes
2022-03-08 12:08:40 +01:00
Guido Grazioli 0bc81cc781 chore: add build ignores / fix release tag names 2022-03-01 19:05:28 +01:00
Guido GrazioliandGitHub 60c5a42ae4 Merge pull request #16 from hcherukuri/main
Bump version to 1.0.0 to satisfy Automation hub
2022-03-01 19:00:38 +01:00
Harsha Cherukuri 2073c90e1d Bump version to 1.0.0 to statisfy Automation hub 2022-03-01 12:44:09 -05:00
Harsha CherukuriandGitHub ffd146d392 Merge pull request #15 from guidograzioli/fqcn-builtins
fix: use FQCN
2022-03-01 12:42:09 -05:00
Guido Grazioli 78f225b10c chore: reword collection tags not accepted by galaxy 2022-03-01 10:46:06 +01:00
Guido Grazioli b90684a44a fix: use FQCN 2022-02-24 15:00:10 +01:00
304 changed files with 43654 additions and 1303 deletions
+18 -3
View File
@@ -1,10 +1,14 @@
# .ansible-lint
profile: production
exclude_paths:
- .cache/
- .github/
- molecule/
- .ansible-lint
- .yamllint
- meta/
- playbooks/roles/
rulesdir:
- ../../ansible-lint-custom-rules/rules/
@@ -16,12 +20,23 @@ enable_list:
warn_list:
- role_vars_start_with_role_name
- vars_in_vars_files_have_valid_names
- vars_should_not_be_used
- experimental
- ignore-errors
- no-handler
- fqcn-builtins
- no-log-password
- jinja[spacing]
- jinja[invalid]
- meta-no-tags
- name[casing]
- fqcn[action]
- schema[meta]
- key-order[task]
- blocked_modules
- run-once[task]
skip_list:
- vars_should_not_be_used
- file_is_small_enough
- file_has_valid_name
use_default_rules: true
parseable: true
+104
View File
@@ -0,0 +1,104 @@
# Keycloak / Ansible domain-specific words
# Only terms NOT covered by built-in dictionaries
# Product names and projects
Infinispan
infinispan
Wildfly
wildfly
keycloak
# Red Hat product names
RHBK
rhbk
rhsso
# Java / JBoss terms
Djboss
Djgroups
Dsun
ispn
ISPN
jaegertracing
jaxrs
jberet
JDBCPING
jgroups
JGROUPSPING
jndi
keytool
MPING
NAKACK
passivation
passivating
slsb
sfsb
TCPPING
tcpping
jdbcx
cacerts
changeit
# Systemd directives
restartsec
runas
startlimitburst
systemdunit
# Ansible terms
fqcn
FQCN
# WildFly / JBoss terms
jbcs
modcluster
# Linux / System terms
firewalld
cgroupns
zgrep
# Configuration terms
xforwarded
PYTHONHTTPSVERIFY
# Keycloak-specific
ciba
clusterless
eddsa
multivalued
remembertochangeme
subcomponent
subcomponents
# Molecule / Testing
hspaans
# CI / DevOps
sangonzal
rootperm
# RST / Sphinx directives
toctree
# Task names / verbs
Reown
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
+8
View File
@@ -0,0 +1,8 @@
---
version: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
# Weekly keeps Actions dependency PRs current without daily CI load.
interval: weekly
+25
View File
@@ -0,0 +1,25 @@
---
# Partner Certification Checker workflow for Automation Hub requirements.
# See: https://github.com/ansible-collections/partner-certification-checker
name: Run collection certification checks
permissions:
contents: read
on:
pull_request:
branches: [main]
concurrency:
group: cert-ver-${{ github.head_ref || github.run_id }}
cancel-in-progress: true
# Files that are not related to the core functionality of your collection can
# cause Ansible Lint to fail. If this happens, add an .ansible-lint file that
# excludes those paths. See .ansible-lint in this repository.
#
# If there are sanity test failures that cannot be fixed, create a sanity ignore
# 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@fefb6b967e99964b55665b66ef0d8e4148d84aca # v5.0.0
+24 -38
View File
@@ -1,51 +1,37 @@
---
name: CI
"on":
on:
push:
branches:
- main
pull_request:
workflow_dispatch:
inputs:
debug_verbosity:
description: 'ANSIBLE_VERBOSITY envvar value'
required: false
schedule:
- cron: '15 6 * * *'
jobs:
ci:
spellcheck:
runs-on: ubuntu-latest
strategy:
matrix:
python_version: ["3.9"]
steps:
- name: Check out code
uses: actions/checkout@v2
uses: actions/checkout@v7
- name: Run cspell
uses: streetsidesoftware/cspell-action@v9
with:
path: ansible_collections/middleware_automation/keycloak
incremental_files_only: false
use_cspell_files: true
- name: Set up Python ${{ matrix.python_version }}
uses: actions/setup-python@v1
with:
python-version: ${{ matrix.python_version }}
- name: Install yamllint, ansible and molecule
run: |
python -m pip install --upgrade pip
pip install yamllint 'molecule[docker]~=3.5.2' ansible-core flake8 ansible-lint voluptuous
pip install -r ansible_collections/middleware_automation/keycloak/requirements.txt
- name: Install ansible-lint custom rules
uses: actions/checkout@v2
with:
repository: ansible-middleware/ansible-lint-custom-rules
path: ansible_collections/ansible-lint-custom-rules/
- name: Create default collection path
run: |
mkdir -p /home/runner/.ansible/collections/ansible_collections
- name: Run sanity tests
run: ansible-test sanity --docker -v --color --python ${{ matrix.python_version }}
working-directory: ./ansible_collections/middleware_automation/keycloak
- name: Run molecule test
run: molecule test --all
working-directory: ./ansible_collections/middleware_automation/keycloak
env:
PY_COLORS: '1'
ANSIBLE_FORCE_COLOR: '1'
ci:
uses: ansible-middleware/github-actions/.github/workflows/ci.yml@rootperm
secrets: inherit
with:
fqcn: 'middleware_automation/keycloak'
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", "quarkus_nohost" ]
+8 -65
View File
@@ -5,71 +5,14 @@ on:
branches:
- main
tags:
- "*.*.*"
env:
COLORTERM: 'yes'
TERM: 'xterm-256color'
PYTEST_ADDOPTS: '--color=yes'
- "[0-9]+.[0-9]+.[0-9]+"
workflow_dispatch:
jobs:
docs:
runs-on: ubuntu-latest
if: github.repository == 'ansible-middleware/keycloak'
permissions:
actions: write
checks: write
contents: write
deployments: write
packages: write
pages: write
steps:
- name: Check out code
uses: actions/checkout@v2
with:
path: ansible_collections/middleware_automation/keycloak
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: 3.9
- name: Install doc dependencies
run: |
python -m pip install --upgrade pip
pip install -r ansible_collections/middleware_automation/keycloak/docs/requirements.txt
pip install -r ansible_collections/middleware_automation/keycloak/requirements.txt
- name: Create default collection path
run: |
mkdir -p /home/runner/.ansible/collections/ansible_collections
- name: Create doc directories and resources
run: |
mkdir -p ./docs/plugins ./docs/roles
cat ./docs/roles.rst.template > ./docs/roles/index.rst
antsibull-docs collection --use-current --squash-hierarchy --dest-dir docs/plugins middleware_automation.keycloak
for role_readme in roles/*/README.md; do ln -f -s ../../$role_readme ./docs/roles/$(basename $(dirname $role_readme)).md; echo " * :doc:\`$(basename $(dirname $role_readme))\`" >> ./docs/roles/index.rst; done
working-directory: ansible_collections/middleware_automation/keycloak
- name: Run sphinx
run: |
sphinx-build -M html . _build -v
working-directory: ansible_collections/middleware_automation/keycloak/docs/
- name: Commit docs
run: |
git config user.name github-actions
git config user.email github-actions@github.com
git checkout gh-pages
rm -rf $(basename ${GITHUB_REF})
mv docs/_build/html $(basename ${GITHUB_REF})
ln --force --no-dereference --symbolic main latest
git show origin/main:docs/_gh_include/header.inc > index.html
(echo main; echo latest; dirname *.*.*/index.html | sort --version-sort --reverse) | xargs -I@@ -n1 echo '<li class="toctree-l1"><a class="reference internal" href="@@/">@@</a></li>' >> index.html
git show origin/main:docs/_gh_include/footer.inc >> index.html
git add $(basename ${GITHUB_REF}) latest index.html
git commit -m "Update docs for $(basename ${GITHUB_REF})" || true
git push origin gh-pages
working-directory: ansible_collections/middleware_automation/keycloak/
uses: ansible-middleware/github-actions/.github/workflows/docs.yml@main
secrets: inherit
with:
fqcn: 'middleware_automation/keycloak'
collection_fqcn: 'middleware_automation.keycloak'
historical_docs: 'false'
+31
View File
@@ -0,0 +1,31 @@
---
name: Publish collection
on:
workflow_dispatch:
jobs:
publish:
uses: ansible-middleware/github-actions/.github/workflows/publish.yml@main
with:
collection_fqcn: 'middleware_automation.keycloak'
downstream_name: 'rhbk'
secrets:
galaxy_token: ${{ secrets.ANSIBLE_GALAXY_API_KEY }}
jira_webhook: ${{ secrets.JIRA_WEBHOOK_CREATE_VERSION }}
push_token: ${{ secrets.TRIGGERING_PAT }}
dispatch:
needs: publish
if: needs.publish.result == 'success'
strategy:
matrix:
repo: ['ansible-middleware/ansible-middleware-ee']
runs-on: ubuntu-latest
steps:
- name: Repository Dispatch
uses: peter-evans/repository-dispatch@v4
with:
token: ${{ secrets.TRIGGERING_PAT }}
repository: ${{ matrix.repo }}
event-type: "Dependency released - Keycloak v${{ needs.publish.outputs.tag_version }}"
client-payload: '{ "github": ${{toJson(github)}} }'
+15 -48
View File
@@ -1,53 +1,20 @@
---
name: Release collection
on:
push:
tags:
- "*.*.*"
workflow_dispatch:
inputs:
release_summary:
description: 'Optional release summary for changelogs'
required: false
jobs:
release:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v1
with:
python-version: "3.x"
- name: Get Tag Version
id: get_version
run: echo ::set-output name=TAG_VERSION::${GITHUB_REF#refs/tags/}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install ansible-core
- name: Build collection
run: |
ansible-galaxy collection build .
- name: Publish Release
uses: softprops/action-gh-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
files: "*.tar.gz"
body: "Release ${{ steps.get_version.outputs.TAG_VERSION }}"
- name: Publish collection
env:
ANSIBLE_GALAXY_API_KEY: ${{ secrets.ANSIBLE_GALAXY_API_KEY }}
run: |
ansible-galaxy collection publish *.tar.gz --api-key $ANSIBLE_GALAXY_API_KEY
dispatch:
needs: release
strategy:
matrix:
repo: ['ansible-middleware/cross-dc-rhsso-demo', 'ansible-middleware/flange-demo']
runs-on: ubuntu-latest
steps:
- name: Repository Dispatch
uses: peter-evans/repository-dispatch@v1
with:
token: ${{ secrets.TRIGGERING_PAT }}
repository: ${{ matrix.repo }}
event-type: "Dependency released - Keycloak"
client-payload: '{ "github": ${{toJson(github)}} }'
uses: ansible-middleware/github-actions/.github/workflows/release.yml@main
with:
collection_fqcn: 'middleware_automation.keycloak'
downstream_name: 'rhbk'
release_summary: "${{ github.event.inputs.release_summary }}"
secrets:
galaxy_token: ${{ secrets.ANSIBLE_GALAXY_API_KEY }}
jira_webhook: ${{ secrets.JIRA_WEBHOOK_CREATE_VERSION }}
push_token: ${{ secrets.TRIGGERING_PAT }}
+26
View File
@@ -0,0 +1,26 @@
name: Collect traffic stats
on:
schedule:
- cron: "51 23 * * 0"
workflow_dispatch:
jobs:
traffic:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
with:
ref: "gh-pages"
- name: GitHub traffic
uses: sangonzal/repository-traffic-action@v.0.1.6
env:
TRAFFIC_ACTION_TOKEN: ${{ secrets.TRIGGERING_PAT }}
- name: Commit changes
uses: EndBug/add-and-commit@v11
with:
author_name: Ansible Middleware
message: "GitHub traffic"
add: "./traffic/*"
ref: "gh-pages"
+10
View File
@@ -2,9 +2,19 @@
*.zip
.tmp
.cache
.vscode/
__pycache__/
docs/plugins/
docs/roles/
docs/_build/
.pytest_cache/
.mypy_cache/
*.retry
changelogs/.plugin-cache.yaml
changelogs/fragments/*.yaml
changelogs/fragments/*.yml
*.pem
*.key
*.p12
.ansible/
+7 -2
View File
@@ -15,7 +15,8 @@ rules:
commas:
max-spaces-after: -1
level: error
comments: disable
comments:
min-spaces-from-content: 1
comments-indentation: disable
document-start: disable
empty-lines:
@@ -30,4 +31,8 @@ rules:
new-lines:
type: unix
trailing-spaces: disable
truthy: disable
truthy: disable
octal-values:
forbid-implicit-octal: true
forbid-explicit-octal: true
+688
View File
@@ -0,0 +1,688 @@
=============================================
middleware\_automation.keycloak Release Notes
=============================================
.. contents:: Topics
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
======
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>`_
v3.0.11
=======
Minor Changes
-------------
- Add certification checks to the upstream repo `#378 <https://github.com/ansible-middleware/keycloak/pull/378>`_
- Fix cert workflow `#389 <https://github.com/ansible-middleware/keycloak/pull/389>`_
- Fix health check URL to include HTTP relative path `#364 <https://github.com/ansible-middleware/keycloak/pull/364>`_
- fix(keycloak_quarkus): avoid leaking maven provider password in logs `#363 <https://github.com/ansible-middleware/keycloak/pull/363>`_
Bugfixes
--------
- AMW-592 AMW Github Actions are failing because of latest molecule `#366 <https://github.com/ansible-middleware/keycloak/pull/366>`_
- AMW-594 Upstream release is failing due to recent rules change `#373 <https://github.com/ansible-middleware/keycloak/pull/373>`_
v3.0.10
=======
Major Changes
-------------
- Fixing linting issues `#357 <https://github.com/ansible-middleware/keycloak/pull/357>`_
Minor Changes
-------------
- AMW-571 keycloak_identity_provider hide_on_login_page not working `#356 <https://github.com/ansible-middleware/keycloak/pull/356>`_
- Fixing vars naming issue `#359 <https://github.com/ansible-middleware/keycloak/pull/359>`_
- Removing from __future__ import annotations broke runtime type hints using Sequence and union syntax, causing sanity import failures and molecule module errors `#358 <https://github.com/ansible-middleware/keycloak/pull/358>`_
v3.0.9
======
Bugfixes
--------
- AMW-551 Providing correct rhbk version `#344 <https://github.com/ansible-middleware/keycloak/pull/344>`_
v3.0.8
======
v3.0.7
======
Major Changes
-------------
- Migrate Keycloak modules from the community.general collection to Keycloak collection. `#341 <https://github.com/ansible-middleware/keycloak/pull/341>`_
Minor Changes
-------------
- Fixing common module usage `#343 <https://github.com/ansible-middleware/keycloak/pull/343>`_
- fix #336: https://github.com/ansible-middleware/common/pull/38 `#338 <https://github.com/ansible-middleware/keycloak/pull/338>`_
Bugfixes
--------
- Fix molecule tests `#339 <https://github.com/ansible-middleware/keycloak/pull/339>`_
v3.0.6
======
Major Changes
-------------
- AMW-540 Fix the upstream collection requirements with common v1.2.4 `#337 <https://github.com/ansible-middleware/keycloak/pull/337>`_
v3.0.5
======
Minor Changes
-------------
- AMW-528 Deployment fails in keycloak_quarkus due to missing escalation variables `#335 <https://github.com/ansible-middleware/keycloak/pull/335>`_
v3.0.4
======
Major Changes
-------------
- AMW-467 Download keycloak binary from password protected HTTP location `#321 <https://github.com/ansible-middleware/keycloak/pull/321>`_
- v26.4.x compability `#317 <https://github.com/ansible-middleware/keycloak/pull/317>`_
Minor Changes
-------------
- AMW-518 Validating arguments against arg spec 'main' fails unexpectedly. `#324 <https://github.com/ansible-middleware/keycloak/pull/324>`_
Bugfixes
--------
- Removing parseable from lint file as Additional properties are not allowed `#319 <https://github.com/ansible-middleware/keycloak/pull/319>`_
v3.0.3
======
Major Changes
-------------
- Update to keycloak 26.3.0 `#293 <https://github.com/ansible-middleware/keycloak/pull/293>`_
- ansible-core 2.19 compatibility `#310 <https://github.com/ansible-middleware/keycloak/pull/310>`_
Minor Changes
-------------
- Allow to install provider jars from remote paths `#303 <https://github.com/ansible-middleware/keycloak/pull/303>`_
- Declared proxy_mode as deprecated, updated quarkus and realm readme `#306 <https://github.com/ansible-middleware/keycloak/pull/306>`_
- Fix config_key_store_file description to match variable name `#308 <https://github.com/ansible-middleware/keycloak/pull/308>`_
Bugfixes
--------
- keycloak collection CI label is showing no status `#312 <https://github.com/ansible-middleware/keycloak/pull/312>`_
- keycloak_realm: allow secret in keycloak_clients `#304 <https://github.com/ansible-middleware/keycloak/pull/304>`_
v3.0.2
======
Minor Changes
-------------
- New ``checksum`` property for keycloak_quarkus_providers `#280 <https://github.com/ansible-middleware/keycloak/pull/280>`_
- New parameter to set the jgroups host IP address `#281 <https://github.com/ansible-middleware/keycloak/pull/281>`_
- Session storage / distributed caches `#287 <https://github.com/ansible-middleware/keycloak/pull/287>`_
- Update keycloak/RHBK to v26.2.4 `#283 <https://github.com/ansible-middleware/keycloak/pull/283>`_
Bugfixes
--------
- Fix ``keycloak_quarkus_force_install`` parameter being ignored by install `#296 <https://github.com/ansible-middleware/keycloak/pull/296>`_
- Fix alternate download location being ignored (JBossNeworkAPI always used) `#298 <https://github.com/ansible-middleware/keycloak/pull/298>`_
- Run config rebuild after SPI providers update `#285 <https://github.com/ansible-middleware/keycloak/pull/285>`_
- Use jdk21 as default in debian `#289 <https://github.com/ansible-middleware/keycloak/pull/289>`_
- keycloak_realm: federation default provider type should be a string `#302 <https://github.com/ansible-middleware/keycloak/pull/302>`_
v3.0.1
======
Minor Changes
-------------
- Version update to 26.0.8 / rhbk 26.0.11 `#277 <https://github.com/ansible-middleware/keycloak/pull/277>`_
Bugfixes
--------
- Trigger rebuild handler on envvars file change `#276 <https://github.com/ansible-middleware/keycloak/pull/276>`_
v3.0.0
======
Minor Changes
-------------
- Add theme cache invalidation handler `#252 <https://github.com/ansible-middleware/keycloak/pull/252>`_
- keycloak_realm: change url variables to defaults `#268 <https://github.com/ansible-middleware/keycloak/pull/268>`_
Breaking Changes / Porting Guide
--------------------------------
- Bump major and ansible-core versions `#266 <https://github.com/ansible-middleware/keycloak/pull/266>`_
- Rename parameters to follow upstream `#270 <https://github.com/ansible-middleware/keycloak/pull/270>`_
- Update for keycloak v26 `#254 <https://github.com/ansible-middleware/keycloak/pull/254>`_
Bugfixes
--------
- Access token lifespan is too short for ansible run `#251 <https://github.com/ansible-middleware/keycloak/pull/251>`_
- Load environment vars during kc rebuild `#274 <https://github.com/ansible-middleware/keycloak/pull/274>`_
- Rebuild config and restart service for local providers `#250 <https://github.com/ansible-middleware/keycloak/pull/250>`_
- Rename and honour parameter ``keycloak_quarkus_http_host`` `#271 <https://github.com/ansible-middleware/keycloak/pull/271>`_
New Modules
-----------
- middleware_automation.keycloak.keycloak_realm - Allows administration of Keycloak realm via Keycloak API
v2.4.3
======
Minor Changes
-------------
- Update keycloak to 24.0.5 `#241 <https://github.com/ansible-middleware/keycloak/pull/241>`_
v2.4.2
======
Minor Changes
-------------
- New parameter ``keycloak_quarkus_download_path`` `#239 <https://github.com/ansible-middleware/keycloak/pull/239>`_
Bugfixes
--------
- Add wait_for_port number parameter `#237 <https://github.com/ansible-middleware/keycloak/pull/237>`_
v2.4.1
======
Release Summary
---------------
Internal release, documentation or test changes only.
v2.4.0
======
Major Changes
-------------
- Enable by default health check on restart `#234 <https://github.com/ansible-middleware/keycloak/pull/234>`_
- Update minimum ansible-core version > 2.15 `#232 <https://github.com/ansible-middleware/keycloak/pull/232>`_
v2.3.0
======
Major Changes
-------------
- Allow for custom providers hosted on maven repositories `#223 <https://github.com/ansible-middleware/keycloak/pull/223>`_
- Restart handler strategy behaviour `#231 <https://github.com/ansible-middleware/keycloak/pull/231>`_
Minor Changes
-------------
- Add support for policy files `#225 <https://github.com/ansible-middleware/keycloak/pull/225>`_
- Allow to add extra custom env vars in sysconfig file `#229 <https://github.com/ansible-middleware/keycloak/pull/229>`_
- Download from alternate URL with optional http authentication `#220 <https://github.com/ansible-middleware/keycloak/pull/220>`_
- Update Keycloak to version 24.0.4 `#218 <https://github.com/ansible-middleware/keycloak/pull/218>`_
- ``proxy-header`` enhancement `#227 <https://github.com/ansible-middleware/keycloak/pull/227>`_
Bugfixes
--------
- ``kc.sh build`` uses configured jdk `#211 <https://github.com/ansible-middleware/keycloak/pull/211>`_
v2.2.2
======
Minor Changes
-------------
- Copying of key material for TLS configuration `#210 <https://github.com/ansible-middleware/keycloak/pull/210>`_
- Validate certs parameter for JDBC driver downloads `#207 <https://github.com/ansible-middleware/keycloak/pull/207>`_
Bugfixes
--------
- Turn off controller privilege escalation `#209 <https://github.com/ansible-middleware/keycloak/pull/209>`_
v2.2.1
======
Release Summary
---------------
Internal release, documentation or test changes only.
Bugfixes
--------
- JDBC provider: fix clause in argument validation `#204 <https://github.com/ansible-middleware/keycloak/pull/204>`_
v2.2.0
======
Major Changes
-------------
- Support java keystore for configuration of sensitive options `#189 <https://github.com/ansible-middleware/keycloak/pull/189>`_
Minor Changes
-------------
- Add ``wait_for_port`` and ``wait_for_log`` systemd unit logic `#199 <https://github.com/ansible-middleware/keycloak/pull/199>`_
- Customize jdbc driver downloads, optional authentication `#202 <https://github.com/ansible-middleware/keycloak/pull/202>`_
- Keystore-based vault SPI configuration `#196 <https://github.com/ansible-middleware/keycloak/pull/196>`_
- New ``keycloak_quarkus_hostname_strict_https`` parameter `#195 <https://github.com/ansible-middleware/keycloak/pull/195>`_
- Providers config and custom providers `#201 <https://github.com/ansible-middleware/keycloak/pull/201>`_
- Remove administrator credentials from files once keycloak is bootstrapped `#197 <https://github.com/ansible-middleware/keycloak/pull/197>`_
- Update keycloak to 24.0 `#194 <https://github.com/ansible-middleware/keycloak/pull/194>`_
v2.1.2
======
Release Summary
---------------
Internal release, documentation or test changes only.
v2.1.1
======
Minor Changes
-------------
- Add reverse ``proxy_headers`` config, supersedes ``proxy_mode`` `#187 <https://github.com/ansible-middleware/keycloak/pull/187>`_
- Debian/Ubuntu compatibility `#178 <https://github.com/ansible-middleware/keycloak/pull/178>`_
- Use ``keycloak_realm`` as default for sub-entities `#180 <https://github.com/ansible-middleware/keycloak/pull/180>`_
Bugfixes
--------
- Fix permissions on controller-side downloaded artifacts `#184 <https://github.com/ansible-middleware/keycloak/pull/184>`_
- JVM args moved to ``JAVA_OPTS`` envvar (instead of JAVA_OPTS_APPEND) `#186 <https://github.com/ansible-middleware/keycloak/pull/186>`_
- Unrelax configuration file permissions `#191 <https://github.com/ansible-middleware/keycloak/pull/191>`_
- Utilize comment filter for ``ansible_managed`` annotations `#176 <https://github.com/ansible-middleware/keycloak/pull/176>`_
v2.1.0
======
Major Changes
-------------
- Implement infinispan TCPPING discovery protocol `#159 <https://github.com/ansible-middleware/keycloak/pull/159>`_
Minor Changes
-------------
- Set enable-recovery when xa transactions are enabled `#167 <https://github.com/ansible-middleware/keycloak/pull/167>`_
- keycloak_quarkus: Allow configuring log rotate options in quarkus configuration `#161 <https://github.com/ansible-middleware/keycloak/pull/161>`_
- keycloak_quarkus: ``sticky-session`` for infinispan routes `#163 <https://github.com/ansible-middleware/keycloak/pull/163>`_
Breaking Changes / Porting Guide
--------------------------------
- keycloak_quarkus: renamed infinispan host list configuration `#157 <https://github.com/ansible-middleware/keycloak/pull/157>`_
Bugfixes
--------
- keycloak_quarkus: fix custom JAVA_HOME parameter name `#171 <https://github.com/ansible-middleware/keycloak/pull/171>`_
v2.0.2
======
Minor Changes
-------------
- keycloak_quarkus: Add support for sqlserver jdbc driver `#148 <https://github.com/ansible-middleware/keycloak/pull/148>`_
- keycloak_quarkus: allow configuration of ``hostname-strict-backchannel`` `#152 <https://github.com/ansible-middleware/keycloak/pull/152>`_
- keycloak_quarkus: systemd restart behavior `#145 <https://github.com/ansible-middleware/keycloak/pull/145>`_
Bugfixes
--------
- keycloak_quarkus: Use ``keycloak_quarkus_java_opts`` `#154 <https://github.com/ansible-middleware/keycloak/pull/154>`_
- keycloak_quarkus: allow ports <1024 (e.g. :443) in systemd unit `#150 <https://github.com/ansible-middleware/keycloak/pull/150>`_
v2.0.1
======
Minor Changes
-------------
- keycloak_quarkus: add hostname-strict parameter `#139 <https://github.com/ansible-middleware/keycloak/pull/139>`_
- keycloak_quarkus: update to version 23.0.1 `#133 <https://github.com/ansible-middleware/keycloak/pull/133>`_
Bugfixes
--------
- keycloak_quarkus: template requires lowercase boolean values `#138 <https://github.com/ansible-middleware/keycloak/pull/138>`_
v2.0.0
======
Minor Changes
-------------
- Add new parameter for port offset configuration `#124 <https://github.com/ansible-middleware/keycloak/pull/124>`_
- Update Keycloak to version 22.0.5 `#122 <https://github.com/ansible-middleware/keycloak/pull/122>`_
Breaking Changes / Porting Guide
--------------------------------
- Add support for more http-related configs `#115 <https://github.com/ansible-middleware/keycloak/pull/115>`_
- Update minimum ansible-core version > 2.14 `#119 <https://github.com/ansible-middleware/keycloak/pull/119>`_
- keycloak_quarkus: enable config of key store and trust store `#116 <https://github.com/ansible-middleware/keycloak/pull/116>`_
v1.3.0
======
Major Changes
-------------
- Run service as ``keycloak_service_user`` `#106 <https://github.com/ansible-middleware/keycloak/pull/106>`_
Minor Changes
-------------
- keycloak_quarkus: Update Keycloak to version 22.0.3 `#112 <https://github.com/ansible-middleware/keycloak/pull/112>`_
- keycloak_quarkus: fix admin console redirect when running locally `#111 <https://github.com/ansible-middleware/keycloak/pull/111>`_
- keycloak_quarkus: skip proxy config if ``keycloak_quarkus_proxy_mode`` is ``none`` `#109 <https://github.com/ansible-middleware/keycloak/pull/109>`_
Bugfixes
--------
- keycloak_quarkus: fix validation failure upon port configuration change `#113 <https://github.com/ansible-middleware/keycloak/pull/113>`_
v1.2.8
======
Minor Changes
-------------
- keycloak_quarkus: set openjdk 17 as default `#103 <https://github.com/ansible-middleware/keycloak/pull/103>`_
- keycloak_quarkus: update to version 22.0.1 `#107 <https://github.com/ansible-middleware/keycloak/pull/107>`_
Bugfixes
--------
- Fix incorrect checks for ``keycloak_jgroups_subnet`` `#98 <https://github.com/ansible-middleware/keycloak/pull/98>`_
- Undefine ``keycloak_db_valid_conn_sql`` default `#91 <https://github.com/ansible-middleware/keycloak/pull/91>`_
- Update bindep.txt package python3-devel to support RHEL9 `#105 <https://github.com/ansible-middleware/keycloak/pull/105>`_
v1.2.7
======
Minor Changes
-------------
- Allow to override jgroups subnet `#93 <https://github.com/ansible-middleware/keycloak/pull/93>`_
- keycloak-quarkus: update keycloakx to v21.1.1 `#92 <https://github.com/ansible-middleware/keycloak/pull/92>`_
v1.2.6
======
Minor Changes
-------------
- Add profile features enabling/disabling `#87 <https://github.com/ansible-middleware/keycloak/pull/87>`_
- Improve service restart behavior configuration `#88 <https://github.com/ansible-middleware/keycloak/pull/88>`_
- Update default xa_datasource_class value for mariadb jdbc configuration `#89 <https://github.com/ansible-middleware/keycloak/pull/89>`_
Bugfixes
--------
- Handle WFLYCTL0117 when background validation millis is 0 `#90 <https://github.com/ansible-middleware/keycloak/pull/90>`_
v1.2.5
======
Minor Changes
-------------
- Add configuration for database connection pool validation `#85 <https://github.com/ansible-middleware/keycloak/pull/85>`_
- Allow to configure administration endpoint URL `#86 <https://github.com/ansible-middleware/keycloak/pull/86>`_
- Allow to force backend URLs to frontend URLs `#84 <https://github.com/ansible-middleware/keycloak/pull/84>`_
- Introduce systemd unit restart behavior `#81 <https://github.com/ansible-middleware/keycloak/pull/81>`_
v1.2.4
======
Minor Changes
-------------
- Add ``sqlserver`` to keycloak role jdbc configurations `#78 <https://github.com/ansible-middleware/keycloak/pull/78>`_
- Add configurability for XA transactions `#73 <https://github.com/ansible-middleware/keycloak/pull/73>`_
Bugfixes
--------
- Fix deprecation warning for ``ipaddr`` `#77 <https://github.com/ansible-middleware/keycloak/pull/77>`_
- Fix undefined facts when offline patching sso `#71 <https://github.com/ansible-middleware/keycloak/pull/71>`_
v1.2.1
======
Minor Changes
-------------
- Allow to setup keycloak HA cluster without remote cache store `#68 <https://github.com/ansible-middleware/keycloak/pull/68>`_
Bugfixes
--------
- Pass attributes to realm clients `#69 <https://github.com/ansible-middleware/keycloak/pull/69>`_
v1.2.0
======
Major Changes
-------------
- Provide config for multiple modcluster proxies `#60 <https://github.com/ansible-middleware/keycloak/pull/60>`_
Minor Changes
-------------
- Allow to configure TCPPING for cluster discovery `#62 <https://github.com/ansible-middleware/keycloak/pull/62>`_
- Drop community.general from dependencies `#61 <https://github.com/ansible-middleware/keycloak/pull/61>`_
- Switch middleware_automation.redhat_csp_download for middleware_automation.common `#63 <https://github.com/ansible-middleware/keycloak/pull/63>`_
- Switch to middleware_automation.common for rh-sso patching `#64 <https://github.com/ansible-middleware/keycloak/pull/64>`_
v1.1.1
======
Bugfixes
--------
- keycloak-quarkus: fix ``cache-config-file`` path in keycloak.conf.j2 template `#53 <https://github.com/ansible-middleware/keycloak/pull/53>`_
v1.1.0
======
Minor Changes
-------------
- Update keycloak to 18.0.2 - sso to 7.6.1 `#46 <https://github.com/ansible-middleware/keycloak/pull/46>`_
- Variable ``keycloak_no_log`` controls ansible ``no_log`` parameter (for debugging purposes) `#47 <https://github.com/ansible-middleware/keycloak/pull/47>`_
- Variables to override service start retries and delay `#51 <https://github.com/ansible-middleware/keycloak/pull/51>`_
- keycloak_quarkus: variable to enable development mode `#45 <https://github.com/ansible-middleware/keycloak/pull/45>`_
Breaking Changes / Porting Guide
--------------------------------
- Rename variables from ``infinispan_`` prefix to ``keycloak_infinispan_`` `#42 <https://github.com/ansible-middleware/keycloak/pull/42>`_
Bugfixes
--------
- keycloak_quarkus: fix /var/log/keycloak symlink to keycloak log directory `#44 <https://github.com/ansible-middleware/keycloak/pull/44>`_
v1.0.7
======
Breaking Changes / Porting Guide
--------------------------------
- keycloak_quarkus: use absolute path for certificate files `#39 <https://github.com/ansible-middleware/keycloak/pull/39>`_
Bugfixes
--------
- keycloak_quarkus: use become for tasks that will otherwise fail `#38 <https://github.com/ansible-middleware/keycloak/pull/38>`_
v1.0.6
======
Bugfixes
--------
- keycloak_quarkus: add selected java to PATH in systemd unit `#34 <https://github.com/ansible-middleware/keycloak/pull/34>`_
- keycloak_quarkus: set logfile path correctly under keycloak home `#35 <https://github.com/ansible-middleware/keycloak/pull/35>`_
v1.0.5
======
Minor Changes
-------------
- Update config options: keycloak and quarkus `#32 <https://github.com/ansible-middleware/keycloak/pull/32>`_
v1.0.4
======
Release Summary
---------------
Internal release, documentation or test changes only.
v1.0.3
======
Major Changes
-------------
- New role for installing keycloak >= 17.0.0 (quarkus) `#29 <https://github.com/ansible-middleware/keycloak/pull/29>`_
Minor Changes
-------------
- Add ``keycloak_config_override_template`` parameter for passing a custom xml config template `#30 <https://github.com/ansible-middleware/keycloak/pull/30>`_
Bugfixes
--------
- Make sure systemd unit starts with selected java JVM `#31 <https://github.com/ansible-middleware/keycloak/pull/31>`_
v1.0.2
======
Minor Changes
-------------
- Make ``keycloak_admin_password`` a default with assert (was: role variable) `#26 <https://github.com/ansible-middleware/keycloak/pull/26>`_
- Simplify dependency install logic and reduce play execution time `#19 <https://github.com/ansible-middleware/keycloak/pull/19>`_
Bugfixes
--------
- Set ``keycloak_frontend_url`` default according to other defaults `#25 <https://github.com/ansible-middleware/keycloak/pull/25>`_
v1.0.1
======
Release Summary
---------------
Minor enhancements, bug and documentation fixes.
Major Changes
-------------
- Apply latest cumulative patch of RH-SSO automatically when new parameter ``keycloak_rhsso_apply_patches`` is ``true`` `#18 <https://github.com/ansible-middleware/keycloak/pull/18>`_
Minor Changes
-------------
- Clustered installs now perform database initialization on first node to avoid locking issues `#17 <https://github.com/ansible-middleware/keycloak/pull/17>`_
v1.0.0
======
Release Summary
---------------
This is the first stable release of the ``middleware_automation.keycloak`` collection.
+36 -2
View File
@@ -1,7 +1,41 @@
## Developing
### Build and install locally
Clone the repository, checkout the tag you want to build, or pick the main branch for the development version; then:
ansible-galaxy collection build .
ansible-galaxy collection install middleware_automation-keycloak-*.tar.gz
### Development environment
Make sure your development machine has available:
* python 3.11+
* virtualenv
* docker (or podman)
In order to run setup the development environment and run the molecule tests locally, after cloning the repository:
```
# create new virtualenv using python 3
virtualenv $PATH_TO_DEV_VIRTUALENV
# activate the virtual env
source $PATH_TO_DEV_VIRTUALENV/bin/activate
# install ansible and tools onto the virtualenv
pip install yamllint 'molecule>=6.0' 'molecule-plugins[docker]' 'ansible-core>=2.16' ansible-lint
# install collection dependencies
ansible-galaxy collection install -r requirements.yml
# install python dependencies
pip install -r requirements.txt molecule/requirements.txt
# execute the tests (replace --all with -s subdirectory to run a single test)
molecule test --all
```
## Contributor's Guidelines
- All YAML files named with '.yml' extension
- All YAML files named with `.yml` extension
- Use spaces around jinja variables. `{{ var }}` over `{{var}}`
- Variables that are internal to the role should be lowercase and start with the role name
- Keep roles self contained - Roles should avoid including tasks from other roles when possible
@@ -11,4 +45,4 @@
- Indentation - Use 2 spaces for each indent
- `vars/` vs `defaults/` - internal or interpolated variables that don't need to change or be overridden by user go in `vars/`, those that a user would likely override, go under `defaults/` directory
- All role arguments have a specification in `meta/argument_specs.yml`
- All playbooks/roles should be focused on compatibility with Ansible Tower
- All playbooks/roles should be focused on compatibility with Ansible Automation Platform
+147 -87
View File
@@ -1,14 +1,18 @@
# Ansible Collection - middleware_automation.keycloak
[![Build Status](https://github.com/ansible-middleware/keycloak/workflows/CI/badge.svg?branch=main)](https://github.com/ansible-middleware/keycloak/actions/workflows/ci.yml)
<!--start build_status -->
[![Build Status](https://github.com/ansible-middleware/keycloak/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/ansible-middleware/keycloak/actions/workflows/ci.yml)
> **_NOTE:_ If you are Red Hat customer, install `redhat.rhbk` (for Red Hat Build of Keycloak) or `redhat.sso` (for Red Hat Single Sign-On) from [Automation Hub](https://console.redhat.com/ansible/ansible-dashboard) as the certified version of this collection.**
Collection to install and configure [Keycloak](https://www.keycloak.org/) or [Red Hat Single Sign-On](https://access.redhat.com/products/red-hat-single-sign-on).
<!--end build_status -->
<!--start description -->
Collection to install and configure [Keycloak](https://www.keycloak.org/) or [Red Hat Single Sign-On](https://access.redhat.com/products/red-hat-single-sign-on) / [Red Hat Build of Keycloak](https://access.redhat.com/products/red-hat-build-of-keycloak).
<!--end description -->
<!--start requires_ansible-->
## Ansible version compatibility
This collection has been tested against following Ansible versions: **>=2.9.10**.
This collection has been tested against following Ansible versions: **>=2.16.0**.
Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions.
<!--end requires_ansible-->
@@ -16,12 +20,15 @@ Plugins and modules within a collection may be tested with only specific Ansible
## Installation
<!--start galaxy_download -->
### Installing the Collection from Ansible Galaxy
Before using the collection, you need to install it with the Ansible Galaxy CLI:
ansible-galaxy collection install middleware_automation.keycloak
<!--end galaxy_download -->
You can also include it in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml`, using the format:
```yaml
@@ -33,120 +40,100 @@ collections:
The keycloak collection also depends on the following python packages to be present on the controller host:
* netaddr
* lxml
A requirement file is provided to install:
pip install -r requirements.txt
<!--start roles_paths -->
### Included roles
* [`keycloak`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak/README.md): role for installing the service.
* [`keycloak_quarkus`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak_quarkus/README.md): role for installing keycloak (>= 19.0.0, quarkus based).
* [`keycloak_realm`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak_realm/README.md): role for configuring a realm, user federation(s), clients and users, in an installed service.
* [`keycloak`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak/README.md): role for installing legacy keycloak (<= 19.0, wildfly based).
<!--end roles_paths -->
### Included modules
All Keycloak administration modules from `community.general` are provided in this collection for Keycloak 17+ (Quarkus). Use `auth_keycloak_url` without the legacy `/auth` context path (for example `http://localhost:8080`). Set `keycloak_context` to `/auth` only when automating WildFly-based Keycloak with the `keycloak` role.
* `keycloak_authentication`: manage authentication flows and executions using Keycloak Admin REST API.
* `keycloak_authentication_flow`: manage custom authentication flows and flow executions.
* `keycloak_authentication_required_actions`: manage required actions available in realm authentication.
* `keycloak_authentication_v2`: manage authentication flows with newer Keycloak API handling.
* `keycloak_authz_authorization_scope`: manage authorization scopes for a client resource server.
* `keycloak_authz_custom_policy`: manage custom authorization policies for a client resource server.
* `keycloak_authz_permission`: manage authorization permissions for a client resource server.
* `keycloak_authz_permission_info`: retrieve authorization permission information for a client resource server.
* `keycloak_client`: manage Keycloak clients (create/update/delete).
* `keycloak_client_rolemapping`: manage client role mappings for users and groups.
* `keycloak_client_rolescope`: manage client role scope mappings.
* `keycloak_client_scope`: manage client scopes and protocol mappers (replaces `community.general.keycloak_clientscope`).
* `keycloak_client_scope_type`: manage default and optional client scope assignments.
* `keycloak_clientsecret_info`: retrieve client secret information.
* `keycloak_clientsecret_regenerate`: regenerate a client secret.
* `keycloak_clienttemplate`: manage legacy client templates.
* `keycloak_component`: manage realm components.
* `keycloak_component_info`: retrieve realm component information.
* `keycloak_group`: manage realm groups and subgroups.
* `keycloak_identity_provider`: manage identity provider instances and configuration.
* `keycloak_realm`: manage realms (create/update/delete).
* `keycloak_realm_info`: retrieve realm information.
* `keycloak_realm_key`: manage realm key providers.
* `keycloak_realm_keys_metadata_info`: retrieve realm keys metadata.
* `keycloak_realm_localization`: manage realm localization texts.
* `keycloak_realm_rolemapping`: manage realm role mappings for users and groups.
* `keycloak_realm_users_info`: retrieve users from a realm.
* `keycloak_role`: manage realm and client roles.
* `keycloak_user`: manage users (create/update/delete).
* `keycloak_user_execute_actions_email`: trigger execute-actions emails for users.
* `keycloak_user_federation`: manage user federation providers (for example LDAP/AD).
* `keycloak_user_rolemapping`: manage user role mappings.
* `keycloak_userprofile`: manage user profile configuration.
## Usage
The collection provides roles to install Keycloak and modules to manage realms, clients, users, and related settings via the [Keycloak Admin REST API](https://www.keycloak.org/docs-api/latest/rest-api/index.html).
### Install Playbook
For Quarkus-based Keycloak (17+), set `auth_keycloak_url` to the server root URL without the legacy `/auth` path, for example `http://localhost:8080`. When using the legacy `keycloak` role with WildFly-based Keycloak, set `keycloak_context` to `/auth` in the `keycloak_realm` role.
* [`playbooks/keycloak.yml`](playbooks/keycloak.yml) installs the upstream(Keycloak) based on the defined variables.
* [`playbooks/rhsso.yml`](playbooks/rhsso.yml) installs Red Hat Single Sign-On(RHSSO) based on defined variables.
### Install Keycloak
Both playbooks include the `keycloak` role, with different settings, as described in the following sections.
* [`playbooks/keycloak_quarkus.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_quarkus.yml) installs Keycloak >= 17 using the `keycloak_quarkus` role.
* [`playbooks/keycloak.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak.yml) installs legacy Keycloak (<= 19) using the `keycloak` role.
For full service configuration details, refer to the [keycloak role README](roles/keycloak/README.md).
For full service configuration details, refer to the [keycloak_quarkus role README](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak_quarkus/README.md) or the [keycloak role README](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak/README.md).
#### Install from controller node (offline)
### Choosing between upstream project (Keycloak) and Red Hat Single Sign-On (RHSSO)
The general flag `keycloak_rhsso_enable` controls what to install between upstream (Keycloak, when `False`) or Red Hat Single Sign-On (when `True`).
The default value for the flag if `True` when Red Hat Network credentials are defined, `False` otherwise.
#### Install upstream (Keycloak) from keycloak releases
This is the default approach when RHN credentials are not defined. Keycloak is downloaded from keycloak builds (hosted on github.com) locally, and distributed to target nodes.
#### Install RHSSO from the Red Hat Customer Support Portal
Define the credentials as follows, and the default behaviour is to download a fresh archive of RHSSO on the controller node, then distribute to target nodes.
Making the keycloak zip archive available to the playbook working directory, and setting `keycloak_offline_install` to `true`, allows to skip
the download tasks. The local path for the archive does match the downloaded archive path, so that it is also used as a cache when multiple hosts are provisioned in a cluster.
```yaml
rhn_username: '<customer_portal_username>'
rhn_password: '<customer_portal_password>'
# (keycloak_rhsso_enable defaults to True)
keycloak_offline_install: true
```
#### Install from controller node (local source)
Making the keycloak zip archive (or the RHSSO zip archive), available to the playbook repository root directory, and setting `keycloak_offline_install` to `True`, allows to skip
the download tasks. The local path for the archive matches the downloaded archive path, so it is also used as a cache when multiple hosts are provisioned in a cluster.
```yaml
keycloak_offline_install: True
```
And depending on `keycloak_rhsso_enable`:
* `True`: install RHSSO using file rh-sso-x.y.z-server-dist.zip
* `False`: install keycloak using file keycloak-x.y.zip
<!--start rhn_credentials -->
<!--end rhn_credentials -->
#### Install from alternate sources (like corporate Nexus, artifactory, proxy, etc)
For RHSSO:
```yaml
keycloak_rhsso_enable: True
keycloak_rhsso_download_url: "https://<internal-nexus.private.net>/<path>/<to>/rh-sso-x.y.z-server-dist.zip"
```
For keycloak:
```yaml
keycloak_rhsso_enable: False
keycloak_download_url: "https://<internal-nexus.private.net>/<path>/<to>/keycloak-x.y.zip"
```
It is possible to perform downloads from alternate sources, using the `keycloak_download_url` variable; make sure the final downloaded filename matches with the source filename (ie. keycloak-legacy-x.y.zip or rh-sso-x.y.z-server-dist.zip).
### Example installation command
Execute the following command from the source root directory
```
ansible-playbook -i <ansible_hosts> -e @rhn-creds.yml playbooks/keycloak.yml -e keycloak_admin_password=<changeme>
```
- `keycloak_admin_password` Password for the administration console user account.
- `ansible_hosts` is the inventory, below is an example inventory for deploying to localhost
```
[keycloak]
localhost ansible_connection=local
```
## Configuration
### Config Playbook
[`playbooks/keycloak_realm.yml`](playbooks/keycloak_realm.yml) creates or updates provided realm, user federation(s), client(s), client role(s) and client user(s).
### Example configuration command
#### Example installation command
Execute the following command from the source root directory:
```bash
ansible-playbook -i <ansible_hosts> playbooks/keycloak_realm.yml -e keycloak_admin_password=<changeme> -e keycloak_realm=test
ansible-playbook -i <ansible_hosts> playbooks/keycloak_quarkus.yml -e keycloak_quarkus_bootstrap_admin_password=<changeme>
```
- `keycloak_admin_password` password for the administration console user account.
- `keycloak_realm` name of the realm to be created/used.
- `keycloak_quarkus_bootstrap_admin_password` password for the administration console user account.
- `ansible_hosts` is the inventory, below is an example inventory for deploying to localhost
```
@@ -154,12 +141,85 @@ ansible-playbook -i <ansible_hosts> playbooks/keycloak_realm.yml -e keycloak_adm
localhost ansible_connection=local
```
For full configuration details, refer to the [keycloak_realm role README](roles/keycloak_realm/README.md).
Note: when deploying clustered configurations, all hosts belonging to the cluster must be present in `ansible_play_batch`; ie. they must be targeted by the same ansible-playbook execution.
### Configure with roles
<!--start rhbk_realm_playbook -->
* [`playbooks/keycloak_realm.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_realm.yml) creates or updates provided realm, user federation(s), client(s), client role(s) and client user(s).
<!--end rhbk_realm_playbook -->
* [`playbooks/keycloak_realm_client.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_realm_client.yml) creates a realm with clients, roles and users using the `keycloak_realm` role.
* [`playbooks/keycloak_federation.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_federation.yml) configures user federation providers.
#### Example configuration command
Execute the following command from the source root directory:
```bash
ansible-playbook -i <ansible_hosts> playbooks/keycloak_realm.yml -e keycloak_realm_admin_password=<changeme> -e keycloak_realm_realm=test
```
- `keycloak_realm_admin_password` password for the administration console user account.
- `keycloak_realm_realm` name of the realm to be created/used.
- `ansible_hosts` is the inventory, below is an example inventory for deploying to localhost
```
[keycloak]
localhost ansible_connection=local
```
<!--start rhbk_realm_readme -->
For full configuration details, refer to the [keycloak_realm role README](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak_realm/README.md).
<!--end rhbk_realm_readme -->
### Configure with modules
Module playbooks target an already running Keycloak instance. All modules use the `middleware_automation.keycloak` collection namespace.
* [`playbooks/keycloak_client_scope.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_client_scope.yml) creates a client scope with protocol mappers using the `keycloak_client_scope` module.
* [`playbooks/keycloak_authentication_flow.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_authentication_flow.yml) creates a custom authentication flow with execution steps using the `keycloak_authentication_flow` module.
Example task using shared authentication defaults:
```yaml
- hosts: localhost
module_defaults:
group/middleware_automation.keycloak.keycloak:
auth_keycloak_url: http://localhost:8080
auth_realm: master
auth_username: admin
auth_password: "{{ keycloak_admin_password }}"
tasks:
- name: Create a user in a realm
middleware_automation.keycloak.keycloak_user:
realm: TestRealm
username: testuser
first_name: Test
last_name: User
email: testuser@example.com
enabled: true
state: present
```
When migrating from `community.general`, replace the collection prefix in playbooks (for example `community.general.keycloak_user` becomes `middleware_automation.keycloak.keycloak_user`) and use `keycloak_client_scope` instead of `keycloak_clientscope`.
## Support
<!--start support -->
For bug reports and feature requests, use [GitHub Issues](https://github.com/ansible-middleware/keycloak/issues).
<!--end support -->
## Release and Upgrade Notes
For details on changes between versions, please see the [CHANGELOG](https://github.com/ansible-middleware/keycloak/blob/main/CHANGELOG.rst) for this collection.
## License
Apache License v2.0 or later
See [LICENSE](LICENSE) to view the full text.
<!--start license -->
See [LICENSE](https://github.com/ansible-middleware/keycloak/blob/main/LICENSE) to view the full text.
<!--end license -->
+10
View File
@@ -0,0 +1,10 @@
python3-dev [compile platform:dpkg]
python3-devel [compile platform:rpm]
python39-devel [compile platform:centos-8 platform:rhel-8]
git-lfs [platform:rpm platform:dpkg]
python3-netaddr [platform:rpm platform:dpkg]
python3-lxml [platform:rpm platform:dpkg]
python3-jmespath [platform:rpm platform:dpkg]
python3-requests [platform:rpm platform:dpkg]
podman [platform:rpm platform:dpkg]
File diff suppressed because it is too large Load Diff
+32
View File
@@ -0,0 +1,32 @@
---
changelog_filename_template: ../CHANGELOG.rst
changelog_filename_version_depth: 0
changes_file: changelog.yaml
changes_format: combined
ignore_other_fragment_extensions: true
keep_fragments: false
mention_ancestor: true
new_plugins_after_name: removed_features
notesdir: fragments
prelude_section_name: release_summary
prelude_section_title: Release Summary
sections:
- - major_changes
- Major Changes
- - minor_changes
- Minor Changes
- - breaking_changes
- Breaking Changes / Porting Guide
- - deprecated_features
- Deprecated Features
- - removed_features
- Removed Features
- - security_fixes
- Security Fixes
- - bugfixes
- Bugfixes
- - known_issues
- Known Issues
title: middleware_automation.keycloak
trivial_section_name: trivial
use_fqcn: true
+59
View File
@@ -0,0 +1,59 @@
{
"$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
"version": "0.2",
"language": "en",
"ignorePaths": ["changelogs/**", "CHANGELOG.rst"],
"files": [
"**/*.md",
"**/*.rst",
"roles/*/meta/argument_specs.yml",
"roles/*/meta/main.yml",
"roles/*/tasks/**/*.yml",
"roles/*/defaults/*.yml",
"roles/*/handlers/*.yml",
"roles/*/templates/*.j2",
"molecule/**/*.yml",
"molecule/**/*.j2",
"playbooks/**/*.yml",
"meta/runtime.yml",
"meta/execution-environment.yml",
".github/workflows/*.yml",
".github/ISSUE_TEMPLATE/*.md",
"galaxy.yml"
],
"dictionaries": [
"custom-keycloak",
"java",
"bash",
"shellscript",
"fullstack",
"softwareTerms",
"software-tools",
"cpp-compound-words",
"python",
"docker",
"k8s",
"html",
"css",
"git",
"networking-terms",
"node",
"npm"
],
"dictionaryDefinitions": [
{
"name": "custom-keycloak",
"path": ".cspell/custom-dictionary.txt",
"addWords": true
}
],
"ignoreRegExpList": [
"/\\{\\{.*?\\}\\}/g",
"/`[^`]+`/g",
"/(https?:\\/\\/[^\\s)]+)/g",
"/\\|`?[a-z_]+`?\\|/g",
"/\\[.*?\\]\\(.*?\\)/g",
"/^\\s*authors?:.*$/gm",
"/^\\s*-\\s+.*<[^>]+>.*$/gm"
]
}
+1
View File
@@ -0,0 +1 @@
../CHANGELOG.rst
+2 -2
View File
@@ -7,7 +7,7 @@
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2022, Red Hat, Inc..</p>
<p>&#169; Copyright 2024, Red Hat, Inc.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
@@ -18,4 +18,4 @@
</section>
</div>
</body>
</html>
</html>
+14
View File
@@ -21,6 +21,20 @@
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home"> Keycloak Ansible Collection</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Middleware Automation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="https://ansible-middleware.github.io/infinispan/main/">Infinispan / Red Hat Data Grid</a></li>
<li class="toctree-l1"><a class="reference internal" href="https://ansible-middleware.github.io/keycloak/main/">Keycloak / Red Hat Single Sign-On</a></li>
<li class="toctree-l1"><a class="reference internal" href="https://ansible-middleware.github.io/wildfly/main/">Wildfly / Red Hat JBoss EAP</a></li>
<li class="toctree-l1"><a class="reference internal" href="https://ansible-middleware.github.io/jws/main/">Tomcat / Red Hat JWS</a></li>
<li class="toctree-l1"><a class="reference internal" href="https://ansible-middleware.github.io/amq/main/">ActiveMQ / Red Hat AMQ Broker</a></li>
<li class="toctree-l1"><a class="reference internal" href="https://ansible-middleware.github.io/amq_streams/main/">Kafka / Red Hat AMQ Streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="https://ansible-middleware.github.io/common/main/">Ansible Middleware utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="https://ansible-middleware.github.io/redhat-csp-download/main/">Red Hat CSP Download</a></li>
<li class="toctree-l1"><a class="reference internal" href="https://ansible-middleware.github.io/ansible_collections_jcliff/main/">JCliff</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+3 -3
View File
@@ -43,7 +43,7 @@ extensions = [
'myst_parser',
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'ansible_basic_sphinx_ext',
'sphinx_antsibull_ext',
]
# Add any paths that contain templates here, relative to this directory.
@@ -63,7 +63,7 @@ master_doc = 'index'
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = 'en'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
@@ -71,7 +71,7 @@ language = None
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.tmp']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'ansible'
highlight_language = 'YAML+Jinja'
+13 -11
View File
@@ -10,23 +10,25 @@ Welcome to Keycloak Collection documentation
README
plugins/index
roles/index
Changelog <CHANGELOG>
.. toctree::
:maxdepth: 2
:caption: Developer documentation
developing
testing
releasing
Developing <developing>
Testing <testing>
Releasing <releasing>
.. toctree::
:maxdepth: 2
:caption: General
:caption: Middleware collections
Changelog <CHANGELOG>
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`
Keycloak / Red Hat Single Sign-On <https://ansible-middleware.github.io/keycloak/main/>
Infinispan / Red Hat Data Grid <https://ansible-middleware.github.io/infinispan/main/>
Wildfly / Red Hat JBoss EAP <https://ansible-middleware.github.io/wildfly/main/>
Tomcat / Red Hat JWS <https://ansible-middleware.github.io/jws/main/>
ActiveMQ / Red Hat AMQ Broker <https://ansible-middleware.github.io/amq/main/>
Kafka / Red Hat AMQ Streams <https://ansible-middleware.github.io/amq_streams/main/>
Ansible Middleware utilities <https://ansible-middleware.github.io/common/main/>
JCliff <https://ansible-middleware.github.io/ansible_collections_jcliff/main/>
+61
View File
@@ -0,0 +1,61 @@
# Collection Versioning Strategy
Each supported collection maintained by Ansible follows Semantic Versioning 2.0.0 (https://semver.org/), for example:
Given a version number MAJOR.MINOR.PATCH, the following is incremented:
MAJOR version: when making incompatible API changes (see Feature Release scenarios below for examples)
MINOR version: when adding features or functionality in a backwards compatible manner, or updating testing matrix and/or metadata (deprecation)
PATCH version: when adding backwards compatible bug fixes or security fixes (strict).
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
The first version of a generally available supported collection on Ansible Automation Hub shall be version 1.0.0. NOTE: By default, all newly created collections may begin with a smaller default version of 0.1.0, and therefore a version of 1.0.0 should be explicitly stated by the collection maintainer.
## New content is added to an existing collection
Assuming the current release is 1.0.0, and a new module is ready to be added to the collection, the minor version would be incremented to 1.1.0. The change in the MINOR version indicates an additive change was made while maintaining backward compatibility for existing content within the collection.
## New feature to existing plugin or role within a collection (backwards compatible)
Assuming the current release is 1.0.0, and new features for an existing module are ready for release . We would increment the MINOR version to 1.1.0. The change in the MINOR version indicates an additive change was made while maintaining backward compatibility for existing content within the collection.
## Bug fix or security fix to existing content within a collection
Assuming the current release is 1.0.0 and a bug is fixed prior to the next minor release, the PATCH version would be incremented to 1.0.1. The patch indicates only a bug was fixed within a current version. The PATCH release does not contain new content, nor was functionality removed. Bug fixes may be included in a MINOR or MAJOR feature release if the timing allows, eliminating the need for a PATCH dedicated to the fix.
## Breaking change to any content within a collection
Assuming the current release is 1.0.0, and a breaking change (API or module) is introduced for a user or developer. The MAJOR version would be incremented to 2.0.0.
Examples of breaking changes within a collection may include but are not limited to:
- Argspec changes for a module that require either inventory structure or playbook changes.
- A change in the shape of either the inbound or returned payload of a filter plugin.
- Changes to a connection plugin that require additional inventory parameters or ansible.cfg entries.
- New functionality added to a module that changes the outcome of that module as released in previous versions.
- The removal of plugins from a collection.
## Content removed from a collection
Deleting a module or API is a breaking change. Please see the 'Breaking change' section for how to version this.
## A typographical error was fixed in the documentation for a collection
A correction to the README would be considered a bug fix and the PATCH incremented. See 'Bug fix' above.
## Documentation added/removed/modified within a collection
Only the PATCH version should be increased for a release that contains changes limited to revised documentation.
## Release automation
New releases are triggered by annotated git tags named after semantic versioning. The automation publishes the built artifacts to ansible-galaxy and github releases page.
+4 -2
View File
@@ -1,5 +1,7 @@
antsibull>=0.17.0
ansible-base>=2.10.12
antsibull-docs
antsibull-changelog
ansible-core>=2.16.0
ansible-pygments
sphinx-rtd-theme
git+https://github.com/felixfontein/ansible-basic-sphinx-ext
myst-parser
+1
View File
@@ -1,3 +1,4 @@
Role Index
==========
.. toctree::
+23
View File
@@ -0,0 +1,23 @@
# Testing
## Continuous integration
The collection is tested with a [molecule](https://github.com/ansible-community/molecule) setup covering the included roles and verifying correct installation and idempotency.
In order to run the molecule tests locally with python 3.9 available, after cloning the repository:
The test scenarios are available on the source code repository each on his own subdirectory under [molecule/](https://github.com/ansible-middleware/keycloak/molecule).
## Test playbooks
Sample playbooks are provided in the `playbooks/` directory; to run the playbooks locally (requires a rhel system with python 3.9+, ansible, and systemd) the steps are as follows:
```
# setup environment as in developing
# create inventory for localhost
cat << EOF > inventory
[keycloak]
localhost ansible_connection=local
EOF
# run the playbook
ansible-playbook -i inventory playbooks/keycloak.yml
```
+28 -5
View File
@@ -1,27 +1,50 @@
---
namespace: middleware_automation
name: keycloak
version: "0.2.5"
version: "3.1.3"
readme: README.md
authors:
- Romain Pelisse <rpelisse@redhat.com>
- Guido Grazioli <ggraziol@redhat.com>
- Ranabir Chakraborty <ranabir@ibm.com>
- Pavan Kumar Motaparthi <pmotapar@redhat.com>
- Helmut Wolf <hwo@world-direct.at>
- Harsha Cherukuri <hcheruku@redhat.com>
description: Install and configure a keycloak, or Red Hat Single Sign-on, service.
license_file: "LICENSE"
tags:
- keycloak
- redhat
- rhel
- rhn
- sso
- single sign-on
- openid
- application
- identity
- security
- infrastructure
- authentication
- java
- runtimes
- middleware
- a4mw
dependencies:
"middleware_automation.redhat_csp_download": ">=1.2.1"
"middleware_automation.wildfly": ">=0.0.6"
"middleware_automation.common": ">=1.2.1"
"ansible.posix": ">=1.4.0"
repository: https://github.com/ansible-middleware/keycloak
documentation: https://ansible-middleware.github.io/keycloak
homepage: https://github.com/ansible-middleware/keycloak
issues: https://github.com/ansible-middleware/keycloak/issues
build_ignore:
- .gitignore
- .github
- .ansible-lint
- .yamllint
- .DS_Store
- '*.tar.gz'
- '*.zip'
- molecule
- changelogs
- docs/_gh_include
- docs/conf.py
- docs/roles.rst.template
- docs/requirements.yml
+20
View File
@@ -0,0 +1,20 @@
v3.1.2
======
Major Changes
-------------
- Port integration tests from community.general #409
Minor Changes
-------------
- 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
+11
View File
@@ -0,0 +1,11 @@
---
version: 1
build_arg_defaults:
EE_BASE_IMAGE: 'quay.io/ansible/ansible-runner:stable-2.12-devel'
dependencies:
galaxy: requirements.yml
python: requirements.txt
system: bindep.txt
additional_build_steps:
append:
- RUN alternatives --set python /usr/bin/python3
+64 -1
View File
@@ -1,2 +1,65 @@
---
requires_ansible: ">=2.9.10"
requires_ansible: ">=2.16.0"
action_groups:
keycloak:
- keycloak_authentication
- keycloak_authentication_flow
- keycloak_authentication_required_actions
- keycloak_authentication_v2
- keycloak_authz_authorization_scope
- keycloak_authz_custom_policy
- keycloak_authz_permission
- keycloak_authz_permission_info
- keycloak_client
- keycloak_client_rolemapping
- keycloak_client_rolescope
- keycloak_client_scope
- keycloak_client_scope_type
- keycloak_client_scope_rolemappings
- keycloak_clientsecret_info
- keycloak_clientsecret_regenerate
- keycloak_clienttemplate
- keycloak_component
- keycloak_component_info
- keycloak_group
- keycloak_identity_provider
- keycloak_organization
- keycloak_organization_info
- keycloak_realm
- keycloak_realm_info
- keycloak_realm_key
- keycloak_realm_keys_metadata_info
- keycloak_realm_localization
- keycloak_realm_rolemapping
- keycloak_realm_users_info
- keycloak_role
- keycloak_user
- keycloak_user_federation
- keycloak_user_rolemapping
- keycloak_userprofile
- keycloak_user_execute_actions_email
plugin_routing:
modules:
keycloak_clientscope:
redirect: middleware_automation.keycloak.keycloak_client_scope
deprecation:
removal_version: 5.0.0
warning_text: >-
The module has been renamed to keycloak_client_scope for Keycloak 17+ (Quarkus).
Update playbooks to use middleware_automation.keycloak.keycloak_client_scope.
keycloak_clientscope_type:
redirect: middleware_automation.keycloak.keycloak_client_scope_type
deprecation:
removal_version: 5.0.0
warning_text: >-
The module has been renamed to keycloak_client_scope_type for Keycloak 17+ (Quarkus).
Update playbooks to use middleware_automation.keycloak.keycloak_client_scope_type.
keycloak_clientscope_rolemappings:
redirect: middleware_automation.keycloak.keycloak_client_scope_rolemappings
deprecation:
removal_version: 5.0.0
warning_text: >-
The module has been renamed to keycloak_client_scope_rolemappings for Keycloak 17+ (Quarkus).
Update playbooks to use middleware_automation.keycloak.keycloak_client_scope_rolemappings.
+45
View File
@@ -0,0 +1,45 @@
---
- 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://instance:8080
keycloak_quarkus_log: file
keycloak_quarkus_start_dev: true
keycloak_quarkus_proxy_mode: none
roles:
- role: keycloak_quarkus
- role: keycloak_realm
keycloak_realm_url: "{{ keycloak_quarkus_hostname }}"
keycloak_realm_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
keycloak_realm_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
keycloak_realm_client_users:
- username: TestUser
password: password
client_roles:
- client: TestClient
role: TestRoleUser
realm: "{{ keycloak_realm_realm }}"
- username: TestAdmin
password: password
client_roles:
- client: TestClient
role: TestRoleUser
realm: "{{ keycloak_realm_realm }}"
- client: TestClient
role: TestRoleAdmin
realm: "{{ keycloak_realm_realm }}"
keycloak_realm_realm: TestRealm
keycloak_realm_clients:
- name: TestClient
realm: "{{ keycloak_realm_realm }}"
public_client: "{{ keycloak_realm_client_public }}"
web_origins: "{{ keycloak_realm_client_web_origins }}"
users: "{{ keycloak_realm_client_users }}"
client_id: TestClient
attributes:
post.logout.redirect.uris: '/public/logout'
+48
View File
@@ -0,0 +1,48 @@
---
driver:
name: docker
platforms:
- name: instance
image: ghcr.io/hspaans/molecule-containers:debian-13
pre_build_image: true
privileged: true
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "8009/tcp"
cgroupns_mode: host
command: "/lib/systemd/systemd"
volumes:
- /sys/fs/cgroup:/sys/fs/cgroup:rw
provisioner:
name: ansible
config_options:
defaults:
interpreter_python: auto_silent
ssh_connection:
pipelining: false
playbooks:
prepare: prepare.yml
converge: converge.yml
verify: verify.yml
inventory:
host_vars:
localhost:
ansible_python_interpreter: /usr/bin/python3
env:
ANSIBLE_FORCE_COLOR: "true"
ANSIBLE_REMOTE_TMP: /tmp/.ansible/tmp
verifier:
name: ansible
scenario:
test_sequence:
- cleanup
- destroy
- create
- prepare
- converge
- idempotence
- side_effect
- verify
- cleanup
- destroy
+13
View File
@@ -0,0 +1,13 @@
---
- name: Prepare
hosts: all
vars_files:
- ../group_vars/all/vars.yml
gather_facts: yes
tasks:
- name: Install sudo
ansible.builtin.apt:
name:
- sudo
- openjdk-21-jdk-headless
- iproute2
+1
View File
@@ -0,0 +1 @@
../../roles
+40
View File
@@ -0,0 +1,40 @@
---
- name: Verify
hosts: all
vars:
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
keycloak_uri: "http://localhost:{{ 8080 + ( keycloak_jboss_port_offset | default(0) ) }}"
keycloak_management_port: "http://localhost:{{ 9990 + ( keycloak_jboss_port_offset | default(0) ) }}"
keycloak_jboss_port_offset: 10
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 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
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
when:
- hera_home is defined
- hera_home | length == 0
+45 -40
View File
@@ -1,43 +1,48 @@
---
- name: Converge
hosts: all
vars:
tasks:
- name: Include keycloak role
include_role:
name: ../../roles/keycloak
vars:
keycloak_admin_password: "changeme"
- name: Keycloak Realm Role
include_role:
name: ../../roles/keycloak_realm
vars:
keycloak_admin_password: "changeme"
keycloak_client_default_roles:
- TestRoleAdmin
- TestRoleUser
keycloak_client_users:
- username: TestUser
password: password
client_roles:
- client: TestClient
role: TestRoleUser
realm: "{{ keycloak_realm }}"
- username: TestAdmin
password: password
client_roles:
- client: TestClient
role: TestRoleUser
realm: "{{ keycloak_realm }}"
- client: TestClient
role: TestRoleAdmin
realm: "{{ keycloak_realm }}"
keycloak_realm: TestRealm
keycloak_clients:
- name: TestClient
roles: "{{ keycloak_client_default_roles }}"
realm: "{{ keycloak_realm }}"
public_client: "{{ keycloak_client_public }}"
web_origins: "{{ keycloak_client_web_origins }}"
users: "{{ keycloak_client_users }}"
client_id: TestClient
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://instance:8080
keycloak_quarkus_log: file
keycloak_quarkus_log_level: debug
keycloak_quarkus_log_target: /tmp/keycloak
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 "
roles:
- role: keycloak_quarkus
- role: keycloak_realm
keycloak_realm_url: "{{ keycloak_quarkus_hostname }}"
keycloak_realm_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
keycloak_realm_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
keycloak_realm_client_users:
- username: TestUser
password: password
client_roles:
- client: TestClient
role: TestRoleUser
realm: "{{ keycloak_realm_realm }}"
- username: TestAdmin
password: password
client_roles:
- client: TestClient
role: TestRoleUser
realm: "{{ keycloak_realm_realm }}"
- client: TestClient
role: TestRoleAdmin
realm: "{{ keycloak_realm_realm }}"
keycloak_realm_realm: TestRealm
keycloak_realm_clients:
- name: TestClient
realm: "{{ keycloak_realm_realm }}"
public_client: "{{ keycloak_realm_client_public }}"
web_origins: "{{ keycloak_realm_client_web_origins }}"
users: "{{ keycloak_realm_client_users }}"
client_id: TestClient
+10 -13
View File
@@ -1,22 +1,17 @@
---
dependency:
name: shell
command: ansible-galaxy collection install -r molecule/default/requirements.yml -p $HOME/.ansible/collections --force-with-deps
driver:
name: docker
lint: |
ansible-lint --version
ansible-lint -v
platforms:
- name: instance
image: registry.access.redhat.com/ubi8/ubi-init:latest
image: registry.access.redhat.com/ubi9/ubi-init:latest
pre_build_image: true
privileged: true
command: "/usr/sbin/init"
port_bindings:
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "8009/tcp"
- "8009/tcp"
- "9000/tcp"
provisioner:
name: ansible
config_options:
@@ -29,20 +24,22 @@ provisioner:
converge: converge.yml
verify: verify.yml
inventory:
group_vars:
all:
keycloak_install_requires_become: true
host_vars:
localhost:
ansible_python_interpreter: "{{ ansible_playbook_python }}"
env:
ANSIBLE_FORCE_COLOR: "true"
ANSIBLE_FORCE_COLOR: "true"
PROXY: "${PROXY}"
NO_PROXY: "${NO_PROXY}"
verifier:
name: ansible
scenario:
test_sequence:
- dependency
- lint
- cleanup
- destroy
- syntax
- create
- prepare
- converge
+65 -7
View File
@@ -1,12 +1,70 @@
---
- name: Prepare
hosts: all
vars_files:
- ../group_vars/all/vars.yml
gather_facts: yes
vars:
sudo_pkg_name: sudo
tasks:
- name: Disable beta repos
command: yum config-manager --disable '*beta*'
ignore_errors: yes
- name: "Run preparation common to all scenario"
ansible.builtin.include_tasks: ../prepare.yml
- name: Install sudo
yum:
name: sudo
state: present
- name: Create controller directory for downloads
ansible.builtin.file: # noqa risky-file-permissions delegated, uses controller host user
path: /tmp/keycloak
state: directory
mode: '0750'
delegate_to: localhost
run_once: true
- 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.7.3/keycloak-26.7.3.zip
dest: /tmp/keycloak
mode: '0640'
validate_certs: false
delegate_to: localhost
run_once: true
ignore_errors: true
- name: Attempt RHBK download using redhat.runtimes_common collection
when:
- rhn_username is defined
- rhn_username | length > 0
block:
- name: Retrieve RHBK product download using Unified Downloads API
middleware_automation.common.product_search:
client_id: "{{ rhn_username }}"
client_secret: "{{ rhn_password }}"
product_type: DISTRIBUTION
product_version: "{{ keycloak_quarkus_version | default('26.7.3') }}"
product_category: "RHBK"
register: rhn_products
no_log: "{{ omit_rhn_output | default(true) }}"
delegate_to: localhost
run_once: true
ignore_errors: true
- 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.7.3')) + '.zip$') }}"
delegate_to: localhost
run_once: true
when:
- rhn_products is defined
- rhn_products.results is defined
- name: Download Red Hat Build of Keycloak
middleware_automation.common.product_download:
client_id: "{{ rhn_username }}"
client_secret: "{{ rhn_password }}"
product_id: "{{ (rhn_matched_products | first).id }}"
dest: "/tmp/keycloak/keycloak-{{ keycloak_quarkus_version | default('26.7.3') }}.zip"
no_log: "{{ omit_rhn_output | default(true) }}"
delegate_to: localhost
run_once: true
when:
- rhn_matched_products is defined
- rhn_matched_products | length > 0
ignore_errors: true
-10
View File
@@ -1,10 +0,0 @@
---
collections:
- name: middleware_automation.redhat_csp_download
version: ">=1.2.1"
- name: middleware_automation.wildfly
version: ">=0.0.5"
- name: community.general
- name: community.docker
version: ">=1.9.1"
+1
View File
@@ -0,0 +1 @@
../../roles
+16 -1
View File
@@ -1,10 +1,25 @@
---
- name: Verify
hosts: all
vars:
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
keycloak_uri: "http://localhost:8080"
tasks:
- name: Populate service facts
ansible.builtin.service_facts:
- name: Check if keycloak service started
assert:
ansible.builtin.assert:
that:
- ansible_facts.services["keycloak.service"]["state"] == "running"
- ansible_facts.services["keycloak.service"]["status"] == "enabled"
- name: Verify token api call
ansible.builtin.uri:
url: "{{ keycloak_uri }}/realms/master/protocol/openid-connect/token"
method: POST
body: "client_id=admin-cli&username={{ keycloak_quarkus_bootstrap_admin_user }}&password={{ keycloak_quarkus_bootstrap_admin_user }}&grant_type=password"
validate_certs: no
register: keycloak_auth_response
until: keycloak_auth_response.status == 200
retries: 2
delay: 2
+31
View File
@@ -0,0 +1,31 @@
---
keycloak_download_validate_certs: false
keycloak_validate_certs: false
keycloak_quarkus_download_validate_certs: false
keycloak_quarkus_validate_certs: false
keycloak_realm_validate_certs: false
keycloak_quarkus_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_systemd_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_install_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_firewalld_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_iptables_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_jdbc_driver_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_config_store_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_restart_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_start_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_rebuild_config_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_fastpackages_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_bootstrapped_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_invalidate_theme_cache_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_systemd_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_install_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_firewalld_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_iptables_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_jdbc_driver_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_restart_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_start_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_stop_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_fastpackages_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_rhsso_patch_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
molecule_prepare_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
+17
View File
@@ -0,0 +1,17 @@
---
- 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://proxy:{{ keycloak_quarkus_http_port }}"
keycloak_quarkus_log: file
keycloak_quarkus_http_enabled: True
keycloak_quarkus_http_port: 8080
keycloak_quarkus_proxy_mode: edge
keycloak_quarkus_http_relative_path: /
roles:
- role: keycloak_quarkus
+57
View File
@@ -0,0 +1,57 @@
---
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"
networks:
- 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
privileged: true
command: "/usr/sbin/init"
networks:
- name: keycloak
exposed_ports:
- "443/tcp"
published_ports:
- 0.0.0.0:443:443/tcp
provisioner:
name: ansible
config_options:
defaults:
interpreter_python: auto_silent
ssh_connection:
pipelining: false
playbooks:
prepare: prepare.yml
converge: converge.yml
verify: verify.yml
inventory:
host_vars:
localhost:
ansible_python_interpreter: "{{ ansible_playbook_python }}"
env:
ANSIBLE_FORCE_COLOR: "true"
verifier:
name: ansible
scenario:
test_sequence:
- cleanup
- destroy
- create
- prepare
- converge
- idempotence
- side_effect
- verify
- cleanup
- destroy
+53
View File
@@ -0,0 +1,53 @@
---
- name: Prepare
hosts: all
vars_files:
- ../group_vars/all/vars.yml
tasks:
- name: Install sudo
ansible.builtin.dnf:
name: sudo
state: present
- name: "Display hera_home if defined."
ansible.builtin.set_fact:
hera_home: "{{ lookup('env', 'HERA_HOME') }}"
- name: Prepare proxy
hosts: proxy
vars:
nginx_proxy: |
location / {
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_pass http://instance:8080;
}
roles:
- elan.simple_nginx_reverse_proxy
pre_tasks:
- name: Create certificate request
ansible.builtin.command: openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -sha256 -days 365 -nodes -subj '/CN=proxy'
args:
chdir: "{{ playbook_dir }}"
delegate_to: localhost
changed_when: false
- name: Make certificate directory
ansible.builtin.file:
path: /etc/nginx/tls
state: directory
mode: 0755
- name: Copy certificates
ansible.builtin.copy:
src: "{{ item.name }}"
dest: "{{ item.dest }}"
mode: 0444
become: "{{ molecule_prepare_require_privilege_escalation | default(true) }}"
loop:
- { name: 'cert.pem', dest: '/etc/nginx/tls/certificate.crt' }
- { name: 'key.pem', dest: '/etc/nginx/tls/certificate.key' }
- name: Update CA trust
ansible.builtin.command: update-ca-trust
changed_when: false
become: "{{ molecule_prepare_require_privilege_escalation | default(true) }}"
+1
View File
@@ -0,0 +1 @@
../../roles
+28
View File
@@ -0,0 +1,28 @@
---
- name: Verify
hosts: instance
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 openid config
block:
- name: Fetch openID config # noqa blocked_modules command-instead-of-module
ansible.builtin.uri:
url: http://localhost:8080/realms/master/.well-known/openid-configuration
validate_certs: false
headers:
Host: proxy
register: openid_config
changed_when: False
- name: Verify endpoint URLs
ansible.builtin.assert:
that:
- openid_config.json['issuer'] == 'https://proxy/realms/master'
- openid_config.json['authorization_endpoint'] == 'https://proxy/realms/master/protocol/openid-connect/auth'
+2
View File
@@ -0,0 +1,2 @@
---
- import_playbook: ../default/converge.yml
@@ -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,24 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
- name: Get access token
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/realms/{{ auth_realm }}/protocol/openid-connect/token"
method: POST
status_code: 200
headers:
Accept: application/json
User-agent: Ansible
body_format: form-urlencoded
body:
grant_type: "password"
client_id: "admin-cli"
username: "{{ auth_username }}"
password: "{{ auth_password }}"
register: token_response
no_log: true
- name: Extract access token
ansible.builtin.set_fact:
access_token: "{{ token_response.json['access_token'] }}"
no_log: true
@@ -0,0 +1,37 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
- name: Flow Creation/Update <Integration Test Flow> Version 1
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow
state: present
authenticationExecutions:
- providerId: idp-review-profile
requirement: REQUIRED
authenticationConfig:
alias: Integration Test Flow - review profile config
config:
update.profile.on.first.login: "missing"
- subFlow: Integration Test Flow - User creation or linking
requirement: REQUIRED
authenticationExecutions:
- providerId: idp-create-user-if-unique
requirement: ALTERNATIVE
authenticationConfig:
alias: Integration Test Flow - create unique user config
config:
require.password.update.after.registration: "false"
- subFlow: Integration Test Flow - Handle Existing Account
requirement: ALTERNATIVE
authenticationExecutions:
- providerId: idp-confirm-link
requirement: REQUIRED
- providerId: auth-cookie
requirement: REQUIRED
register: flow_v1_result
- name: Expose flow_v1_result to parent scope
ansible.builtin.set_fact:
flow_v1_result: "{{ flow_v1_result }}"
no_log: true
@@ -0,0 +1,43 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
# - adding a new execution inside the sub flow 'Integration Test Flow - User creation or linking' after the execution 'idp-create-user-if-unique'
# - disable auth-cookie at the end of the flow
# - change the config require.password.update.after.registration to "true"
- name: Flow Creation/Update <Integration Test Flow> Version 2
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow
state: present
authenticationExecutions:
- providerId: idp-review-profile
requirement: REQUIRED
authenticationConfig:
alias: Integration Test Flow - review profile config
config:
update.profile.on.first.login: "missing"
- subFlow: Integration Test Flow - User creation or linking
requirement: REQUIRED
authenticationExecutions:
- providerId: idp-create-user-if-unique
requirement: ALTERNATIVE
authenticationConfig:
alias: Integration Test Flow - create unique user config
config:
require.password.update.after.registration: "true"
- providerId: auth-cookie
requirement: REQUIRED
- subFlow: Integration Test Flow - Handle Existing Account
requirement: ALTERNATIVE
authenticationExecutions:
- providerId: idp-confirm-link
requirement: REQUIRED
- providerId: auth-cookie
requirement: DISABLED
register: flow_v2_result
- name: Expose flow_v2_result to parent scope
ansible.builtin.set_fact:
flow_v2_result: "{{ flow_v2_result }}"
no_log: true
@@ -0,0 +1,28 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
# Rebuilds Keycloak's own built-in "clients" flow structure as of 26.7.1.
# validate_executions() used to raise a KeyError for client-flow parents, since only
# basic-flow and form-flow provider sets were known.
- name: Flow Creation/Update <Integration Test Flow - Client Flow>
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow - Client Flow
providerId: client-flow
state: present
authenticationExecutions:
- providerId: client-secret
requirement: ALTERNATIVE
- providerId: client-jwt
requirement: ALTERNATIVE
- providerId: client-secret-jwt
requirement: ALTERNATIVE
- providerId: client-x509
requirement: ALTERNATIVE
register: flow_v2_client_flow_result
- name: Expose flow_v2_client_flow_result to parent scope
ansible.builtin.set_fact:
flow_v2_client_flow_result: "{{ flow_v2_client_flow_result }}"
no_log: true
@@ -0,0 +1,31 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
# Rebuilds Keycloak's own built-in "registration" flow structure as of 26.7.1.
# validate_executions() used to only check authenticator-providers and falsely flagged form actions as invalid
# See https://github.com/ansible-middleware/keycloak/issues/382
- name: Flow Creation/Update <Integration Test Flow - Form Actions>
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow - Form Actions
state: present
authenticationExecutions:
- subFlow: Integration Test Flow - Form Actions - registration form
subFlowType: form-flow
requirement: REQUIRED
authenticationExecutions:
- providerId: registration-user-creation
requirement: REQUIRED
- providerId: registration-password-action
requirement: REQUIRED
- providerId: registration-recaptcha-action
requirement: DISABLED
- providerId: registration-terms-and-conditions
requirement: DISABLED
register: flow_v2_form_action_result
- name: Expose flow_v2_form_action_result to parent scope
ansible.builtin.set_fact:
flow_v2_form_action_result: "{{ flow_v2_form_action_result }}"
no_log: true
@@ -0,0 +1,144 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Fetch all authentication flows
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: keycloak_flows_response
no_log: true
- name: Extract flow id for alias 'Integration Test Flow'
ansible.builtin.set_fact:
test_flow_id: >-
{{ keycloak_flows_response.json
| selectattr('alias', 'equalto', 'Integration Test Flow')
| map(attribute='id')
| first }}
no_log: true
- name: Fetch basic flow data for 'Integration Test Flow'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ test_flow_id }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_top_level_data
no_log: true
- name: Assert flow attributes
ansible.builtin.assert:
that:
- test_flow_top_level_data.json.alias == "Integration Test Flow"
- test_flow_top_level_data.json.providerId == "basic-flow"
- test_flow_top_level_data.json.topLevel == true
- test_flow_top_level_data.json.builtIn == false
- name: Fetch flow executions for 'Integration Test Flow'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_executions
no_log: true
- name: Assert flow executions
ansible.builtin.assert:
that:
- test_flow_executions.json | length == 6
- test_flow_executions.json[0].providerId == "idp-review-profile"
- test_flow_executions.json[0].requirement == "REQUIRED"
- test_flow_executions.json[0].index == 0
- test_flow_executions.json[0].priority == 0
- test_flow_executions.json[0].level == 0
- test_flow_executions.json[0].authenticationConfig is not none
- test_flow_executions.json[0]['authenticationFlow'] is not defined or test_flow_executions.json[0].authenticationFlow == false
- test_flow_executions.json[1].displayName == "Integration Test Flow - User creation or linking"
- test_flow_executions.json[1].requirement == "REQUIRED"
- test_flow_executions.json[1].index == 1
- test_flow_executions.json[1].priority == 1
- test_flow_executions.json[1].level == 0
- test_flow_executions.json[1]['authenticationConfig'] is not defined
- test_flow_executions.json[1].authenticationFlow == true
- test_flow_executions.json[2].providerId == "idp-create-user-if-unique"
- test_flow_executions.json[2].requirement == "ALTERNATIVE"
- test_flow_executions.json[2].index == 0
- test_flow_executions.json[2].priority == 0
- test_flow_executions.json[2].level == 1
- test_flow_executions.json[2].authenticationConfig is not none
- test_flow_executions.json[2]['authenticationFlow'] is not defined or test_flow_executions.json[2].authenticationFlow == false
- test_flow_executions.json[3].displayName == "Integration Test Flow - Handle Existing Account"
- test_flow_executions.json[3].requirement == "ALTERNATIVE"
- test_flow_executions.json[3].index == 1
- test_flow_executions.json[3].priority == 1
- test_flow_executions.json[3].level == 1
- test_flow_executions.json[3]['authenticationConfig'] is not defined
- test_flow_executions.json[3].authenticationFlow == true
- test_flow_executions.json[4].providerId == "idp-confirm-link"
- test_flow_executions.json[4].requirement == "REQUIRED"
- test_flow_executions.json[4].index == 0
- test_flow_executions.json[4].priority == 0
- test_flow_executions.json[4].level == 2
- test_flow_executions.json[4]['authenticationConfig'] is not defined
- test_flow_executions.json[4]['authenticationFlow'] is not defined or test_flow_executions.json[4].authenticationFlow == false
- test_flow_executions.json[5].providerId == "auth-cookie"
- test_flow_executions.json[5].requirement == "REQUIRED"
- test_flow_executions.json[5].index == 2
- test_flow_executions.json[5].priority == 2
- test_flow_executions.json[5].level == 0
- test_flow_executions.json[5]['authenticationConfig'] is not defined
- test_flow_executions.json[5]['authenticationFlow'] is not defined or test_flow_executions.json[5].authenticationFlow == false
- name: Fetch flow execution config for 'idp-review-profile'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/config/{{ test_flow_executions.json[0].authenticationConfig }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_execution_idp_review_profile_config
no_log: true
- name: Assert flow execution config for 'idp-review-profile'
ansible.builtin.assert:
that:
- test_flow_execution_idp_review_profile_config.json.alias == "Integration Test Flow - review profile config"
- test_flow_execution_idp_review_profile_config.json.config is not none
- test_flow_execution_idp_review_profile_config.json.config['update.profile.on.first.login'] == "missing"
- name: Fetch flow execution config for 'idp-create-user-if-unique'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/config/{{ test_flow_executions.json[2].authenticationConfig }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_execution_idp_create_user_if_unique
no_log: true
- name: Assert flow execution config for 'idp-create-user-if-unique'
ansible.builtin.assert:
that:
- test_flow_execution_idp_create_user_if_unique.json.alias == "Integration Test Flow - create unique user config"
- test_flow_execution_idp_create_user_if_unique.json.config is not none
- test_flow_execution_idp_create_user_if_unique.json.config['require.password.update.after.registration'] == "false"
@@ -0,0 +1,151 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Fetch all authentication flows
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: keycloak_flows_response
no_log: true
- name: Extract flow id for alias 'Integration Test Flow'
ansible.builtin.set_fact:
test_flow_id: >-
{{ keycloak_flows_response.json
| selectattr('alias', 'equalto', 'Integration Test Flow')
| map(attribute='id')
| first }}
no_log: true
- name: Fetch basic flow data for 'Integration Test Flow'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ test_flow_id }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_top_level_data
no_log: true
- name: Assert flow attributes
ansible.builtin.assert:
that:
- test_flow_top_level_data.json.alias == "Integration Test Flow"
- test_flow_top_level_data.json.providerId == "basic-flow"
- test_flow_top_level_data.json.topLevel == true
- test_flow_top_level_data.json.builtIn == false
- name: Fetch flow executions for 'Integration Test Flow'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_executions
no_log: true
- name: Assert flow executions
ansible.builtin.assert:
that:
- test_flow_executions.json | length == 7
- test_flow_executions.json[0].providerId == "idp-review-profile"
- test_flow_executions.json[0].requirement == "REQUIRED"
- test_flow_executions.json[0].index == 0
- test_flow_executions.json[0].priority == 0
- test_flow_executions.json[0].level == 0
- test_flow_executions.json[0].authenticationConfig is not none
- test_flow_executions.json[0]['authenticationFlow'] is not defined or test_flow_executions.json[0].authenticationFlow == false
- test_flow_executions.json[1].displayName == "Integration Test Flow - User creation or linking"
- test_flow_executions.json[1].requirement == "REQUIRED"
- test_flow_executions.json[1].index == 1
- test_flow_executions.json[1].priority == 1
- test_flow_executions.json[1].level == 0
- test_flow_executions.json[1]['authenticationConfig'] is not defined
- test_flow_executions.json[1].authenticationFlow == true
- test_flow_executions.json[2].providerId == "idp-create-user-if-unique"
- test_flow_executions.json[2].requirement == "ALTERNATIVE"
- test_flow_executions.json[2].index == 0
- test_flow_executions.json[2].priority == 0
- test_flow_executions.json[2].level == 1
- test_flow_executions.json[2].authenticationConfig is not none
- test_flow_executions.json[2]['authenticationFlow'] is not defined or test_flow_executions.json[2].authenticationFlow == false
- test_flow_executions.json[3].providerId == "auth-cookie"
- test_flow_executions.json[3].requirement == "REQUIRED"
- test_flow_executions.json[3].index == 1
- test_flow_executions.json[3].priority == 1
- test_flow_executions.json[3].level == 1
- test_flow_executions.json[3]['authenticationConfig'] is not defined
- test_flow_executions.json[3]['authenticationFlow'] is not defined or test_flow_executions.json[3].authenticationFlow == false
- test_flow_executions.json[4].displayName == "Integration Test Flow - Handle Existing Account"
- test_flow_executions.json[4].requirement == "ALTERNATIVE"
- test_flow_executions.json[4].index == 2
- test_flow_executions.json[4].priority == 2
- test_flow_executions.json[4].level == 1
- test_flow_executions.json[4]['authenticationConfig'] is not defined
- test_flow_executions.json[4].authenticationFlow == true
- test_flow_executions.json[5].providerId == "idp-confirm-link"
- test_flow_executions.json[5].requirement == "REQUIRED"
- test_flow_executions.json[5].index == 0
- test_flow_executions.json[5].priority == 0
- test_flow_executions.json[5].level == 2
- test_flow_executions.json[5]['authenticationConfig'] is not defined
- test_flow_executions.json[5]['authenticationFlow'] is not defined or test_flow_executions.json[5].authenticationFlow == false
- test_flow_executions.json[6].providerId == "auth-cookie"
- test_flow_executions.json[6].requirement == "DISABLED"
- test_flow_executions.json[6].index == 2
- test_flow_executions.json[6].priority == 2
- test_flow_executions.json[6].level == 0
- test_flow_executions.json[6]['authenticationConfig'] is not defined
- test_flow_executions.json[6]['authenticationFlow'] is not defined or test_flow_executions.json[6].authenticationFlow == false
- name: Fetch flow execution config for 'idp-review-profile'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/config/{{ test_flow_executions.json[0].authenticationConfig }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_execution_idp_review_profile_config
no_log: true
- name: Assert flow execution config for 'idp-review-profile'
ansible.builtin.assert:
that:
- test_flow_execution_idp_review_profile_config.json.alias == "Integration Test Flow - review profile config"
- test_flow_execution_idp_review_profile_config.json.config is not none
- test_flow_execution_idp_review_profile_config.json.config['update.profile.on.first.login'] == "missing"
- name: Fetch flow execution config for 'idp-create-user-if-unique'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/config/{{ test_flow_executions.json[2].authenticationConfig }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_execution_idp_create_user_if_unique
no_log: true
- name: Assert flow execution config for 'idp-create-user-if-unique'
ansible.builtin.assert:
that:
- test_flow_execution_idp_create_user_if_unique.json.alias == "Integration Test Flow - create unique user config"
- test_flow_execution_idp_create_user_if_unique.json.config is not none
- test_flow_execution_idp_create_user_if_unique.json.config['require.password.update.after.registration'] == "true"
@@ -0,0 +1,80 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Fetch all authentication flows
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: keycloak_flows_response
no_log: true
- name: Extract flow id for alias 'Integration Test Flow - Client Flow'
ansible.builtin.set_fact:
test_flow_id: >-
{{ keycloak_flows_response.json
| selectattr('alias', 'equalto', 'Integration Test Flow - Client Flow')
| map(attribute='id')
| first }}
no_log: true
- name: Fetch basic flow data for 'Integration Test Flow - Client Flow'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ test_flow_id }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_top_level_data
no_log: true
- name: Assert flow attributes
ansible.builtin.assert:
that:
- test_flow_top_level_data.json.alias == "Integration Test Flow - Client Flow"
- test_flow_top_level_data.json.providerId == "client-flow"
- test_flow_top_level_data.json.topLevel == true
- test_flow_top_level_data.json.builtIn == false
- name: Fetch flow executions for 'Integration Test Flow - Client Flow'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow%20-%20Client%20Flow/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_executions
no_log: true
- name: Assert flow executions
ansible.builtin.assert:
that:
- test_flow_executions.json | length == 4
- test_flow_executions.json[0].providerId == "client-secret"
- test_flow_executions.json[0].requirement == "ALTERNATIVE"
- test_flow_executions.json[0].index == 0
- test_flow_executions.json[0].level == 0
- test_flow_executions.json[1].providerId == "client-jwt"
- test_flow_executions.json[1].requirement == "ALTERNATIVE"
- test_flow_executions.json[1].index == 1
- test_flow_executions.json[1].level == 0
- test_flow_executions.json[2].providerId == "client-secret-jwt"
- test_flow_executions.json[2].requirement == "ALTERNATIVE"
- test_flow_executions.json[2].index == 2
- test_flow_executions.json[2].level == 0
- test_flow_executions.json[3].providerId == "client-x509"
- test_flow_executions.json[3].requirement == "ALTERNATIVE"
- test_flow_executions.json[3].index == 3
- test_flow_executions.json[3].level == 0
@@ -0,0 +1,86 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Fetch all authentication flows
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: keycloak_flows_response
no_log: true
- name: Extract flow id for alias 'Integration Test Flow - Form Actions'
ansible.builtin.set_fact:
test_flow_id: >-
{{ keycloak_flows_response.json
| selectattr('alias', 'equalto', 'Integration Test Flow - Form Actions')
| map(attribute='id')
| first }}
no_log: true
- name: Fetch basic flow data for 'Integration Test Flow - Form Actions'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ test_flow_id }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_top_level_data
no_log: true
- name: Assert flow attributes
ansible.builtin.assert:
that:
- test_flow_top_level_data.json.alias == "Integration Test Flow - Form Actions"
- test_flow_top_level_data.json.providerId == "basic-flow"
- test_flow_top_level_data.json.topLevel == true
- test_flow_top_level_data.json.builtIn == false
- name: Fetch flow executions for 'Integration Test Flow - Form Actions'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow%20-%20Form%20Actions/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_executions
no_log: true
- name: Assert flow executions
ansible.builtin.assert:
that:
- test_flow_executions.json | length == 5
- test_flow_executions.json[0].displayName == "Integration Test Flow - Form Actions - registration form"
- test_flow_executions.json[0].requirement == "REQUIRED"
- test_flow_executions.json[0].index == 0
- test_flow_executions.json[0].level == 0
- test_flow_executions.json[0].authenticationFlow == true
- test_flow_executions.json[1].providerId == "registration-user-creation"
- test_flow_executions.json[1].requirement == "REQUIRED"
- test_flow_executions.json[1].index == 0
- test_flow_executions.json[1].level == 1
- test_flow_executions.json[1]['authenticationFlow'] is not defined or test_flow_executions.json[1].authenticationFlow == false
- test_flow_executions.json[2].providerId == "registration-password-action"
- test_flow_executions.json[2].requirement == "REQUIRED"
- test_flow_executions.json[2].index == 1
- test_flow_executions.json[2].level == 1
- test_flow_executions.json[3].providerId == "registration-recaptcha-action"
- test_flow_executions.json[3].requirement == "DISABLED"
- test_flow_executions.json[3].index == 2
- test_flow_executions.json[3].level == 1
- test_flow_executions.json[4].providerId == "registration-terms-and-conditions"
- test_flow_executions.json[4].requirement == "DISABLED"
- test_flow_executions.json[4].index == 3
- test_flow_executions.json[4].level == 1
@@ -0,0 +1,33 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow - Client Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v2_client_flow.yml
- name: Assert the flow creation result
ansible.builtin.assert:
that:
- flow_v2_client_flow_result is changed
- flow_v2_client_flow_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v2_client_flow_result.changed }}, diff={{ flow_v2_client_flow_result.get('diff') }}"
- name: Assert the created flow <Integration Test Flow - Client Flow>
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v2_client_flow.yml
# Check idempotency, by trying to create the existing flow again
- name: Trying to create the <Integration Test Flow - Client Flow> again, although nothing changed
ansible.builtin.include_tasks:
file: ../actions/flow_v2_client_flow.yml
- name: Assert that the task didn't re-create the flow, because the flow didn't change
ansible.builtin.assert:
that:
- flow_v2_client_flow_result is not changed
- flow_v2_client_flow_result.diff is not defined
msg: "Expected no changes and no diff but got: changed={{ flow_v2_client_flow_result.changed }}, diff={{ flow_v2_client_flow_result.get('diff') }}"
@@ -0,0 +1,61 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Create a client with browser override <Integration Test Flow>
middleware_automation.keycloak.keycloak_client:
realm: "{{ target_realm }}"
client_id: "test_client"
state: present
authentication_flow_binding_overrides:
browser_name: "Integration Test Flow"
- name: Modify the flow <Integration Test Flow> although it is bound as client override flow
ansible.builtin.include_tasks:
file: ../actions/flow_v2.yml
- name: Assert the flow modification result
ansible.builtin.assert:
that:
- flow_v2_result is changed
- flow_v2_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v2_result.changed }}, diff={{ flow_v2_result.get('diff') }}"
- name: Assert the flow <Integration Test Flow> after the modifications
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v2.yml
- name: Fetch client data
middleware_automation.keycloak.keycloak_client:
realm: "{{ target_realm }}"
client_id: "test_client"
state: present
register: client_result
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Fetch authentication flow (browser override={{ client_result.end_state.authenticationFlowBindingOverrides.browser }})
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ client_result.end_state.authenticationFlowBindingOverrides.browser }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: flow_response
- name: Assert client flow override binding
ansible.builtin.assert:
that:
- flow_response.json is defined
- flow_response.json.alias == "Integration Test Flow"
@@ -0,0 +1,33 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Assert the flow creation result
ansible.builtin.assert:
that:
- flow_v1_result is changed
- flow_v1_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v1_result.changed }}, diff={{ flow_v1_result.get('diff') }}"
- name: Assert the created flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v1.yml
# Check idempotency, by trying to create the existing flow again
- name: Trying to create the <Integration Test Flow> again, although nothing changed
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Assert that the task didn't re-create the flow, because the flow didn't change
ansible.builtin.assert:
that:
- flow_v1_result is not changed
- flow_v1_result.diff is not defined
msg: "Expected no changes and no diff but got: changed={{ flow_v1_result.changed }}, diff={{ flow_v1_result.get('diff') }}"
@@ -0,0 +1,40 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Delete the flow <Integration Test Flow>
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow
state: absent
register: flow_deletion_result
- name: Assert that the flow deletion result
ansible.builtin.assert:
that:
- flow_deletion_result is changed
- flow_deletion_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_deletion_result.changed }}, diff={{ flow_deletion_result.get('diff') }}"
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Assert that the flow does not exist anymore
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
status_code: 404
register: flow_response
@@ -0,0 +1,33 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow - Form Actions>
ansible.builtin.include_tasks:
file: ../actions/flow_v2_form_action.yml
- name: Assert the flow creation result
ansible.builtin.assert:
that:
- flow_v2_form_action_result is changed
- flow_v2_form_action_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v2_form_action_result.changed }}, diff={{ flow_v2_form_action_result.get('diff') }}"
- name: Assert the created flow <Integration Test Flow - Form Actions>
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v2_form_action.yml
# Check idempotency, by trying to create the existing flow again
- name: Trying to create the <Integration Test Flow - Form Actions> again, although nothing changed
ansible.builtin.include_tasks:
file: ../actions/flow_v2_form_action.yml
- name: Assert that the task didn't re-create the flow, because the flow didn't change
ansible.builtin.assert:
that:
- flow_v2_form_action_result is not changed
- flow_v2_form_action_result.diff is not defined
msg: "Expected no changes and no diff but got: changed={{ flow_v2_form_action_result.changed }}, diff={{ flow_v2_form_action_result.get('diff') }}"
@@ -0,0 +1,58 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Create an identity-provider with first and post login flow override <Integration Test Flow>
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: oidc-idp-integration-test
state: present
display_name: OpenID Connect IdP - Integration Test
enabled: true
provider_id: oidc
first_broker_login_flow_alias: Integration Test Flow
post_broker_login_flow_alias: Integration Test Flow
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: my-client
clientSecret: secret
syncMode: FORCE
- name: Modify the flow <Integration Test Flow> although it is bound as identity-provider first and post login flow
ansible.builtin.include_tasks:
file: ../actions/flow_v2.yml
- name: Assert the flow modification result
ansible.builtin.assert:
that:
- flow_v2_result is changed
- flow_v2_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v2_result.changed }}, diff={{ flow_v2_result.get('diff') }}"
- name: Assert the flow <Integration Test Flow> after the modifications
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v2.yml
- name: Fetch identity-provider data
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: oidc-idp-integration-test
state: present
register: identity_provider_result
- name: Assert identity-provider first and post flow binding
ansible.builtin.assert:
that:
- identity_provider_result.end_state.firstBrokerLoginFlowAlias == "Integration Test Flow"
- identity_provider_result.end_state.postBrokerLoginFlowAlias == "Integration Test Flow"
@@ -0,0 +1,58 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
---
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Flow Creation/Update <Integration Test Flow with invalid providerid in execution>
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow with invalid providerid in execution
state: present
authenticationExecutions:
- providerId: idp-review-profile
requirement: REQUIRED
authenticationConfig:
alias: Integration Test Flow - review profile config
config:
update.profile.on.first.login: "missing"
- subFlow: Integration Test Flow - User creation or linking
requirement: REQUIRED
authenticationExecutions:
- providerId: invalid-providerid
requirement: ALTERNATIVE
- subFlow: Integration Test Flow - Handle Existing Account
requirement: ALTERNATIVE
authenticationExecutions:
- providerId: another-invalid-providerid
requirement: REQUIRED
- providerId: auth-cookie
requirement: REQUIRED
ignore_errors: true
register: invalid_providerid_in_flow_result
- name: Verify that invalid providerId causes failure
ansible.builtin.assert:
that:
- invalid_providerid_in_flow_result is failed
- invalid_providerid_in_flow_result is not changed
- >-
invalid_providerid_in_flow_result.msg == "Validation of executions failed: Error(s) while validating flow: Unknown providerId 'invalid-providerid', Unknown providerId 'another-invalid-providerid'"
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Assert that the flow did not get created
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow%20with%20invalid%20providerid%20in%20execution/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
status_code: 404
register: flow_response
@@ -0,0 +1,50 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
# form-action providers are valid for form-flow, but not for basic-flow.
# This test ensures that validate_executions() correctly rejects them when used in a basic-flow context.
# Same for authentication providers (e.g auth-cookie) in a form-flow context.
- name: Flow Creation/Update <Integration Test Flow - Mismatched Flow Type> with providerIds mismatched to their parent flow type
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow - Mismatched Flow Type
state: present
authenticationExecutions:
- providerId: registration-user-creation
requirement: REQUIRED
- subFlow: Integration Test Flow - Mismatched Flow Type - form
subFlowType: form-flow
requirement: REQUIRED
authenticationExecutions:
- providerId: auth-cookie
requirement: REQUIRED
ignore_errors: true
register: mismatched_flow_type_result
- name: Assert providerIds mismatched with their parent flow type are rejected
ansible.builtin.assert:
that:
- mismatched_flow_type_result is failed
- mismatched_flow_type_result is not changed
- "'registration-user-creation' in mismatched_flow_type_result.msg"
- "'auth-cookie' in mismatched_flow_type_result.msg"
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Assert that the flow did not get created
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow%20-%20Mismatched%20Flow%20Type/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
status_code: 404
register: flow_response
@@ -0,0 +1,45 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
- name: Delete identity-provider <oidc-idp-integration-test> if it exists
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: oidc-idp-integration-test
state: absent
- name: Delete client <test_client> if it exists
middleware_automation.keycloak.keycloak_client:
realm: "{{ target_realm }}"
client_id: "test_client"
state: absent
- name: Unassign the flow <Integration Test Flow> as default browser flow
middleware_automation.keycloak.keycloak_realm:
id: "{{ target_realm }}"
realm: "{{ target_realm }}"
state: present
browser_flow: browser
- name: Delete <Integration Test Flow> flow if it exists
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow
state: absent
- name: Delete <Integration Test Flow - Form Actions> flow if it exists
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow - Form Actions
state: absent
- name: Delete <Integration Test Flow - Mismatched Flow Type> flow if it exists
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow - Mismatched Flow Type
state: absent
- name: Delete <Integration Test Flow - Client Flow> flow if it exists
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow - Client Flow
state: absent
@@ -0,0 +1,41 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Modify the flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v2.yml
- name: Assert the flow creation modification result
ansible.builtin.assert:
that:
- flow_v2_result is changed
- flow_v2_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v2_result.changed }}, diff={{ flow_v2_result.get('diff') }}"
- name: Assert the modified flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v2.yml
# Revert the modifications from the previous step
- name: Revert the modifications the flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Assert the flow modification result
ansible.builtin.assert:
that:
- flow_v1_result is changed
- flow_v1_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v1_result.changed }}, diff={{ flow_v1_result.get('diff') }}"
- name: Assert the flow <Integration Test Flow> after reverting the modifications
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v1.yml
@@ -0,0 +1,44 @@
# Copyright (c) Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
- name: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Assign the flow <Integration Test Flow> as default browser flow
middleware_automation.keycloak.keycloak_realm:
id: "{{ target_realm }}"
realm: "{{ target_realm }}"
state: present
browser_flow: Integration Test Flow
- name: Modify the flow <Integration Test Flow> although it is bound as realm browser flow
ansible.builtin.include_tasks:
file: ../actions/flow_v2.yml
- name: Assert the flow modification result
ansible.builtin.assert:
that:
- flow_v2_result is changed
- flow_v2_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v2_result.changed }}, diff={{ flow_v2_result.get('diff') }}"
- name: Assert the flow <Integration Test Flow> after the modifications
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v2.yml
- name: Fetch realm data to validate if the browser flow is still set to <Integration Test Flow>
middleware_automation.keycloak.keycloak_realm:
id: "{{ target_realm }}"
realm: "{{ target_realm }}"
state: present
register: realm_result
- name: Assert realm browser flow binding
ansible.builtin.assert:
that:
- realm_result.end_state.browserFlow == "Integration Test Flow"
@@ -0,0 +1,39 @@
- name: Executing flow creation tests
ansible.builtin.include_tasks:
file: tests/test_flow_creation.yml
- name: Executing unused flow modification tests
ansible.builtin.include_tasks:
file: tests/test_unused_flow_modification.yml
- name: Executing used default browser flow modification tests
ansible.builtin.include_tasks:
file: tests/test_used_default_browser_flow_modification.yml
- name: Executing client flow override flow modification tests
ansible.builtin.include_tasks:
file: tests/test_client_flow_override_flow_modification.yml
- name: Executing identity provider first and post flow override flow modification tests
ansible.builtin.include_tasks:
file: tests/test_identity_provider_flow_overrides_flow_modification.yml
- name: Executing flow deletion tests
ansible.builtin.include_tasks:
file: tests/test_flow_deletion.yml
- name: Invalid providerIds in execution tests
ansible.builtin.include_tasks:
file: tests/test_invalid_providerid_flow_creation.yml
- name: Executing form action flow creation tests
ansible.builtin.include_tasks:
file: tests/test_form_action_flow_creation.yml
- name: Mismatched flow type providerIds in execution tests
ansible.builtin.include_tasks:
file: tests/test_mismatched_flow_type_flow_creation.yml
- name: Executing client flow creation tests
ansible.builtin.include_tasks:
file: tests/test_client_flow_creation.yml
@@ -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,56 @@
---
# 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
@@ -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,221 @@
---
# 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 == []
@@ -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,109 @@
---
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 }}"

Some files were not shown because too many files have changed in this diff Show More