Compare commits

...
50 Commits
Author SHA1 Message Date
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
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
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
137 changed files with 2223 additions and 537 deletions
-2
View File
@@ -38,7 +38,5 @@ skip_list:
- vars_should_not_be_used
- file_is_small_enough
- file_has_valid_name
- name[template]
- var-naming[no-role-prefix]
use_default_rules: true
+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@f182febf0568baf1151f66549401167fd10b25d2 # v4.0.0
+1 -1
View File
@@ -22,4 +22,4 @@ jobs:
root_permission_varname: 'keycloak_install_requires_become'
debug_verbosity: "${{ github.event.inputs.debug_verbosity }}"
molecule_tests: >-
[ "debian", "quarkus", "quarkus_ha", "quarkus_ha_remote", "quarkus_ha_26.4_below", "default", "quarkus_devmode", "quarkus_upgrade", "keycloak_modules" ]
[ "debian", "sso_test", "quarkus", "quarkus_ha", "quarkus_ha_remote", "quarkus_ha_26.4_below", "default", "quarkus_devmode", "quarkus_upgrade", "keycloak_modules" ]
+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)}} }'
+1 -15
View File
@@ -17,18 +17,4 @@ jobs:
secrets:
galaxy_token: ${{ secrets.ANSIBLE_GALAXY_API_KEY }}
jira_webhook: ${{ secrets.JIRA_WEBHOOK_CREATE_VERSION }}
dispatch:
needs: release
strategy:
matrix:
repo: ['ansible-middleware/ansible-middleware-ee']
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 v${{ needs.release.outputs.tag_version }}"
client-payload: '{ "github": ${{toJson(github)}} }'
push_token: ${{ secrets.TRIGGERING_PAT }}
+2 -2
View File
@@ -8,7 +8,7 @@ jobs:
traffic:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v7
with:
ref: "gh-pages"
@@ -18,7 +18,7 @@ jobs:
TRAFFIC_ACTION_TOKEN: ${{ secrets.TRIGGERING_PAT }}
- name: Commit changes
uses: EndBug/add-and-commit@v4
uses: EndBug/add-and-commit@v10
with:
author_name: Ansible Middleware
message: "GitHub traffic"
+3
View File
@@ -11,6 +11,9 @@ docs/_build/
.mypy_cache/
*.retry
changelogs/.plugin-cache.yaml
changelogs/fragments/*.yaml
changelogs/fragments/*.yml
*.pem
*.key
*.p12
+32
View File
@@ -6,6 +6,38 @@ middleware\_automation.keycloak Release Notes
This changelog describes changes after version 0.2.6.
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
======
+4 -3
View File
@@ -85,6 +85,7 @@ All Keycloak administration modules from `community.general` are provided in thi
* `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.
@@ -155,11 +156,11 @@ Note: when deploying clustered configurations, all hosts belonging to the cluste
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_realm.yml -e keycloak_realm_admin_password=<changeme> -e keycloak_realm_realm=test
```
- `keycloak_admin_password` password for the administration console user account.
- `keycloak_realm` name of the realm to be created/used.
- `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
```
+55
View File
@@ -674,6 +674,61 @@ releases:
- 276.yaml
- 277.yaml
release_date: '2025-05-02'
3.0.10:
changes:
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>`_
'
fragments:
- 356.yaml
- 357.yaml
- 358.yaml
- 359.yaml
release_date: '2026-06-25'
3.0.11:
changes:
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>`_
'
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>`_
'
fragments:
- 363.yaml
- 364.yaml
- 366.yaml
- 373.yaml
- 378.yaml
- 389.yaml
release_date: '2026-08-24'
3.0.2:
changes:
bugfixes:
-2
View File
@@ -1,2 +0,0 @@
*
!.gitignore
-1
View File
@@ -44,7 +44,6 @@ extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx_antsibull_ext',
'ansible_basic_sphinx_ext',
]
# Add any paths that contain templates here, relative to this directory.
-3
View File
@@ -1,10 +1,7 @@
# ansible_basic_sphinx_ext still imports pkg_resources (removed in setuptools 82+).
setuptools>=70.0.0,<81.0.0
antsibull>=0.17.0
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 -1
View File
@@ -1,7 +1,7 @@
---
namespace: middleware_automation
name: keycloak
version: "3.0.9"
version: "3.0.11"
readme: README.md
authors:
- Romain Pelisse <rpelisse@redhat.com>
+17
View File
@@ -0,0 +1,17 @@
v3.0.11
=======
Minor Changes
-------------
- Add certification checks to the upstream repo #378
- Fix cert workflow #389
- Fix health check URL to include HTTP relative path #364
- fix(keycloak_quarkus): avoid leaking maven provider password in logs #363
Bugfixes
--------
- AMW-592 AMW Github Actions are failing because of latest molecule #366
- AMW-594 Upstream release is failing due to recent rules change #373
+3
View File
@@ -23,12 +23,15 @@ action_groups:
- 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
+13 -13
View File
@@ -14,32 +14,32 @@
roles:
- role: keycloak_quarkus
- role: keycloak_realm
keycloak_url: "{{ keycloak_quarkus_hostname }}"
keycloak_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
keycloak_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
keycloak_client_users:
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: "{{ keycloak_realm_realm }}"
- username: TestAdmin
password: password
client_roles:
- client: TestClient
role: TestRoleUser
realm: "{{ keycloak_realm }}"
realm: "{{ keycloak_realm_realm }}"
- client: TestClient
role: TestRoleAdmin
realm: "{{ keycloak_realm }}"
keycloak_realm: TestRealm
keycloak_clients:
realm: "{{ keycloak_realm_realm }}"
keycloak_realm_realm: TestRealm
keycloak_realm_clients:
- name: TestClient
realm: "{{ keycloak_realm }}"
public_client: "{{ keycloak_client_public }}"
web_origins: "{{ keycloak_client_web_origins }}"
users: "{{ keycloak_client_users }}"
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'
+1 -1
View File
@@ -6,7 +6,7 @@ platforms:
image: ghcr.io/hspaans/molecule-containers:debian-13
pre_build_image: true
privileged: true
port_bindings:
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "8009/tcp"
+13 -13
View File
@@ -19,30 +19,30 @@
roles:
- role: keycloak_quarkus
- role: keycloak_realm
keycloak_url: "{{ keycloak_quarkus_hostname }}"
keycloak_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
keycloak_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
keycloak_client_users:
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: "{{ keycloak_realm_realm }}"
- username: TestAdmin
password: password
client_roles:
- client: TestClient
role: TestRoleUser
realm: "{{ keycloak_realm }}"
realm: "{{ keycloak_realm_realm }}"
- client: TestClient
role: TestRoleAdmin
realm: "{{ keycloak_realm }}"
keycloak_realm: TestRealm
keycloak_clients:
realm: "{{ keycloak_realm_realm }}"
keycloak_realm_realm: TestRealm
keycloak_realm_clients:
- name: TestClient
realm: "{{ keycloak_realm }}"
public_client: "{{ keycloak_client_public }}"
web_origins: "{{ keycloak_client_web_origins }}"
users: "{{ keycloak_client_users }}"
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
+1 -1
View File
@@ -7,7 +7,7 @@ platforms:
pre_build_image: true
privileged: true
command: "/usr/sbin/init"
port_bindings:
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "8009/tcp"
+1
View File
@@ -23,6 +23,7 @@
url: https://github.com/keycloak/keycloak/releases/download/26.6.2/keycloak-26.6.2.zip
dest: /tmp/keycloak
mode: '0640'
validate_certs: false
delegate_to: localhost
run_once: true
ignore_errors: true
+5
View File
@@ -1,4 +1,9 @@
---
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) }}"
+1 -2
View File
@@ -7,12 +7,11 @@
keycloak_quarkus_show_deprecation_warnings: false
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
keycloak_quarkus_hostname: https://proxy
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: /
keycloak_quarkus_health_check_url: http://proxy:8080/realms/master/.well-known/openid-configuration
roles:
- role: keycloak_quarkus
+2 -2
View File
@@ -9,7 +9,7 @@ platforms:
command: "/usr/sbin/init"
networks:
- name: keycloak
port_bindings:
exposed_ports:
- "8080/tcp"
published_ports:
- 0.0.0.0:8080:8080/tcp
@@ -20,7 +20,7 @@ platforms:
command: "/usr/sbin/init"
networks:
- name: keycloak
port_bindings:
exposed_ports:
- "443/tcp"
published_ports:
- 0.0.0.0:443:443/tcp
+1 -1
View File
@@ -7,7 +7,7 @@ platforms:
pre_build_image: true
privileged: true
command: "/usr/sbin/init"
port_bindings:
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "8009/tcp"
+270
View File
@@ -46,12 +46,15 @@
- 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_execute_actions_email
@@ -90,6 +93,7 @@
auth_realm: "{{ auth_realm }}"
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
validate_certs: false
block:
- name: Reset fixtures from a previous verify run
middleware_automation.keycloak.keycloak_user:
@@ -168,6 +172,7 @@
middleware_automation.keycloak.keycloak_realm_info:
auth_keycloak_url: "{{ auth_keycloak_url }}"
realm: "{{ target_realm }}"
validate_certs: false
- name: Exercise migrated modules against running Keycloak
module_defaults:
@@ -176,6 +181,7 @@
auth_realm: "{{ auth_realm }}"
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
validate_certs: false
block:
- name: keycloak_realm_keys_metadata_info — query realm keys
middleware_automation.keycloak.keycloak_realm_keys_metadata_info:
@@ -185,6 +191,18 @@
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ target_realm }}"
- name: keycloak_realm_users_info — list users in realm
middleware_automation.keycloak.keycloak_realm_users_info:
realm: "{{ target_realm }}"
register: realm_users_info_result
- name: Assert keycloak_realm_users_info returns the molecule user
ansible.builtin.assert:
that:
- realm_users_info_result is not changed
- realm_users_info_result.users | length > 0
- realm_users_info_result.users | selectattr('username', 'equalto', user) | list | length == 1
- name: keycloak_realm — create ephemeral realm
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
@@ -192,6 +210,213 @@
enabled: true
state: present
- name: keycloak_realm — modify realm attributes without pruning undefined attributes. Step 1 - Introduce custom realm attributes
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
enabled: true
state: present
prune_undefined_realm_attributes: false
attributes:
custom-realm-attribute-1: 123
custom-realm-attribute-2: true
register: custom_realm_attributes_result
- name: Assert realm attribute without pruning undefined data result (Step 1)
ansible.builtin.assert:
that:
- custom_realm_attributes_result is changed
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-1"] == "123"
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-2"] == "true"
- name: keycloak_realm — modify realm attributes without pruning undefined attributes. Step 2 - Verify unchanged custom realm attributes
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
enabled: true
state: present
prune_undefined_realm_attributes: false
attributes:
custom-realm-attribute-2: false
register: custom_realm_attributes_result
- name: Assert realm attribute without pruning undefined data result (Step 2)
ansible.builtin.assert:
that:
- custom_realm_attributes_result is changed
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-1"] == "123" # should still be 123
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-2"] == "false"
- name: keycloak_realm — modify realm attributes with pruning undefined attributes
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
enabled: true
state: present
prune_undefined_realm_attributes: true
attributes:
custom-realm-attribute-3: custom-attribute-3
register: custom_realm_attributes_result
- name: Assert realm attribute with pruning undefined data result
ansible.builtin.assert:
that:
- custom_realm_attributes_result is changed
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-1"] is not defined
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-2"] is not defined
- custom_realm_attributes_result.end_state.attributes["custom-realm-attribute-3"] == "custom-attribute-3"
# --- Organization module tests ---
- name: keycloak_realm — enable organizations on ephemeral realm
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
organizations_enabled: true
state: present
- name: keycloak_organization — create organization
middleware_automation.keycloak.keycloak_organization:
realm: "{{ ephemeral_realm }}"
name: molecule-org
description: Molecule test organization
enabled: true
domains:
- name: molecule.example.com
state: present
register: org_create_result
- name: Assert organization was created
ansible.builtin.assert:
that:
- org_create_result is changed
- org_create_result.end_state.name == "molecule-org"
- org_create_result.end_state.description == "Molecule test organization"
- org_create_result.end_state.enabled == true
- org_create_result.end_state.id is defined
- name: keycloak_organization — create organization (idempotency)
middleware_automation.keycloak.keycloak_organization:
realm: "{{ ephemeral_realm }}"
name: molecule-org
description: Molecule test organization
enabled: true
domains:
- name: molecule.example.com
state: present
register: org_create_idempotent_result
- name: Assert organization creation is idempotent
ansible.builtin.assert:
that:
- org_create_idempotent_result is not changed
- name: keycloak_organization — update organization description
middleware_automation.keycloak.keycloak_organization:
realm: "{{ ephemeral_realm }}"
name: molecule-org
description: Updated molecule test organization
state: present
register: org_update_result
- name: Assert organization was updated
ansible.builtin.assert:
that:
- org_update_result is changed
- org_update_result.end_state.description == "Updated molecule test organization"
- name: keycloak_organization — update organization (idempotency)
middleware_automation.keycloak.keycloak_organization:
realm: "{{ ephemeral_realm }}"
name: molecule-org
description: Updated molecule test organization
state: present
register: org_update_idempotent_result
- name: Assert organization update is idempotent
ansible.builtin.assert:
that:
- org_update_idempotent_result is not changed
- name: keycloak_organization_info — query organization by name
middleware_automation.keycloak.keycloak_organization_info:
realm: "{{ ephemeral_realm }}"
name: molecule-org
register: org_info_result
- name: Assert organization info returns the created org
ansible.builtin.assert:
that:
- org_info_result is not changed
- org_info_result.organizations | length == 1
- org_info_result.organizations[0].name == "molecule-org"
- name: keycloak_organization_info — list all organizations
middleware_automation.keycloak.keycloak_organization_info:
realm: "{{ ephemeral_realm }}"
register: org_info_all_result
- name: Assert organization list is non-empty
ansible.builtin.assert:
that:
- org_info_all_result.organizations | length >= 1
- name: keycloak_organization — create organization with attributes
middleware_automation.keycloak.keycloak_organization:
realm: "{{ ephemeral_realm }}"
name: molecule-org-attrs
description: Organization with attributes
attributes:
department: engineering
tags:
- test
- molecule
state: present
register: org_attrs_result
- name: Assert organization with attributes was created
ansible.builtin.assert:
that:
- org_attrs_result is changed
- org_attrs_result.end_state.attributes.department == ["engineering"]
- org_attrs_result.end_state.attributes.tags == ["test", "molecule"]
- name: keycloak_organization — delete organization with attributes
middleware_automation.keycloak.keycloak_organization:
realm: "{{ ephemeral_realm }}"
name: molecule-org-attrs
state: absent
register: org_attrs_delete_result
- name: Assert organization with attributes was deleted
ansible.builtin.assert:
that:
- org_attrs_delete_result is changed
- name: keycloak_organization — delete organization
middleware_automation.keycloak.keycloak_organization:
realm: "{{ ephemeral_realm }}"
name: molecule-org
state: absent
register: org_delete_result
- name: Assert organization was deleted
ansible.builtin.assert:
that:
- org_delete_result is changed
- name: keycloak_organization — delete organization (idempotency)
middleware_automation.keycloak.keycloak_organization:
realm: "{{ ephemeral_realm }}"
name: molecule-org
state: absent
register: org_delete_idempotent_result
- name: Assert organization deletion is idempotent
ansible.builtin.assert:
that:
- org_delete_idempotent_result is not changed
- name: keycloak_realm_localization — set locale override
middleware_automation.keycloak.keycloak_realm_localization:
parent_id: "{{ target_realm }}"
@@ -253,6 +478,50 @@
clientId: molecule-idp-client
state: present
- name: keycloak_identity_provider — set hide_on_login via top-level param
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: "{{ idp }}"
hide_on_login: true
state: present
register: idp_hide_on_login_result
- name: Assert hide_on_login is set correctly in end_state
ansible.builtin.assert:
that:
- idp_hide_on_login_result is changed
- idp_hide_on_login_result.end_state.hideOnLogin == true
- "'hide_on_login' not in (idp_hide_on_login_result.end_state.config | default({}))"
- name: keycloak_identity_provider — set hide_on_login idempotency check
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: "{{ idp }}"
hide_on_login: true
state: present
register: idp_hide_on_login_idempotent_result
- name: Assert hide_on_login idempotency (no change)
ansible.builtin.assert:
that:
- idp_hide_on_login_idempotent_result is not changed
- idp_hide_on_login_idempotent_result.end_state.hideOnLogin == true
- name: keycloak_identity_provider — set hide_on_login via legacy config key (backward compat)
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: "{{ idp }}"
hide_on_login: false
state: present
register: idp_hide_on_login_off_result
- name: Assert hide_on_login can be toggled off via top-level param
ansible.builtin.assert:
that:
- idp_hide_on_login_off_result is changed
- idp_hide_on_login_off_result.end_state.hideOnLogin == false
- "'hide_on_login_page' not in (idp_hide_on_login_off_result.end_state.config | default({}))"
- name: keycloak_clienttemplate — create client template
middleware_automation.keycloak.keycloak_clienttemplate:
realm: "{{ target_realm }}"
@@ -492,6 +761,7 @@
auth_realm: "{{ auth_realm }}"
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
validate_certs: false
block:
- name: keycloak_authz_custom_policy — remove custom policy if created
middleware_automation.keycloak.keycloak_authz_custom_policy:
-2
View File
@@ -4,8 +4,6 @@
vars_files:
- ../group_vars/all/vars.yml
vars:
rhn_username: "{{ lookup('env', 'rhn_username') | default('4278e994-7f90-46eb-b99c-90f2815b845f', true) }}"
rhn_password: "{{ lookup('env', 'rhn_password') | default('AHOLJo08ursGdWVm0F66iDR5Owk0CwpL', true) }}"
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
keycloak_admin_password: "remembertochangeme"
keycloak_quarkus_hostname: "http://instance:8080"
+1 -1
View File
@@ -7,7 +7,7 @@ platforms:
pre_build_image: true
privileged: true
command: "/usr/sbin/init"
port_bindings:
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "8009/tcp"
+16 -16
View File
@@ -7,7 +7,7 @@
keycloak_quarkus_show_deprecation_warnings: false
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
keycloak_realm: TestRealm
keycloak_realm_realm: TestRealm
keycloak_quarkus_hostname: https://instance:8443
keycloak_quarkus_log: file
keycloak_quarkus_log_level: debug # needed for the verify step
@@ -62,34 +62,34 @@
roles:
- role: keycloak_quarkus
- role: keycloak_realm
keycloak_url: http://instance:8080
keycloak_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
keycloak_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
keycloak_client_default_roles:
keycloak_realm_url: http://instance:8080
keycloak_realm_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
keycloak_realm_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
keycloak_realm_client_default_roles:
- TestRoleAdmin
- TestRoleUser
keycloak_client_users:
keycloak_realm_client_users:
- username: TestUser
password: password
client_roles:
- client: TestClient
role: TestRoleUser
realm: "{{ keycloak_realm }}"
realm: "{{ keycloak_realm_realm }}"
- username: TestAdmin
password: password
client_roles:
- client: TestClient
role: TestRoleUser
realm: "{{ keycloak_realm }}"
realm: "{{ keycloak_realm_realm }}"
- client: TestClient
role: TestRoleAdmin
realm: "{{ keycloak_realm }}"
keycloak_realm: TestRealm
keycloak_clients:
realm: "{{ keycloak_realm_realm }}"
keycloak_realm_realm: TestRealm
keycloak_realm_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 }}"
roles: "{{ keycloak_realm_client_default_roles }}"
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
+1 -1
View File
@@ -7,7 +7,7 @@ platforms:
pre_build_image: true
privileged: true
command: "/usr/sbin/init"
port_bindings:
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "8009/tcp"
+16 -16
View File
@@ -7,7 +7,7 @@
keycloak_quarkus_show_deprecation_warnings: false
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
keycloak_realm: TestRealm
keycloak_realm_realm: TestRealm
keycloak_quarkus_log: file
keycloak_quarkus_hostname: 'http://localhost:8080'
keycloak_quarkus_start_dev: True
@@ -18,34 +18,34 @@
roles:
- role: keycloak_quarkus
- role: keycloak_realm
keycloak_url: "{{ keycloak_quarkus_hostname }}"
keycloak_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
keycloak_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
keycloak_client_default_roles:
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_default_roles:
- TestRoleAdmin
- TestRoleUser
keycloak_client_users:
keycloak_realm_client_users:
- username: TestUser
password: password
client_roles:
- client: TestClient
role: TestRoleUser
realm: "{{ keycloak_realm }}"
realm: "{{ keycloak_realm_realm }}"
- username: TestAdmin
password: password
client_roles:
- client: TestClient
role: TestRoleUser
realm: "{{ keycloak_realm }}"
realm: "{{ keycloak_realm_realm }}"
- client: TestClient
role: TestRoleAdmin
realm: "{{ keycloak_realm }}"
keycloak_realm: TestRealm
keycloak_clients:
realm: "{{ keycloak_realm_realm }}"
keycloak_realm_realm: TestRealm
keycloak_realm_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 }}"
roles: "{{ keycloak_realm_client_default_roles }}"
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
+1 -1
View File
@@ -7,7 +7,7 @@ platforms:
pre_build_image: true
privileged: true
command: "/usr/sbin/init"
port_bindings:
exposed_ports:
- "8080/tcp"
- "8009/tcp"
- "9000/tcp"
+3 -3
View File
@@ -11,7 +11,7 @@ platforms:
- keycloak
networks:
- name: rhbk
port_bindings:
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "9000/tcp"
@@ -24,7 +24,7 @@ platforms:
- keycloak
networks:
- name: rhbk
port_bindings:
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "9000/tcp"
@@ -37,7 +37,7 @@ platforms:
- database
networks:
- name: rhbk
port_bindings:
exposed_ports:
- "5432/tcp"
mounts:
- type: bind
+3 -3
View File
@@ -11,7 +11,7 @@ platforms:
- keycloak
networks:
- name: rhbk
port_bindings:
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "9000/tcp"
@@ -24,7 +24,7 @@ platforms:
- keycloak
networks:
- name: rhbk
port_bindings:
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "9000/tcp"
@@ -37,7 +37,7 @@ platforms:
- database
networks:
- name: rhbk
port_bindings:
exposed_ports:
- "5432/tcp"
mounts:
- type: bind
+3 -3
View File
@@ -11,7 +11,7 @@ platforms:
- keycloak
networks:
- name: rhbk
port_bindings:
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "9000/tcp"
@@ -24,7 +24,7 @@ platforms:
- infinispan
networks:
- name: rhbk
port_bindings:
exposed_ports:
- "11222/tcp"
- name: postgres
image: ubuntu/postgres:14-22.04_beta
@@ -35,7 +35,7 @@ platforms:
- database
networks:
- name: rhbk
port_bindings:
exposed_ports:
- "5432/tcp"
mounts:
- type: bind
+2 -2
View File
@@ -11,8 +11,8 @@ platforms:
command: "/usr/sbin/init"
pre_build_image: true
privileged: true
port_bindings:
- 8080:8080
exposed_ports:
- "8080/tcp"
- "9000/tcp"
published_ports:
- 0.0.0.0:8080:8080/TCP
+22
View File
@@ -0,0 +1,22 @@
---
- name: Converge
hosts: all
vars_files:
- ../group_vars/all/vars.yml
vars:
keycloak_admin_password: "remembertochangeme"
keycloak_enable: true
keycloak_offline_install: false
roles:
- role: keycloak
- role: keycloak_realm
keycloak_realm_url: "http://instance:8080"
keycloak_realm_context: "/auth"
keycloak_realm_admin_user: "admin"
keycloak_realm_admin_password: "remembertochangeme"
keycloak_realm_realm: TestRealm
keycloak_realm_clients:
- name: TestClient
realm: "{{ keycloak_realm_realm }}"
public_client: true
client_id: TestClient
+31
View File
@@ -0,0 +1,31 @@
---
dependency:
name: galaxy
driver:
name: docker
platforms:
- name: instance
image: registry.access.redhat.com/ubi9/ubi-init:latest
command: /usr/sbin/init
privileged: true
pre_build_image: true
provisioner:
name: ansible
config_options:
defaults:
interpreter_python: auto_silent
callbacks_enabled: profile_tasks, timer, yaml
ssh_connection:
pipelining: false
playbooks:
prepare: prepare.yml
converge: converge.yml
verify: verify.yml
env:
ANSIBLE_ROLES_PATH: "../../roles"
inventory:
host_vars:
instance:
ansible_user: root
verifier:
name: ansible
+11
View File
@@ -0,0 +1,11 @@
---
- name: Prepare
hosts: all
vars_files:
- ../group_vars/all/vars.yml
gather_facts: yes
vars:
sudo_pkg_name: sudo
tasks:
- name: "Run preparation common to all scenario"
ansible.builtin.include_tasks: ../prepare.yml
+26
View File
@@ -0,0 +1,26 @@
---
- name: Verify
hosts: all
vars:
keycloak_admin_password: "remembertochangeme"
keycloak_admin_user: "admin"
keycloak_uri: "http://localhost:8080"
keycloak_context: "/auth"
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 token api call
ansible.builtin.uri:
url: "{{ keycloak_uri }}{{ keycloak_context }}/realms/master/protocol/openid-connect/token"
method: POST
body: "client_id=admin-cli&username={{ keycloak_admin_user }}&password={{ keycloak_admin_password }}&grant_type=password"
validate_certs: no
register: keycloak_auth_response
until: keycloak_auth_response.status == 200
retries: 2
delay: 2
+6 -6
View File
@@ -6,9 +6,9 @@
ansible.builtin.include_role:
name: keycloak_realm
vars:
keycloak_admin_password: "remembertochangeme"
keycloak_realm: TestRealm
keycloak_user_federation:
keycloak_realm_admin_password: "remembertochangeme"
keycloak_realm_realm: TestRealm
keycloak_realm_user_federation:
- realm: TestRealm
name: my-ldap
provider_id: ldap
@@ -48,13 +48,13 @@
ldap.full.name.attribute: cn
read.only: true
write.only: false
keycloak_clients:
keycloak_realm_clients:
- name: TestClient1
client_id: TestClient1
roles:
- TestClient1Admin
- TestClient1User
realm: "{{ keycloak_realm }}"
realm: "{{ keycloak_realm_realm }}"
public_client: true
web_origins:
- http://testclient1origin/application
@@ -65,4 +65,4 @@
client_roles:
- client: TestClient1
role: TestClient1User
realm: "{{ keycloak_realm }}"
realm: "{{ keycloak_realm_realm }}"
+3 -3
View File
@@ -2,8 +2,8 @@
- name: Playbook for Keycloak Hosts
hosts: all
vars:
keycloak_admin_password: "remembertochangeme"
keycloak_clients:
keycloak_realm_admin_password: "remembertochangeme"
keycloak_realm_clients:
- name: TestClient1
client_id: TestClient1
roles:
@@ -23,4 +23,4 @@
realm: TestRealm
roles:
- role: middleware_automation.keycloak.keycloak_realm
keycloak_realm: TestRealm
keycloak_realm_realm: TestRealm
+7 -7
View File
@@ -6,12 +6,12 @@
ansible.builtin.include_role:
name: middleware_automation.keycloak.keycloak_realm
vars:
keycloak_admin_password: "remembertochangeme"
keycloak_realm: TestRealm
keycloak_client_default_roles:
keycloak_realm_admin_password: "remembertochangeme"
keycloak_realm_realm: TestRealm
keycloak_realm_client_default_roles:
- TestRoleAdmin
- TestRoleUser
keycloak_client_users:
keycloak_realm_client_users:
- username: TestUser
password: password
client_roles:
@@ -27,13 +27,13 @@
- client: TestClient1
role: TestRoleAdmin
realm: TestRealm
keycloak_clients:
keycloak_realm_clients:
- name: TestClient1
client_id: TestClient1
roles: "{{ keycloak_client_default_roles }}"
roles: "{{ keycloak_realm_client_default_roles }}"
realm: TestRealm
public_client: true
web_origins:
- http://testclient1origin/application
- http://testclient1origin/other
users: "{{ keycloak_client_users }}"
users: "{{ keycloak_realm_client_users }}"
@@ -5,6 +5,7 @@
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
+1
View File
@@ -5,6 +5,7 @@
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
+1
View File
@@ -5,6 +5,7 @@
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
@@ -5,7 +5,9 @@
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
# Do not use this from other collections or standalone plugins/modules!
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
import typing as t
@@ -2,7 +2,9 @@
# BSD 2-Clause license (see LICENSES/BSD-2-Clause.txt)
# SPDX-License-Identifier: BSD-2-Clause
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
import copy
import json
@@ -153,6 +155,9 @@ URL_AUTHZ_RESOURCES = "{url}/admin/realms/{realm}/clients/{client_id}/authz/reso
URL_AUTHZ_CUSTOM_POLICY = "{url}/admin/realms/{realm}/clients/{client_id}/authz/resource-server/policy/{policy_type}"
URL_AUTHZ_CUSTOM_POLICIES = "{url}/admin/realms/{realm}/clients/{client_id}/authz/resource-server/policy"
URL_ORGANIZATIONS = "{url}/admin/realms/{realm}/organizations"
URL_ORGANIZATION = "{url}/admin/realms/{realm}/organizations/{id}"
def keycloak_argument_spec() -> dict[str, t.Any]:
"""
@@ -1106,6 +1111,22 @@ class KeycloakAPI:
except Exception as e:
self.fail_request(e, msg=f"Could not obtain the user for realm {realm} and username {username}: {e}")
def get_realm_users(self, realm: str = "master") -> list[dict[str, t.Any]]:
"""Obtain list of users from the realm
:param realm: realm id
:return: list of user representations
"""
users_url = URL_USERS.format(url=self.baseurl, realm=realm)
try:
return self._request_and_deserialize(users_url, method="GET")
except ValueError as e:
self.module.fail_json(
msg=f"API returned incorrect JSON when trying to obtain the users for realm {realm}: {e}"
)
except Exception as e:
self.fail_request(e, msg=f"Could not obtain the users for realm {realm}: {e}")
def get_service_account_user_by_client_id(self, client_id, realm: str = "master"):
"""Fetch a keycloak service account user within a realm based on its client_id.
@@ -3490,6 +3511,92 @@ class KeycloakAPI:
return self.get_client_role_scope_from_realm(clientid, realm)
def get_organizations(self, search_filter=None, realm: str = "master"):
"""Fetch representations for organizations in a realm.
:param search_filter: Optional query string to append (e.g. 'search=foo&exact=true').
:param realm: Realm to be queried; default 'master'.
:return: List of organization representations.
"""
orgs_url = URL_ORGANIZATIONS.format(url=self.baseurl, realm=realm)
if search_filter:
orgs_url = f"{orgs_url}?{search_filter}"
try:
return self._request_and_deserialize(orgs_url, method="GET")
except ValueError as e:
self.module.fail_json(
msg=f"API returned incorrect JSON when trying to obtain list of organizations for realm {realm}: {e}"
)
except Exception as e:
self.fail_request(e, msg=f"Could not obtain list of organizations for realm {realm}: {e}")
def get_organization_by_id(self, org_id, realm: str = "master"):
"""Fetch an organization by its UUID.
If the organization does not exist, None is returned.
:param org_id: UUID of the organization to fetch.
:param realm: Realm in which the organization resides; default 'master'.
"""
org_url = URL_ORGANIZATION.format(url=self.baseurl, realm=realm, id=org_id)
try:
return self._request_and_deserialize(org_url, method="GET")
except HTTPError as e:
if e.code == HTTPStatus.NOT_FOUND:
return None
else:
self.fail_request(e, msg=f"Could not fetch organization {org_id} in realm {realm}: {e}")
except Exception as e:
self.fail_request(e, msg=f"Could not fetch organization {org_id} in realm {realm}: {e}")
def get_organization_by_name(self, name, realm: str = "master"):
"""Fetch an organization by name using search API with exact matching.
Returns the full representation (fetched by ID) or None if not found.
:param name: Name of the organization to fetch.
:param realm: Realm in which the organization resides; default 'master'.
"""
search_url = URL_ORGANIZATIONS.format(url=self.baseurl, realm=realm)
search_url = f"{search_url}?search={quote(name, safe='')}&exact=true"
try:
orgs = self._request_and_deserialize(search_url, method="GET")
if not orgs:
return None
return self.get_organization_by_id(orgs[0]["id"], realm=realm)
except Exception as e:
self.fail_request(e, msg=f"Could not fetch organization {name} in realm {realm}: {e}")
def create_organization(self, orgrep, realm: str = "master"):
"""Create an organization.
:param orgrep: Organization representation of the organization to be created.
:param realm: Realm in which this organization resides, default "master".
:return: HTTPResponse object on success.
"""
orgs_url = URL_ORGANIZATIONS.format(url=self.baseurl, realm=realm)
try:
return self._request(orgs_url, method="POST", data=json.dumps(orgrep))
except Exception as e:
self.fail_request(e, msg=f"Could not create organization {orgrep.get('name')} in realm {realm}: {e}")
def update_organization(self, orgrep, realm: str = "master"):
"""Update an existing organization.
:param orgrep: Organization representation of the organization to be updated.
:param realm: Realm in which this organization resides, default "master".
:return: HTTPResponse object on success.
"""
org_url = URL_ORGANIZATION.format(url=self.baseurl, realm=realm, id=orgrep["id"])
try:
return self._request(org_url, method="PUT", data=json.dumps(orgrep))
except Exception as e:
self.fail_request(e, msg=f"Could not update organization {orgrep.get('name')} in realm {realm}: {e}")
def delete_organization(self, org_id, realm: str = "master"):
"""Delete an organization by UUID.
:param org_id: UUID of the organization to delete.
:param realm: Realm in which this organization resides, default "master".
"""
org_url = URL_ORGANIZATION.format(url=self.baseurl, realm=realm, id=org_id)
try:
return self._request(org_url, method="DELETE")
except Exception as e:
self.fail_request(e, msg=f"Could not delete organization {org_id} in realm {realm}: {e}")
def fail_request(self, e: Exception, msg: str, **kwargs: t.Any) -> t.NoReturn:
"""Triggers a module failure. This should be called
when an exception occurs during/after a request.
@@ -2,7 +2,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
import typing as t
@@ -2,7 +2,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_authentication
@@ -5,7 +5,8 @@
# 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
from __future__ import absolute_import, division, print_function
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = '''
@@ -4,7 +4,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_authentication_required_actions
+246 -4
View File
@@ -3,7 +3,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_authentication_v2
@@ -28,7 +30,7 @@ description:
If the option is V(false) and a temporary flow already exists, the module will fail to prevent accidental data loss.
- B(Idempotency) - If the existing flow already matches the desired configuration, no changes are made.
The module compares a normalised representation of the existing flow against the desired state before deciding whether to trigger the Safe Swap procedure.
- A depth of 4 sub-flows is supported.
- A depth of 10 sub-flows is supported.
attributes:
check_mode:
@@ -220,7 +222,7 @@ options:
authenticationExecutions:
description:
- The execution configuration for executions within the sub-flow.
- Executions at sub level 4 (last sub level).
- Executions at sub level 4.
type: list
elements: dict
suboptions:
@@ -234,7 +236,6 @@ options:
description:
- The C(providerId) of the execution.
type: str
required: true
authenticationConfig:
description:
- The configuration for the execution.
@@ -248,6 +249,247 @@ options:
description: Options for the execution config.
required: true
type: dict
subFlow:
description:
- The name of the sub-flow.
type: str
subFlowType:
description:
- The type of the sub-flow.
choices: [basic-flow, form-flow]
default: basic-flow
type: str
authenticationExecutions:
description:
- The execution configuration for executions within the sub-flow.
- Executions at sub level 5.
type: list
elements: dict
suboptions:
requirement:
description:
- The requirement status of the execution or sub-flow.
choices: [REQUIRED, ALTERNATIVE, DISABLED, CONDITIONAL]
type: str
required: true
providerId:
description:
- The C(providerId) of the execution.
type: str
authenticationConfig:
description:
- The configuration for the execution.
type: dict
suboptions:
alias:
description: Name of the execution config.
type: str
required: true
config:
description: Options for the execution config.
required: true
type: dict
subFlow:
description:
- The name of the sub-flow.
type: str
subFlowType:
description:
- The type of the sub-flow.
choices: [basic-flow, form-flow]
default: basic-flow
type: str
authenticationExecutions:
description:
- The execution configuration for executions within the sub-flow.
- Executions at sub level 6.
type: list
elements: dict
suboptions:
requirement:
description:
- The requirement status of the execution or sub-flow.
choices: [REQUIRED, ALTERNATIVE, DISABLED, CONDITIONAL]
type: str
required: true
providerId:
description:
- The C(providerId) of the execution.
type: str
authenticationConfig:
description:
- The configuration for the execution.
type: dict
suboptions:
alias:
description: Name of the execution config.
type: str
required: true
config:
description: Options for the execution config.
required: true
type: dict
subFlow:
description:
- The name of the sub-flow.
type: str
subFlowType:
description:
- The type of the sub-flow.
choices: [basic-flow, form-flow]
default: basic-flow
type: str
authenticationExecutions:
description:
- The execution configuration for executions within the sub-flow.
- Executions at sub level 7.
type: list
elements: dict
suboptions:
requirement:
description:
- The requirement status of the execution or sub-flow.
choices: [REQUIRED, ALTERNATIVE, DISABLED, CONDITIONAL]
type: str
required: true
providerId:
description:
- The C(providerId) of the execution.
type: str
authenticationConfig:
description:
- The configuration for the execution.
type: dict
suboptions:
alias:
description: Name of the execution config.
type: str
required: true
config:
description: Options for the execution config.
required: true
type: dict
subFlow:
description:
- The name of the sub-flow.
type: str
subFlowType:
description:
- The type of the sub-flow.
choices: [basic-flow, form-flow]
default: basic-flow
type: str
authenticationExecutions:
description:
- The execution configuration for executions within the sub-flow.
- Executions at sub level 8.
type: list
elements: dict
suboptions:
requirement:
description:
- The requirement status of the execution or sub-flow.
choices: [REQUIRED, ALTERNATIVE, DISABLED, CONDITIONAL]
type: str
required: true
providerId:
description:
- The C(providerId) of the execution.
type: str
authenticationConfig:
description:
- The configuration for the execution.
type: dict
suboptions:
alias:
description: Name of the execution config.
type: str
required: true
config:
description: Options for the execution config.
required: true
type: dict
subFlow:
description:
- The name of the sub-flow.
type: str
subFlowType:
description:
- The type of the sub-flow.
choices: [basic-flow, form-flow]
default: basic-flow
type: str
authenticationExecutions:
description:
- The execution configuration for executions within the sub-flow.
- Executions at sub level 9.
type: list
elements: dict
suboptions:
requirement:
description:
- The requirement status of the execution or sub-flow.
choices: [REQUIRED, ALTERNATIVE, DISABLED, CONDITIONAL]
type: str
required: true
providerId:
description:
- The C(providerId) of the execution.
type: str
authenticationConfig:
description:
- The configuration for the execution.
type: dict
suboptions:
alias:
description: Name of the execution config.
type: str
required: true
config:
description: Options for the execution config.
required: true
type: dict
subFlow:
description:
- The name of the sub-flow.
type: str
subFlowType:
description:
- The type of the sub-flow.
choices: [basic-flow, form-flow]
default: basic-flow
type: str
authenticationExecutions:
description:
- The execution configuration for executions within the sub-flow.
- Executions at sub level 10 (last sub level).
type: list
elements: dict
suboptions:
requirement:
description:
- The requirement status of the execution or sub-flow.
choices: [REQUIRED, ALTERNATIVE, DISABLED, CONDITIONAL]
type: str
required: true
providerId:
description:
- The C(providerId) of the execution.
type: str
required: true
authenticationConfig:
description:
- The configuration for the execution.
type: dict
suboptions:
alias:
description: Name of the execution config.
type: str
required: true
config:
description: Options for the execution config.
required: true
type: dict
state:
description:
- Whether the authentication flow should exist or not.
@@ -851,7 +1093,7 @@ def main() -> None:
authenticationExecutions=dict(
type="list",
elements="dict",
options=create_authentication_execution_spec_options(4),
options=create_authentication_execution_spec_options(10),
),
state=dict(choices=["absent", "present"], default="present"),
force_temporary_swap_flow_deletion=dict(type="bool", default=True),
@@ -4,7 +4,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_authz_authorization_scope
@@ -4,7 +4,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_authz_custom_policy
@@ -4,7 +4,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_authz_permission
@@ -4,7 +4,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_authz_permission_info
+2
View File
@@ -3,7 +3,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_client
@@ -3,7 +3,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_client_rolemapping
@@ -3,7 +3,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_client_rolescope
+2 -1
View File
@@ -5,7 +5,8 @@
# 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
from __future__ import absolute_import, division, print_function
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = '''
@@ -3,7 +3,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_client_scope_rolemappings
@@ -3,7 +3,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_client_scope_type
@@ -3,7 +3,9 @@
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_clientsecret_info
@@ -3,7 +3,9 @@
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_clientsecret_regenerate
@@ -3,7 +3,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_clienttemplate
+2
View File
@@ -3,7 +3,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_component
@@ -3,7 +3,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_component_info
+2
View File
@@ -3,7 +3,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_group
+26 -8
View File
@@ -3,7 +3,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_identity_provider
@@ -115,6 +117,15 @@ options:
- authenticateByDefault
type: bool
hide_on_login:
description:
- If hidden, login with this provider is possible only if requested explicitly, for example using the C(kc_idp_hint)
parameter.
aliases:
- hideOnLogin
- hide_on_login_page
type: bool
provider_id:
description:
- Protocol used by this provider (supported values are V(oidc) or V(saml)).
@@ -129,14 +140,6 @@ options:
identity provider configuration through check-mode in the RV(existing) field.
type: dict
suboptions:
hide_on_login_page:
description:
- If hidden, login with this provider is possible only if requested explicitly, for example using the C(kc_idp_hint)
parameter.
aliases:
- hideOnLoginPage
type: bool
gui_order:
description:
- Number defining order of the provider in GUI (for example, on Login page).
@@ -569,6 +572,7 @@ def main():
alias=dict(type="str", required=True),
add_read_token_role_on_create=dict(type="bool", aliases=["addReadTokenRoleOnCreate"]),
authenticate_by_default=dict(type="bool", aliases=["authenticateByDefault"]),
hide_on_login=dict(type="bool", aliases=["hideOnLogin", "hide_on_login_page"]),
config=dict(type="dict"),
display_name=dict(type="str", aliases=["displayName"]),
enabled=dict(type="bool"),
@@ -608,6 +612,20 @@ def main():
state = module.params.get("state")
config = module.params.get("config")
if config is not None:
for legacy_key in ("hide_on_login_page", "hideOnLoginPage"):
if legacy_key in config:
module.deprecate(
f"Passing '{legacy_key}' inside 'config' is deprecated. "
"Use the top-level 'hide_on_login' parameter instead.",
version="4.0.0",
collection_name="middleware_automation.keycloak",
)
if module.params.get("hide_on_login") is None:
module.params["hide_on_login"] = config.pop(legacy_key)
else:
config.pop(legacy_key)
fetch_identity_provider_wellknown_config(kc, config)
# Filter and map the parameters names that apply to the identity provider.
+416
View File
@@ -0,0 +1,416 @@
# Copyright (c) 2025, Chris Brown
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_organization
short_description: Allows administration of Keycloak organizations using Keycloak API
version_added: "3.1.0"
description:
- This module allows you to add, remove or modify Keycloak organizations using the Keycloak REST API.
It requires access to the REST API using OpenID Connect; the user connecting and the client being
used must have the requisite access rights. In a default Keycloak installation, admin-cli and an
admin user would work, as would a separate client definition with the scope tailored to your needs
and a user having the expected roles.
- The names of module options are snake_cased versions of the camelCase ones found in the Keycloak
API and its documentation at U(https://www.keycloak.org/docs-api/latest/rest-api/index.html).
- Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and
are returned that way by this module. You may pass single values for attributes when calling the
module, and this is translated into a list suitable for the API.
- Organizations are available in Keycloak 26 and later. The realm must have organizations enabled
(C(organizations_enabled=true) in the M(middleware_automation.keycloak.keycloak_realm) module)
before this module can be used.
- When updating an organization, where possible provide the organization ID to the module. This
removes a lookup to the API to translate the name into the organization ID.
attributes:
check_mode:
support: full
diff_mode:
support: full
action_group:
version_added: "3.1.0"
options:
state:
description:
- State of the organization.
- On V(present), the organization is created if it does not yet exist, or updated with the
parameters you provide.
- On V(absent), the organization is removed if it exists.
default: 'present'
type: str
choices:
- present
- absent
realm:
type: str
description:
- The Keycloak realm under which this organization resides.
default: 'master'
id:
type: str
description:
- The unique identifier for this organization.
- This parameter is not required for updating or deleting an organization but providing it
reduces the number of API calls required.
name:
type: str
description:
- Name of the organization.
- This parameter is required when creating a new organization.
alias:
type: str
description:
- URL-friendly alias for the organization.
- If not provided during creation, defaults to the organization name if URL-safe.
- The alias is immutable once set and cannot be changed on update.
enabled:
type: bool
description:
- Whether the organization is enabled.
- Disabled organizations block member authentication.
description:
type: str
description:
- Description of the organization.
domains:
type: list
elements: dict
description:
- List of internet domains associated with the organization.
- A domain name can only belong to one organization within a realm.
suboptions:
name:
type: str
required: true
description:
- The domain name (e.g. V(example.com)).
verified:
type: bool
default: false
description:
- Whether the domain has been verified.
attributes:
type: dict
description:
- A dict of key/value pairs to set as custom attributes for the organization.
- Values may be single values (for example a string) or a list of strings.
extends_documentation_fragment:
- middleware_automation.keycloak.keycloak
- middleware_automation.keycloak.actiongroup_keycloak
- middleware_automation.keycloak.attributes
author:
- Chris Brown (@chribro)
"""
EXAMPLES = r"""
- name: Create a Keycloak organization
middleware_automation.keycloak.keycloak_organization:
name: my-org
description: My Organization
enabled: true
realm: MyRealm
state: present
auth_client_id: admin-cli
auth_keycloak_url: https://auth.example.com
auth_realm: master
auth_username: USERNAME
auth_password: PASSWORD
delegate_to: localhost
- name: Create a Keycloak organization with domains
middleware_automation.keycloak.keycloak_organization:
name: acme-corp
description: Acme Corporation
enabled: true
domains:
- name: acme.com
- name: acme.org
verified: true
realm: MyRealm
state: present
auth_client_id: admin-cli
auth_keycloak_url: https://auth.example.com
auth_realm: master
auth_username: USERNAME
auth_password: PASSWORD
delegate_to: localhost
- name: Update a Keycloak organization
middleware_automation.keycloak.keycloak_organization:
name: my-org
description: Updated description
realm: MyRealm
state: present
auth_client_id: admin-cli
auth_keycloak_url: https://auth.example.com
auth_realm: master
auth_username: USERNAME
auth_password: PASSWORD
delegate_to: localhost
- name: Delete a Keycloak organization
middleware_automation.keycloak.keycloak_organization:
name: my-org
state: absent
realm: MyRealm
auth_client_id: admin-cli
auth_keycloak_url: https://auth.example.com
auth_realm: master
auth_username: USERNAME
auth_password: PASSWORD
delegate_to: localhost
"""
RETURN = r"""
msg:
description: Message as to what action was taken.
returned: always
type: str
end_state:
description: Representation of the organization after module execution.
returned: on success
type: complex
contains:
id:
description: GUID that identifies the organization.
type: str
returned: always
sample: 23f38145-3195-462c-97e7-97041ccea73e
name:
description: Name of the organization.
type: str
returned: always
sample: my-org
alias:
description: URL-friendly alias of the organization.
type: str
returned: always
sample: my-org
enabled:
description: Whether the organization is enabled.
type: bool
returned: always
sample: true
description:
description: Description of the organization.
type: str
returned: always
sample: My Organization
domains:
description: Domains associated with the organization.
type: list
returned: always
sample: [{"name": "example.com", "verified": false}]
attributes:
description: Attributes applied to this organization.
type: dict
returned: always
sample:
attr1: ["val1", "val2"]
"""
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.middleware_automation.keycloak.plugins.module_utils.identity.keycloak.keycloak import (
KeycloakAPI,
KeycloakError,
camel,
get_token,
keycloak_argument_spec,
)
def normalise_org(org):
"""Normalise an organization representation for comparison.
Sorts domains by name to ensure order-independent comparison.
"""
if org and "domains" in org and org["domains"]:
org["domains"] = sorted(org["domains"], key=lambda d: d.get("name", ""))
return org
def main():
argument_spec = keycloak_argument_spec()
meta_args = dict(
state=dict(default="present", choices=["present", "absent"]),
realm=dict(default="master"),
id=dict(type="str"),
name=dict(type="str"),
alias=dict(type="str"),
enabled=dict(type="bool"),
description=dict(type="str"),
domains=dict(
type="list",
elements="dict",
options=dict(
name=dict(type="str", required=True),
verified=dict(type="bool", default=False),
),
),
attributes=dict(type="dict"),
)
argument_spec.update(meta_args)
module = AnsibleModule(
argument_spec=argument_spec,
supports_check_mode=True,
required_one_of=(
[
["id", "name"],
["token", "auth_realm", "auth_username", "auth_password", "auth_client_id", "auth_client_secret"],
]
),
required_together=([["auth_username", "auth_password"]]),
required_by={"refresh_token": "auth_realm"},
)
result = dict(changed=False, msg="", diff={}, end_state={})
try:
connection_header = get_token(module.params)
except KeycloakError as e:
module.fail_json(msg=str(e))
kc = KeycloakAPI(module, connection_header)
realm = module.params.get("realm")
state = module.params.get("state")
oid = module.params.get("id")
name = module.params.get("name")
attributes = module.params.get("attributes")
if attributes is not None:
for key, val in module.params["attributes"].items():
module.params["attributes"][key] = [val] if not isinstance(val, list) else val
# Parameters that map to the organization representation (excluding module-level params)
org_params = [
x
for x in module.params
if x not in list(keycloak_argument_spec().keys()) + ["state", "realm"]
and module.params.get(x) is not None
]
if oid is None:
before_org = kc.get_organization_by_name(name, realm=realm)
else:
before_org = kc.get_organization_by_id(oid, realm=realm)
if before_org is None:
before_org = {}
normalise_org(before_org)
changeset = {}
for param in org_params:
new_param_value = module.params.get(param)
if param == "alias" and before_org:
if new_param_value != before_org.get("alias"):
module.warn(
f"Organization alias is immutable and cannot be changed from '{before_org.get('alias')}' "
f"to '{new_param_value}'. The alias parameter will be ignored for this update."
)
continue
old_value = before_org.get(camel(param))
if new_param_value != old_value:
changeset[camel(param)] = new_param_value
desired_org = before_org.copy()
desired_org.update(changeset)
normalise_org(desired_org)
if not before_org:
if state == "absent":
if module._diff:
result["diff"] = dict(before="", after="")
result["changed"] = False
result["end_state"] = {}
result["msg"] = "Organization does not exist; doing nothing."
module.exit_json(**result)
result["changed"] = True
if name is None:
module.fail_json(msg="name must be specified when creating a new organization")
if module._diff:
result["diff"] = dict(before="", after=desired_org)
if module.check_mode:
module.exit_json(**result)
kc.create_organization(desired_org, realm=realm)
after_org = kc.get_organization_by_name(name, realm=realm)
result["end_state"] = normalise_org(after_org) if after_org else {}
result["msg"] = f"Organization {name} has been created with ID {after_org['id']}"
module.exit_json(**result)
else:
if state == "present":
if desired_org == before_org:
result["changed"] = False
result["end_state"] = desired_org
result["msg"] = f"No changes required to organization {before_org['name']}."
module.exit_json(**result)
result["changed"] = True
if module._diff:
result["diff"] = dict(before=before_org, after=desired_org)
if module.check_mode:
module.exit_json(**result)
kc.update_organization(desired_org, realm=realm)
after_org = kc.get_organization_by_id(desired_org["id"], realm=realm)
result["end_state"] = normalise_org(after_org) if after_org else {}
result["msg"] = f"Organization {desired_org['id']} has been updated"
module.exit_json(**result)
else:
result["changed"] = True
if module._diff:
result["diff"] = dict(before=before_org, after="")
if module.check_mode:
module.exit_json(**result)
oid = before_org["id"]
kc.delete_organization(org_id=oid, realm=realm)
result["end_state"] = {}
result["msg"] = f"Organization {before_org['name']} has been deleted"
module.exit_json(**result)
if __name__ == "__main__":
main()
@@ -0,0 +1,142 @@
# Copyright (c) 2025, Chris Brown
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_organization_info
short_description: Retrieve organization info in Keycloak
version_added: "3.1.0"
description:
- This module retrieves information on organizations from Keycloak.
- Organizations are available in Keycloak 26 and later. The realm must have organizations enabled
before this module can be used.
attributes:
action_group:
version_added: "3.1.0"
options:
realm:
description:
- The name of the realm.
required: true
type: str
name:
description:
- Name of the organization to search for.
- If not provided, all organizations in the realm are returned.
type: str
exact:
description:
- Whether the search should be an exact match.
- Only relevant when O(name) is provided.
type: bool
default: true
extends_documentation_fragment:
- middleware_automation.keycloak.keycloak
- middleware_automation.keycloak.actiongroup_keycloak
- middleware_automation.keycloak.attributes
- middleware_automation.keycloak.attributes.info_module
author:
- Chris Brown (@chribro)
"""
EXAMPLES = r"""
- name: Retrieve a specific organization by name
middleware_automation.keycloak.keycloak_organization_info:
auth_keycloak_url: https://auth.example.com
auth_username: admin
auth_password: password
auth_realm: master
realm: MyRealm
name: my-org
- name: List all organizations in a realm
middleware_automation.keycloak.keycloak_organization_info:
auth_keycloak_url: https://auth.example.com
auth_username: admin
auth_password: password
auth_realm: master
realm: MyRealm
- name: Search organizations by partial name
middleware_automation.keycloak.keycloak_organization_info:
auth_keycloak_url: https://auth.example.com
auth_username: admin
auth_password: password
auth_realm: master
realm: MyRealm
name: acme
exact: false
"""
RETURN = r"""
organizations:
description: JSON representation of organizations.
returned: always
type: list
elements: dict
"""
from urllib.parse import quote
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.middleware_automation.keycloak.plugins.module_utils.identity.keycloak.keycloak import (
KeycloakAPI,
KeycloakError,
get_token,
keycloak_argument_spec,
)
def main():
argument_spec = keycloak_argument_spec()
meta_args = dict(
name=dict(type="str"),
realm=dict(type="str", required=True),
exact=dict(type="bool", default=True),
)
argument_spec.update(meta_args)
module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
result = dict(changed=False, organizations=[])
try:
connection_header = get_token(module.params)
except KeycloakError as e:
module.fail_json(msg=str(e))
kc = KeycloakAPI(module, connection_header)
realm = module.params.get("realm")
name = module.params.get("name")
exact = module.params.get("exact")
filters = []
if name:
filters.append(f"search={quote(name, safe='')}")
if exact:
filters.append("exact=true")
filter_str = "&".join(filters) if filters else None
result["organizations"] = kc.get_organizations(search_filter=filter_str, realm=realm)
module.exit_json(**result)
if __name__ == "__main__":
main()
+18 -1
View File
@@ -4,7 +4,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_realm
@@ -422,6 +424,13 @@ options:
aliases:
- permanentLockout
type: bool
prune_undefined_realm_attributes:
description:
- If True all realm attributes which are not defined in the attributes dict will be deleted
aliases:
- pruneUndefinedRealmAttributes
type: bool
default: true
quick_login_check_milli_seconds:
description:
- The realm quick login check in milliseconds.
@@ -797,6 +806,9 @@ from ansible_collections.middleware_automation.keycloak.plugins.module_utils.ide
get_token,
keycloak_argument_spec,
)
from ansible_collections.middleware_automation.keycloak.plugins.module_utils.identity.keycloak._keycloak_utils import (
merge_settings_without_absent_nulls,
)
def normalise_cr(realmrep):
@@ -918,6 +930,7 @@ def main():
password_policy=dict(type="str", aliases=["passwordPolicy"], no_log=False),
organizations_enabled=dict(type="bool", aliases=["organizationsEnabled"]),
permanent_lockout=dict(type="bool", aliases=["permanentLockout"]),
prune_undefined_realm_attributes=dict(type="bool", aliases=["pruneUndefinedRealmAttributes"], default=True),
quick_login_check_milli_seconds=dict(type="int", aliases=["quickLoginCheckMilliSeconds"]),
refresh_token_max_reuse=dict(type="int", aliases=["refreshTokenMaxReuse"], no_log=False),
registration_allowed=dict(type="bool", aliases=["registrationAllowed"]),
@@ -1029,9 +1042,10 @@ def main():
realm = module.params.get("realm")
state = module.params.get("state")
prune_undefined_realm_attributes = module.params.get("prune_undefined_realm_attributes")
# convert module parameters to realm representation parameters (if they belong in there)
params_to_ignore = list(keycloak_argument_spec().keys()) + ["state"]
params_to_ignore = list(keycloak_argument_spec().keys()) + ["state", "prune_undefined_realm_attributes"]
# Filter and map the parameters names that apply to the role
realm_params = [x for x in module.params if x not in params_to_ignore and module.params.get(x) is not None]
@@ -1047,6 +1061,9 @@ def main():
for realm_param in realm_params:
new_param_value = module.params.get(realm_param)
if camel(realm_param) == "attributes" and not prune_undefined_realm_attributes:
new_param_value = merge_settings_without_absent_nulls(before_realm.get("attributes"), new_param_value)
changeset[camel(realm_param)] = new_param_value
# Prepare the desired values using the existing values (non-existence results in a dict that is save to use as a basis)
+2
View File
@@ -3,7 +3,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_realm_info
+2
View File
@@ -4,7 +4,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_realm_key
@@ -3,7 +3,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_realm_keys_metadata_info
@@ -4,7 +4,9 @@
# https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_realm_localization
@@ -3,7 +3,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_realm_rolemapping
@@ -0,0 +1,123 @@
#!/usr/bin/python
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_realm_users_info
short_description: Retrieve users from a Keycloak realm using the Keycloak API
# Originally added in community.general 13.1.0
version_added: "3.1.0"
description:
- This module retrieves all users from a specified Keycloak realm using the Keycloak REST API.
- Access to the REST API is performed via OpenID Connect. The user and client used must have the necessary permissions.
- Authentication can be performed either with username/password or with a token.
- The names of module options are snake_case versions of the camelCase ones found in the Keycloak API and its documentation
at U(https://www.keycloak.org/docs-api/latest/rest-api/index.html).
options:
realm:
type: str
description:
- The Keycloak realm from which users should be retrieved.
default: 'master'
extends_documentation_fragment:
- middleware_automation.keycloak.keycloak
- middleware_automation.keycloak.actiongroup_keycloak
- middleware_automation.keycloak.attributes
- middleware_automation.keycloak.attributes.info_module
author:
- Felix Grzelka (@felix-grzelka)
"""
EXAMPLES = r"""
- name: List all users in the "MyCustomRealm" realm using username/password authentication
middleware_automation.keycloak.keycloak_realm_users_info:
realm: MyCustomRealm
auth_client_id: admin-cli
auth_keycloak_url: https://auth.example.com
auth_realm: master
auth_username: USERNAME
auth_password: PASSWORD
delegate_to: localhost
- name: List all users in the "MyCustomRealm" realm using a token
middleware_automation.keycloak.keycloak_realm_users_info:
realm: MyCustomRealm
auth_client_id: admin-cli
auth_keycloak_url: https://auth.example.com
token: TOKEN
delegate_to: localhost
"""
RETURN = r"""
users:
description: List of users in the specified realm.
returned: always
type: list
elements: dict
sample:
- id: "1234-5678-90"
username: "user1"
email: "user1@example.com"
- id: "2345-6789-01"
username: "user2"
email: "user2@example.com"
"""
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.middleware_automation.keycloak.plugins.module_utils.identity.keycloak.keycloak import (
KeycloakAPI,
KeycloakError,
get_token,
keycloak_argument_spec,
)
def main():
argument_spec = keycloak_argument_spec()
meta_args = dict(
realm=dict(default="master"),
)
argument_spec.update(meta_args)
module = AnsibleModule(
argument_spec=argument_spec,
supports_check_mode=True,
required_one_of=(
[["token", "auth_realm", "auth_username", "auth_password", "auth_client_id", "auth_client_secret"]]
),
required_together=([["auth_username", "auth_password"]]),
required_by={"refresh_token": "auth_realm"},
)
result = dict(changed=False, msg="", users="")
# Obtain access token, initialize API
try:
connection_header = get_token(module.params)
except KeycloakError as e:
module.fail_json(msg=str(e))
kc = KeycloakAPI(module, connection_header)
realm = module.params.get("realm")
result["users"] = kc.get_realm_users(realm=realm)
module.exit_json(**result)
if __name__ == "__main__":
main()
+2
View File
@@ -3,7 +3,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_role
+2
View File
@@ -3,7 +3,9 @@
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_user
@@ -3,7 +3,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_user_execute_actions_email
@@ -3,7 +3,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_user_federation
@@ -2,7 +2,9 @@
# Copyright (c) 2022, Dušan Marković (@bratwurzt)
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_user_rolemapping
+2
View File
@@ -3,7 +3,9 @@
# 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
from __future__ import (absolute_import, division, print_function)
from __future__ import annotations
__metaclass__ = type
DOCUMENTATION = r"""
module: keycloak_userprofile
+2 -2
View File
@@ -388,6 +388,6 @@ argument_specs:
description: "Red Hat SSO patch archive filename"
type: "str"
sso_product_category:
default: "core.service.rhsso"
description: "JBossNetwork API category for Single Sign-On"
default: "CORE.SERVICE.RHSSO"
description: "Unified Downloads API category for Single Sign-On"
type: "str"
+5 -5
View File
@@ -1,24 +1,24 @@
---
- name: "Check if packages are already installed" # noqa command-instead-of-module this runs faster
ansible.builtin.command: "rpm -q {{ packages_list | join(' ') }}"
register: rpm_info
register: keycloak_rpm_info
changed_when: false
failed_when: false
when: ansible_facts.os_family == "RedHat"
- name: "Add missing packages to the yum install list"
ansible.builtin.set_fact:
packages_to_install: "{{ packages_to_install | default([]) + rpm_info.stdout_lines | \
keycloak_packages_to_install: "{{ keycloak_packages_to_install | default([]) + keycloak_rpm_info.stdout_lines | \
map('regex_findall', 'package (.+) is not installed$') | default([]) | flatten }}"
when: ansible_facts.os_family == "RedHat"
- name: "Install packages: {{ packages_to_install }}"
- name: "Install packages: {{ keycloak_packages_to_install }}"
become: "{{ keycloak_fastpackages_require_privilege_escalation | default(true) }}"
ansible.builtin.dnf:
name: "{{ packages_to_install }}"
name: "{{ keycloak_packages_to_install }}"
state: present
when:
- packages_to_install | default([]) | length > 0
- keycloak_packages_to_install | default([]) | length > 0
- ansible_facts.os_family == "RedHat"
- name: "Install packages: {{ packages_list }}"
+1 -1
View File
@@ -12,7 +12,7 @@
enabled: true
state: started
- name: "Configure firewall ports for {{ keycloak.service_name }}"
- name: "Configure firewall ports for {{ keycloak_config.service_name }}"
become: "{{ keycloak_firewalld_require_privilege_escalation | default(true) }}"
ansible.posix.firewalld:
port: "{{ item }}"
+61 -54
View File
@@ -14,18 +14,18 @@
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
ansible.builtin.stat:
path: "{{ keycloak_jboss_home }}"
register: existing_deploy
register: keycloak_existing_deploy
- name: Stop and restart if existing deployment exists and install forced
when: existing_deploy.stat.exists and keycloak_force_install | bool
when: keycloak_existing_deploy.stat.exists and keycloak_force_install | bool
block:
- name: "Stop the old {{ keycloak.service_name }} service"
- name: "Stop the old service: {{ keycloak_config.service_name }}"
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
failed_when: false
ansible.builtin.systemd:
name: keycloak
state: stopped
- name: "Remove the old {{ keycloak.service_name }} deployment"
- name: "Remove the old deployment: {{ keycloak_config.service_name }}"
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
ansible.builtin.file:
path: "{{ keycloak_jboss_home }}"
@@ -36,7 +36,7 @@
ansible.builtin.stat:
path: "{{ keycloak_jboss_home }}"
- name: "Create service user/group for {{ keycloak.service_name }}"
- name: "Create service user/group for {{ keycloak_config.service_name }}"
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
ansible.builtin.user:
name: "{{ keycloak_service_user }}"
@@ -44,7 +44,7 @@
system: true
create_home: false
- name: "Create install location for {{ keycloak.service_name }}"
- name: "Create install location for {{ keycloak_config.service_name }}"
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
ansible.builtin.file:
dest: "{{ keycloak_dest }}"
@@ -65,34 +65,35 @@
## check remote archive
- name: Set download archive path
ansible.builtin.set_fact:
archive: "{{ keycloak_dest }}/{{ keycloak.bundle }}"
keycloak_archive_full_path: "{{ keycloak_dest }}/{{ keycloak_archive }}"
- name: Check download archive path
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
ansible.builtin.stat:
path: "{{ archive }}"
register: archive_path
path: "{{ keycloak_archive_full_path }}"
register: keycloak_archive_path
## download to controller
- name: Check local download archive path
ansible.builtin.stat:
path: "{{ lookup('env', 'PWD') }}"
register: local_path
register: keycloak_local_path
delegate_to: localhost
- name: Download keycloak archive
ansible.builtin.get_url: # noqa risky-file-permissions delegated, uses controller host user
url: "{{ keycloak_download_url }}"
dest: "{{ local_path.stat.path }}/{{ keycloak.bundle }}"
dest: "{{ keycloak_local_path.stat.path }}/{{ keycloak_archive }}"
mode: '0644'
url_username: "{{ keycloak_binary_download_user | default(omit) }}"
url_password: "{{ keycloak_binary_download_pass | default(omit) }}"
validate_certs: "{{ keycloak_download_validate_certs | default(omit) }}"
delegate_to: localhost
run_once: true
when:
- archive_path is defined
- archive_path.stat is defined
- not archive_path.stat.exists
- keycloak_archive_path is defined
- keycloak_archive_path.stat is defined
- not keycloak_archive_path.stat.exists
- not sso_enable is defined or not sso_enable
- not keycloak_offline_install
@@ -100,9 +101,9 @@
delegate_to: localhost
run_once: true
when:
- archive_path is defined
- archive_path.stat is defined
- not archive_path.stat.exists
- keycloak_archive_path is defined
- keycloak_archive_path.stat is defined
- not keycloak_archive_path.stat.exists
- sso_enable is defined and sso_enable
- not keycloak_offline_install
block:
@@ -113,14 +114,18 @@
product_type: DISTRIBUTION
product_version: "{{ sso_version.split('.')[:2] | join('.') }}"
product_category: "{{ sso_product_category }}"
register: rhn_products
validate_certs: "{{ keycloak_download_validate_certs | default(omit) }}"
register: keycloak_rhn_products
no_log: "{{ omit_rhn_output | default(true) }}"
delegate_to: localhost
run_once: true
- name: Determine install zipfile from search results
ansible.builtin.set_fact:
rhn_filtered_products: "{{ rhn_products.results | selectattr('file_name', 'match', '[^/]*/' + sso_archive + '$') }}"
keycloak_rhn_filtered_products: >-
{{ keycloak_rhn_products.results
| selectattr('file_name', 'search', 'rh-sso-' + sso_version + '-server-dist.zip$')
| list }}
delegate_to: localhost
run_once: true
@@ -128,8 +133,9 @@
middleware_automation.common.product_download: # noqa risky-file-permissions delegated, uses controller host user
client_id: "{{ rhn_username }}"
client_secret: "{{ rhn_password }}"
product_id: "{{ (rhn_filtered_products | first).id }}"
dest: "{{ local_path.stat.path }}/{{ keycloak.bundle }}"
product_id: "{{ (keycloak_rhn_filtered_products | first).id }}"
dest: "{{ keycloak_local_path.stat.path }}/{{ keycloak_archive }}"
validate_certs: "{{ keycloak_download_validate_certs | default(omit) }}"
no_log: "{{ omit_rhn_output | default(true) }}"
delegate_to: localhost
run_once: true
@@ -137,68 +143,69 @@
- name: Download rhsso archive from alternate location
ansible.builtin.get_url: # noqa risky-file-permissions delegated, uses controller host user
url: "{{ keycloak_rhsso_download_url }}"
dest: "{{ local_path.stat.path }}/{{ keycloak.bundle }}"
dest: "{{ keycloak_local_path.stat.path }}/{{ keycloak_archive }}"
mode: '0644'
validate_certs: "{{ keycloak_download_validate_certs | default(omit) }}"
delegate_to: localhost
run_once: true
when:
- archive_path is defined
- archive_path.stat is defined
- not archive_path.stat.exists
- keycloak_archive_path is defined
- keycloak_archive_path.stat is defined
- not keycloak_archive_path.stat.exists
- sso_enable is defined and sso_enable
- not keycloak_offline_install
- keycloak_rhsso_download_url is defined
- name: Check downloaded archive
ansible.builtin.stat:
path: "{{ local_path.stat.path }}/{{ keycloak.bundle }}"
register: local_archive_path
path: "{{ keycloak_local_path.stat.path }}/{{ keycloak_archive }}"
register: keycloak_local_archive_path
delegate_to: localhost
## copy and unpack
- name: Copy archive to target nodes
ansible.builtin.copy:
src: "{{ local_path.stat.path }}/{{ keycloak.bundle }}"
dest: "{{ archive }}"
src: "{{ keycloak_local_path.stat.path }}/{{ keycloak_archive }}"
dest: "{{ keycloak_archive_full_path }}"
owner: "{{ keycloak_service_user }}"
group: "{{ keycloak_service_group }}"
mode: '0640'
register: new_version_downloaded
register: keycloak_new_version_downloaded
when:
- not archive_path.stat.exists
- local_archive_path.stat is defined
- local_archive_path.stat.exists
- not keycloak_archive_path.stat.exists
- keycloak_local_archive_path.stat is defined
- keycloak_local_archive_path.stat.exists
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
- name: "Check target directory: {{ keycloak.home }}"
- name: "Check target directory: {{ keycloak_config.home }}"
ansible.builtin.stat:
path: "{{ keycloak.home }}"
register: path_to_workdir
path: "{{ keycloak_config.home }}"
register: keycloak_path_to_workdir
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
- name: "Extract {{ keycloak_service_desc }} archive on target"
- name: "Extract archive on target: {{ keycloak_service_desc }}"
ansible.builtin.unarchive:
remote_src: true
src: "{{ archive }}"
src: "{{ keycloak_archive_full_path }}"
dest: "{{ keycloak_dest }}"
creates: "{{ keycloak.home }}"
creates: "{{ keycloak_config.home }}"
owner: "{{ keycloak_service_user }}"
group: "{{ keycloak_service_group }}"
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
when:
- new_version_downloaded.changed or not path_to_workdir.stat.exists
- keycloak_new_version_downloaded.changed or not keycloak_path_to_workdir.stat.exists
notify:
- restart keycloak
- name: Inform decompression was not executed
ansible.builtin.debug:
msg: "{{ keycloak.home }} already exists and version unchanged, skipping decompression"
msg: "{{ keycloak_config.home }} already exists and version unchanged, skipping decompression"
when:
- not new_version_downloaded.changed and path_to_workdir.stat.exists
- not keycloak_new_version_downloaded.changed and keycloak_path_to_workdir.stat.exists
- name: "Reown installation directory to {{ keycloak_service_user }}"
ansible.builtin.file:
path: "{{ keycloak.home }}"
path: "{{ keycloak_config.home }}"
owner: "{{ keycloak_service_user }}"
group: "{{ keycloak_service_group }}"
recurse: true
@@ -206,17 +213,17 @@
changed_when: false
- name: Ensure permissions are correct on existing deploy
ansible.builtin.command: chown -R "{{ keycloak_service_user }}:{{ keycloak_service_group }}" "{{ keycloak.home }}"
ansible.builtin.command: chown -R "{{ keycloak_service_user }}:{{ keycloak_service_group }}" "{{ keycloak_config.home }}"
when: keycloak_service_runas
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
changed_when: false
# driver and configuration
- name: "Install {{ keycloak_jdbc_engine }} driver"
- name: "Install database driver: {{ keycloak_jdbc_engine }}"
ansible.builtin.include_tasks: jdbc_driver.yml
when: keycloak_jdbc[keycloak_jdbc_engine].enabled
- name: "Deploy custom {{ keycloak.service_name }} config to {{ keycloak_config_path_to_standalone_xml }} from {{ keycloak_config_override_template }}"
- name: "Deploy custom config: {{ keycloak_config.service_name }}"
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
ansible.builtin.template:
src: "templates/{{ keycloak_config_override_template }}"
@@ -226,9 +233,9 @@
mode: '0640'
notify:
- restart keycloak
when: keycloak_config_override_template | length > 0
when: (keycloak_config_override_template | default('', true)) | length > 0
- name: "Deploy standalone {{ keycloak.service_name }} config to {{ keycloak_config_path_to_standalone_xml }}"
- name: "Deploy standalone config: {{ keycloak_config.service_name }}"
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
ansible.builtin.template:
src: templates/standalone.xml.j2
@@ -240,7 +247,7 @@
- restart keycloak
when:
- not keycloak_ha_enabled
- keycloak_config_override_template | length == 0
- (keycloak_config_override_template | default('', true)) | length == 0
- name: Create tcpping cluster node list
ansible.builtin.set_fact:
@@ -256,7 +263,7 @@
loop: "{{ ansible_play_batch }}"
when: keycloak_ha_enabled and keycloak_ha_discovery == 'TCPPING'
- name: "Deploy HA {{ keycloak.service_name }} config to {{ keycloak_config_path_to_standalone_xml }}"
- name: "Deploy HA config: {{ keycloak_config.service_name }}"
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
ansible.builtin.template:
src: templates/standalone-ha.xml.j2
@@ -269,9 +276,9 @@
when:
- keycloak_ha_enabled
- not keycloak_remote_cache_enabled
- keycloak_config_override_template | length == 0
- (keycloak_config_override_template | default('', true)) | length == 0
- name: "Deploy HA {{ keycloak.service_name }} config with infinispan remote cache store to {{ keycloak_config_path_to_standalone_xml }}"
- name: "Deploy HA config with infinispan: {{ keycloak_config.service_name }}"
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
ansible.builtin.template:
src: templates/standalone-infinispan.xml.j2
@@ -284,7 +291,7 @@
when:
- keycloak_ha_enabled
- keycloak_remote_cache_enabled
- keycloak_config_override_template | length == 0
- (keycloak_config_override_template | default('', true)) | length == 0
- name: "Deploy profile.properties file to {{ keycloak_config_path_to_properties }}"
become: "{{ keycloak_install_require_privilege_escalation | default(true) }}"
@@ -296,4 +303,4 @@
mode: '0640'
notify:
- restart keycloak
when: keycloak_features | length > 0
when: (keycloak_features | default([], true)) | length > 0
+1 -1
View File
@@ -5,7 +5,7 @@
packages_list:
- iptables
- name: "Configure firewall ports for {{ keycloak.service_name }}"
- name: "Configure firewall ports for {{ keycloak_config.service_name }}"
become: "{{ keycloak_iptables_require_privilege_escalation | default(true) }}"
ansible.builtin.iptables:
destination_port: "{{ item }}"
+1 -1
View File
@@ -2,7 +2,7 @@
- name: "Check module directory: {{ keycloak_jdbc[keycloak_jdbc_engine].driver_module_dir }}"
ansible.builtin.stat:
path: "{{ keycloak_jdbc[keycloak_jdbc_engine].driver_module_dir }}"
register: dest_path
register: keycloak_dest_path
become: "{{ keycloak_jdbc_driver_require_privilege_escalation | default(true) }}"
- name: "Set up module dir for JDBC Driver {{ keycloak_jdbc[keycloak_jdbc_engine].driver_module_name }}"
+6 -5
View File
@@ -60,13 +60,13 @@
url: "{{ keycloak_url }}/auth/realms/master/protocol/openid-connect/token"
method: POST
body: "client_id={{ keycloak_auth_client }}&username={{ keycloak_admin_user }}&password={{ keycloak_admin_password }}&grant_type=password"
validate_certs: false
validate_certs: "{{ keycloak_validate_certs | default(omit) }}"
register: keycloak_auth_response
until: keycloak_auth_response.status == 200
retries: 2
delay: 2
rescue:
- name: "Create {{ keycloak.service_name }} admin user"
- name: "Create admin user: {{ keycloak_config.service_name }}"
ansible.builtin.command:
args:
argv:
@@ -76,11 +76,12 @@
- "-p{{ keycloak_admin_password }}"
changed_when: true
become: "{{ keycloak_require_privilege_escalation | default(true) }}"
- name: "Restart {{ keycloak.service_name }}"
- name: "Restart service: {{ keycloak_config.service_name }}"
ansible.builtin.include_tasks: tasks/restart_keycloak.yml
- name: "Wait until {{ keycloak.service_name }} becomes active {{ keycloak.health_url }}"
- name: "Wait until service becomes active: {{ keycloak_config.service_name }}"
ansible.builtin.uri:
url: "{{ keycloak.health_url }}"
url: "{{ keycloak_config.health_url }}"
validate_certs: "{{ keycloak_validate_certs | default(omit) }}"
register: keycloak_status
until: keycloak_status.status == 200
retries: 25
+4 -4
View File
@@ -2,7 +2,7 @@
- name: Validate admin console password
ansible.builtin.assert:
that:
- keycloak_admin_password | length > 12
- (keycloak_admin_password | default('', true)) | length > 12
quiet: true
fail_msg: >
The console administrator password is empty or invalid. Please set the keycloak_admin_password variable to a 12+ char long string
@@ -31,9 +31,9 @@
ansible.builtin.assert:
that:
- keycloak_jdbc_engine is defined and keycloak_jdbc_engine in [ 'postgres', 'mariadb', 'sqlserver' ]
- keycloak_jdbc_url | length > 0
- keycloak_db_user | length > 0
- keycloak_db_pass | length > 0
- (keycloak_jdbc_url | default('', true)) | length > 0
- (keycloak_db_user | default('', true)) | length > 0
- (keycloak_db_pass | default('', true)) | length > 0
quiet: true
fail_msg: "Configuration for the JDBC persistence is invalid or incomplete"
success_msg: "Configuring JDBC persistence using {{ keycloak_jdbc_engine }} database"
+5 -4
View File
@@ -1,5 +1,5 @@
---
- name: "Restart and enable {{ keycloak.service_name }} service"
- name: "Restart and enable service: {{ keycloak_config.service_name }}"
ansible.builtin.systemd:
name: keycloak
enabled: true
@@ -9,9 +9,10 @@
delegate_to: "{{ ansible_play_hosts | first }}"
run_once: true
- name: "Wait until {{ keycloak.service_name }} becomes active {{ keycloak.health_url }}"
- name: "Wait until service becomes active: {{ keycloak_config.service_name }}"
ansible.builtin.uri:
url: "{{ keycloak.health_url }}"
url: "{{ keycloak_config.health_url }}"
validate_certs: "{{ keycloak_validate_certs | default(omit) }}"
register: keycloak_status
until: keycloak_status.status == 200
delegate_to: "{{ ansible_play_hosts | first }}"
@@ -19,7 +20,7 @@
retries: "{{ keycloak_service_start_retries }}"
delay: "{{ keycloak_service_start_delay }}"
- name: "Restart and enable {{ keycloak.service_name }} service"
- name: "Restart and enable service (remaining nodes): {{ keycloak_config.service_name }}"
ansible.builtin.systemd:
name: keycloak
enabled: true
+2 -2
View File
@@ -8,6 +8,6 @@
- name: "Execute CLI query: {{ cli_query }}"
ansible.builtin.command: >
{{ keycloak.cli_path }} --connect --command='{{ cli_query }}' --controller={{ keycloak_host }}:{{ keycloak_management_http_port }}
{{ keycloak_config.cli_path }} --connect --command='{{ cli_query }}' --controller={{ keycloak_host }}:{{ keycloak_management_http_port }}
changed_when: false
register: cli_result
register: keycloak_cli_result
+44 -41
View File
@@ -2,15 +2,15 @@
## check remote patch archive
- name: Set download patch archive path
ansible.builtin.set_fact:
patch_archive: "{{ keycloak_dest }}/{{ sso_patch_bundle }}"
patch_bundle: "{{ sso_patch_bundle }}"
patch_version: "{{ sso_patch_version }}"
keycloak_patch_archive: "{{ keycloak_dest }}/{{ sso_patch_bundle }}"
keycloak_patch_bundle: "{{ sso_patch_bundle }}"
keycloak_patch_version: "{{ sso_patch_version }}"
when: sso_patch_version is defined
- name: Check download patch archive path
ansible.builtin.stat:
path: "{{ patch_archive }}"
register: patch_archive_path
path: "{{ keycloak_patch_archive }}"
register: keycloak_patch_archive_path
when: sso_patch_version is defined
become: "{{ keycloak_rhsso_patch_require_privilege_escalation | default(true) }}"
@@ -29,41 +29,42 @@
product_type: BUGFIX
product_version: "{{ sso_version.split('.')[:2] | join('.') }}"
product_category: "{{ sso_product_category }}"
register: rhn_products
validate_certs: "{{ keycloak_download_validate_certs | default(omit) }}"
register: keycloak_rhn_products
no_log: "{{ omit_rhn_output | default(true) }}"
delegate_to: localhost
run_once: true
- name: Determine patch versions list
ansible.builtin.set_fact:
filtered_versions: "{{ rhn_products.results | map(attribute='file_name') | \
keycloak_filtered_versions: "{{ keycloak_rhn_products.results | map(attribute='file_name') | \
select('match', '^[^/]*/rh-sso-.*[0-9]*[.][0-9]*[.][0-9]*.*$') | \
map('regex_replace', '[^/]*/rh-sso-([0-9]*[.][0-9]*[.][0-9]*(-[0-9])?)-.*', '\\1') | list | unique }}"
when: sso_patch_version is not defined or sso_patch_version | length == 0
when: (sso_patch_version | default('', true)) | length == 0
delegate_to: localhost
run_once: true
- name: Determine latest version
ansible.builtin.set_fact:
sso_latest_version: "{{ filtered_versions | middleware_automation.common.version_sort | last }}"
when: sso_patch_version is not defined or sso_patch_version | length == 0
keycloak_sso_latest_version: "{{ keycloak_filtered_versions | middleware_automation.common.version_sort | last }}"
when: (sso_patch_version | default('', true)) | length == 0
delegate_to: localhost
run_once: true
- name: Determine install zipfile from search results
ansible.builtin.set_fact:
rhn_filtered_products: "{{ rhn_products.results | selectattr('file_name', 'match', '[^/]*/rh-sso-' + sso_latest_version + '-patch.zip$') }}"
patch_bundle: "rh-sso-{{ sso_latest_version }}-patch.zip"
patch_version: "{{ sso_latest_version }}"
when: sso_patch_version is not defined or sso_patch_version | length == 0
keycloak_rhn_filtered_products: "{{ keycloak_rhn_products.results | selectattr('file_name', 'match', '[^/]*/rh-sso-' + keycloak_sso_latest_version + '-patch.zip$') }}"
keycloak_patch_bundle: "rh-sso-{{ keycloak_sso_latest_version }}-patch.zip"
keycloak_patch_version: "{{ keycloak_sso_latest_version }}"
when: (sso_patch_version | default('', true)) | length == 0
delegate_to: localhost
run_once: true
- name: "Determine selected patch from supplied version: {{ sso_patch_version }}"
ansible.builtin.set_fact:
rhn_filtered_products: "{{ rhn_products.results | selectattr('file_name', 'match', '[^/]*/' + sso_patch_bundle + '$') }}"
patch_bundle: "{{ sso_patch_bundle }}"
patch_version: "{{ sso_patch_version }}"
keycloak_rhn_filtered_products: "{{ keycloak_rhn_products.results | selectattr('file_name', 'match', '[^/]*/' + sso_patch_bundle + '$') }}"
keycloak_patch_bundle: "{{ sso_patch_bundle }}"
keycloak_patch_version: "{{ sso_patch_version }}"
when: sso_patch_version is defined
delegate_to: localhost
run_once: true
@@ -72,35 +73,36 @@
middleware_automation.common.product_download: # noqa risky-file-permissions delegated, uses controller host user
client_id: "{{ rhn_username }}"
client_secret: "{{ rhn_password }}"
product_id: "{{ (rhn_filtered_products | sort | last).id }}"
dest: "{{ local_path.stat.path }}/{{ patch_bundle }}"
product_id: "{{ (keycloak_rhn_filtered_products | sort | last).id }}"
dest: "{{ keycloak_local_path.stat.path }}/{{ keycloak_patch_bundle }}"
validate_certs: "{{ keycloak_download_validate_certs | default(omit) }}"
no_log: "{{ omit_rhn_output | default(true) }}"
delegate_to: localhost
run_once: true
- name: Set download patch archive path
ansible.builtin.set_fact:
patch_archive: "{{ keycloak_dest }}/{{ patch_bundle }}"
keycloak_patch_archive: "{{ keycloak_dest }}/{{ keycloak_patch_bundle }}"
- name: Check download patch archive path
ansible.builtin.stat:
path: "{{ patch_archive }}"
register: patch_archive_path
path: "{{ keycloak_patch_archive }}"
register: keycloak_patch_archive_path
become: "{{ keycloak_rhsso_patch_require_privilege_escalation | default(true) }}"
## copy and unpack
- name: Copy patch archive to target nodes
ansible.builtin.copy:
src: "{{ local_path.stat.path }}/{{ patch_bundle }}"
dest: "{{ patch_archive }}"
src: "{{ keycloak_local_path.stat.path }}/{{ keycloak_patch_bundle }}"
dest: "{{ keycloak_patch_archive }}"
owner: "{{ keycloak_service_user }}"
group: "{{ keycloak_service_group }}"
mode: '0640'
register: new_version_downloaded
register: keycloak_new_version_downloaded
when:
- not patch_archive_path.stat.exists
- local_archive_path.stat is defined
- local_archive_path.stat.exists
- not keycloak_patch_archive_path.stat.exists
- keycloak_local_archive_path.stat is defined
- keycloak_local_archive_path.stat.exists
become: "{{ keycloak_rhsso_patch_require_privilege_escalation | default(true) }}"
- name: "Check installed patches"
@@ -114,14 +116,14 @@
- name: "Perform patching"
when:
- cli_result is defined
- cli_result.stdout is defined
- patch_version | regex_replace('-[0-9]$', '') not in cli_result.stdout
- keycloak_cli_result is defined
- keycloak_cli_result.stdout is defined
- keycloak_patch_version | regex_replace('-[0-9]$', '') not in keycloak_cli_result.stdout
block:
- name: "Apply patch {{ patch_version }} to server"
- name: "Apply patch to server: {{ keycloak_patch_version }}"
ansible.builtin.include_tasks: rhsso_cli.yml
vars:
cli_query: "patch apply {{ patch_archive }}"
cli_query: "patch apply {{ keycloak_patch_archive }}"
args:
apply:
become: "{{ keycloak_rhsso_patch_require_privilege_escalation | default(true) }}"
@@ -132,15 +134,16 @@
vars:
cli_query: "shutdown --restart"
when:
- cli_result.rc == 0
- keycloak_cli_result.rc == 0
args:
apply:
become: "{{ keycloak_rhsso_patch_require_privilege_escalation | default(true) }}"
become_user: "{{ keycloak_service_user }}"
- name: "Wait until {{ keycloak.service_name }} becomes active {{ keycloak.health_url }}"
- name: "Wait until service becomes active: {{ keycloak_config.service_name }}"
ansible.builtin.uri:
url: "{{ keycloak.health_url }}"
url: "{{ keycloak_config.health_url }}"
validate_certs: "{{ keycloak_validate_certs | default(omit) }}"
register: keycloak_status
until: keycloak_status.status == 200
retries: 25
@@ -158,14 +161,14 @@
- name: "Verify installed patch version"
ansible.builtin.assert:
that:
- patch_version not in cli_result.stdout
- keycloak_patch_version not in keycloak_cli_result.stdout
fail_msg: "Patch installation failed"
success_msg: "Patch installation successful"
- name: "Skipping patch"
ansible.builtin.debug:
msg: "Cumulative patch {{ patch_version }} already installed, skipping patch installation."
msg: "Cumulative patch {{ keycloak_patch_version }} already installed, skipping patch installation."
when:
- cli_result is defined
- cli_result.stdout is defined
- patch_version in cli_result.stdout
- keycloak_cli_result is defined
- keycloak_cli_result.stdout is defined
- keycloak_patch_version in keycloak_cli_result.stdout
+4 -3
View File
@@ -1,5 +1,5 @@
---
- name: "Start {{ keycloak.service_name }} service"
- name: "Start service: {{ keycloak_config.service_name }}"
ansible.builtin.systemd:
name: keycloak
enabled: true
@@ -7,9 +7,10 @@
daemon_reload: true
become: "{{ keycloak_start_require_privilege_escalation | default(true) }}"
- name: "Wait until {{ keycloak.service_name }} becomes active {{ keycloak.health_url }}"
- name: "Wait until service becomes active: {{ keycloak_config.service_name }}"
ansible.builtin.uri:
url: "{{ keycloak.health_url }}"
url: "{{ keycloak_config.health_url }}"
validate_certs: "{{ keycloak_validate_certs | default(omit) }}"
register: keycloak_status
until: keycloak_status.status == 200
retries: "{{ keycloak_service_start_retries }}"
+1 -1
View File
@@ -1,5 +1,5 @@
---
- name: "Stop {{ keycloak.service_name }}"
- name: "Stop {{ keycloak_config.service_name }}"
ansible.builtin.systemd:
name: keycloak
enabled: true
+6 -6
View File
@@ -1,5 +1,5 @@
---
- name: "Configure {{ keycloak.service_name }} service script wrapper"
- name: "Configure service script wrapper: {{ keycloak_config.service_name }}"
become: "{{ keycloak_systemd_require_privilege_escalation | default(true) }}"
ansible.builtin.template:
src: keycloak-service.sh.j2
@@ -10,7 +10,7 @@
notify:
- restart keycloak
- name: "Configure sysconfig file for {{ keycloak.service_name }} service"
- name: "Configure sysconfig file for service: {{ keycloak_config.service_name }}"
become: "{{ keycloak_systemd_require_privilege_escalation | default(true) }}"
ansible.builtin.template:
src: keycloak-sysconfig.j2
@@ -21,7 +21,7 @@
notify:
- restart keycloak
- name: "Configure systemd unit file for {{ keycloak.service_name }} service"
- name: "Configure systemd unit file for service: {{ keycloak_config.service_name }}"
ansible.builtin.template:
src: keycloak.service.j2
dest: /etc/systemd/system/keycloak.service
@@ -29,16 +29,16 @@
group: root
mode: '0644'
become: "{{ keycloak_systemd_require_privilege_escalation | default(true) }}"
register: systemdunit
register: keycloak_systemdunit
notify:
- restart keycloak
- name: "Start and wait for {{ keycloak.service_name }} service (first node db)"
- name: "Start and wait for service (first node db): {{ keycloak_config.service_name }}"
ansible.builtin.include_tasks: start_keycloak.yml
run_once: true
when: keycloak_db_enabled
- name: "Start and wait for {{ keycloak.service_name }} service (remaining nodes)"
- name: "Start and wait for service (remaining nodes): {{ keycloak_config.service_name }}"
ansible.builtin.include_tasks: start_keycloak.yml
- name: Check service status

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