ansible-collections/middleware_automation.keycloak
1
0
Fork 0
mirror of https://github.com/ansible-middleware/keycloak.git synced 2025-04-05 10:20:27 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update docs for main

Browse source 
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
This commit is contained in:
ansible-middleware-core 2024-09-26 08:36:27 +00:00
parent 802c0f549c
commit 8432954b31
12 changed files with 325 additions and 319 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

588
main/CHANGELOG.html
View file

File diff suppressed because it is too large Load diff

5
main/_sources/CHANGELOG.rst.txt
View file

@ -9,6 +9,11 @@ This changelog describes changes after version 0.2.6.
v2.4.2-devel
============
Minor Changes
-------------
- New parameter ``keycloak_quarkus_download_path`` `#239 <https://github.com/ansible-middleware/keycloak/pull/239>`_
Bugfixes
--------

12
main/_sources/plugins/keycloak_client.rst.txt
View file

@ -1,4 +1,3 @@
.. Document meta
:orphan:
@ -7,7 +6,7 @@
:trim:
.. meta::
:antsibull-docs: 2.12.0
:antsibull-docs: 2.14.0
.. Anchors
@ -48,7 +47,7 @@ Synopsis
.. Description
- This module allows the administration of Keycloak clients via the Keycloak REST API. It requires access to the REST API via 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 \ https://www.keycloak.org/docs-api/8.0/rest-api/index.html\ . Aliases are provided so camelCased versions can be used as well.
- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs-api/8.0/rest-api/index.html <https://www.keycloak.org/docs-api/8.0/rest-api/index.html>`__. Aliases are provided so camelCased versions can be used as well.
- The Keycloak API does not always sanity check inputs e.g. you can set SAML-specific settings on an OpenID Connect client for instance and vice versa. Be careful. If you do not specify a setting, usually a sensible default is chosen.
@ -1443,7 +1442,7 @@ Attributes
<div class="ansible-option-cell">
Can run in \ :literal:`check\_mode`\ and return changed status prediction without modifying target.
Can run in :literal:`check\_mode` and return changed status prediction without modifying target.
.. raw:: html
@ -1485,7 +1484,7 @@ Attributes
<div class="ansible-option-cell">
Will return details on what has changed (or possibly needs changing in \ :literal:`check\_mode`\ ), when in diff mode.
Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode.
.. raw:: html
@ -1507,7 +1506,6 @@ Examples
.. code-block:: yaml+jinja
- name: Create or update Keycloak client (minimal example), authentication with credentials
middleware_automation.keycloak.keycloak_client:
auth_keycloak_url: https://auth.example.com/auth
@ -1634,7 +1632,6 @@ Examples
.. Facts
@ -1735,4 +1732,3 @@ Authors
.. Parsing errors

12
main/_sources/plugins/keycloak_role.rst.txt
View file

@ -1,4 +1,3 @@
.. Document meta
:orphan:
@ -7,7 +6,7 @@
:trim:
.. meta::
:antsibull-docs: 2.12.0
:antsibull-docs: 2.14.0
.. Anchors
@ -51,7 +50,7 @@ Synopsis
.. Description
- This module allows you to add, remove or modify Keycloak roles via the Keycloak REST API. It requires access to the REST API via 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 \ https://www.keycloak.org/docs-api/8.0/rest-api/index.html\ .
- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs-api/8.0/rest-api/index.html <https://www.keycloak.org/docs-api/8.0/rest-api/index.html>`__.
- Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and will be returned that way by this module. You may pass single values for attributes when calling the module, and this will be translated into a list suitable for the API.
@ -377,7 +376,7 @@ Attributes
<div class="ansible-option-cell">
Can run in \ :literal:`check\_mode`\ and return changed status prediction without modifying target.
Can run in :literal:`check\_mode` and return changed status prediction without modifying target.
.. raw:: html
@ -419,7 +418,7 @@ Attributes
<div class="ansible-option-cell">
Will return details on what has changed (or possibly needs changing in \ :literal:`check\_mode`\ ), when in diff mode.
Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode.
.. raw:: html
@ -441,7 +440,6 @@ Examples
.. code-block:: yaml+jinja
- name: Create a Keycloak realm role, authentication with credentials
middleware_automation.keycloak.keycloak_role:
name: my-new-kc-role
@ -509,7 +507,6 @@ Examples
.. Facts
@ -610,4 +607,3 @@ Authors
.. Parsing errors

12
main/_sources/plugins/keycloak_user_federation.rst.txt
View file

@ -1,4 +1,3 @@
.. Document meta
:orphan:
@ -7,7 +6,7 @@
:trim:
.. meta::
:antsibull-docs: 2.12.0
:antsibull-docs: 2.14.0
.. Anchors
@ -51,7 +50,7 @@ Synopsis
.. Description
- This module allows you to add, remove or modify Keycloak user federations via the Keycloak REST API. It requires access to the REST API via 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 \ https://www.keycloak.org/docs-api/20.0.2/rest-api/index.html\ .
- The names of module options are snake\_cased versions of the camelCase ones found in the Keycloak API and its documentation at \ `https://www.keycloak.org/docs-api/20.0.2/rest-api/index.html <https://www.keycloak.org/docs-api/20.0.2/rest-api/index.html>`__.
.. Aliases
@ -1276,7 +1275,7 @@ Attributes
<div class="ansible-option-cell">
Can run in \ :literal:`check\_mode`\ and return changed status prediction without modifying target.
Can run in :literal:`check\_mode` and return changed status prediction without modifying target.
.. raw:: html
@ -1318,7 +1317,7 @@ Attributes
<div class="ansible-option-cell">
Will return details on what has changed (or possibly needs changing in \ :literal:`check\_mode`\ ), when in diff mode.
Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode.
.. raw:: html
@ -1340,7 +1339,6 @@ Examples
.. code-block:: yaml+jinja
- name: Create LDAP user federation
middleware_automation.keycloak.keycloak_user_federation:
auth_keycloak_url: https://keycloak.example.com/auth
@ -1437,7 +1435,6 @@ Examples
.. Facts
@ -1538,4 +1535,3 @@ Authors
.. Parsing errors

1
main/_sources/roles/keycloak_quarkus.md.txt
View file

@ -37,6 +37,7 @@ Role Defaults
|`keycloak_quarkus_offline_install` | Perform an offline install | `False`|
|`keycloak_quarkus_dest`| Installation root path | `/opt/keycloak` |
|`keycloak_quarkus_download_url` | Download URL for keycloak | `https://github.com/keycloak/keycloak/releases/download/{{ keycloak_quarkus_version }}/{{ keycloak_quarkus_archive }}` |
|`keycloak_quarkus_download_path`| Path local to controller for offline/download of install archives | `{{ lookup('env', 'PWD') }}` |
#### Service configuration

2
main/_static/antsibull-minimal.css
View file

File diff suppressed because one or more lines are too long

2
main/plugins/keycloak_client.html
View file

@ -2,7 +2,7 @@
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta content="2.12.0" name="antsibull-docs" />
<meta content="2.14.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>keycloak_client – Allows administration of Keycloak clients via Keycloak API &mdash; Keycloak Ansible Collection documentation</title>

2
main/plugins/keycloak_role.html
View file

@ -2,7 +2,7 @@
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta content="2.12.0" name="antsibull-docs" />
<meta content="2.14.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>keycloak_role – Allows administration of Keycloak roles via Keycloak API &mdash; Keycloak Ansible Collection documentation</title>

2
main/plugins/keycloak_user_federation.html
View file

@ -2,7 +2,7 @@
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta content="2.12.0" name="antsibull-docs" />
<meta content="2.14.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>keycloak_user_federation – Allows administration of Keycloak user federations via Keycloak API &mdash; Keycloak Ansible Collection documentation</title>

4
main/roles/keycloak_quarkus.html
View file

@ -180,6 +180,10 @@
<td class="text-left"><p>Download URL for keycloak</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">https://github.com/keycloak/keycloak/releases/download/{{</span> <span class="pre">keycloak_quarkus_version</span> <span class="pre">}}/{{</span> <span class="pre">keycloak_quarkus_archive</span> <span class="pre">}}</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_download_path</span></code></p></td>
<td class="text-left"><p>Path local to controller for offline/download of install archives</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">lookup('env',</span> <span class="pre">'PWD')</span> <span class="pre">}}</span></code></p></td>
</tr>
</tbody>
</table>
</section>

2
main/searchindex.js
View file

File diff suppressed because one or more lines are too long