ansible-collections/middleware_automation.keycloak
1
0
Fork 0
mirror of https://github.com/ansible-middleware/keycloak.git synced 2025-07-24 13:50:33 -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 2025-04-18 07:12:15 +00:00
commit da9dae4a6a
5 changed files with 345 additions and 338 deletions
Download patch file Download diff file Expand all files Collapse all files

627
main/CHANGELOG.html
View file

File diff suppressed because it is too large Load diff

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

@ -20,13 +20,14 @@ Breaking Changes / Porting Guide
- Bump major and ansible-core versions `#266 <https://github.com/ansible-middleware/keycloak/pull/266>`_ - Bump major and ansible-core versions `#266 <https://github.com/ansible-middleware/keycloak/pull/266>`_
- Rename parameters to follow upstream `#270 <https://github.com/ansible-middleware/keycloak/pull/270>`_ - Rename parameters to follow upstream `#270 <https://github.com/ansible-middleware/keycloak/pull/270>`_
- Role support for keycloak v26 `#254 <https://github.com/ansible-middleware/keycloak/pull/254>`_ - Update for keycloak v26 `#254 <https://github.com/ansible-middleware/keycloak/pull/254>`_
Bugfixes Bugfixes
-------- --------
- Access token lifespan is too short for ansible run `#251 <https://github.com/ansible-middleware/keycloak/pull/251>`_ - Access token lifespan is too short for ansible run `#251 <https://github.com/ansible-middleware/keycloak/pull/251>`_
- Rebuild config and restart service for local providers `#250 <https://github.com/ansible-middleware/keycloak/pull/250>`_ - Rebuild config and restart service for local providers `#250 <https://github.com/ansible-middleware/keycloak/pull/250>`_
- Rename and honour parameter ``keycloak_quarkus_http_host`` `#271 <https://github.com/ansible-middleware/keycloak/pull/271>`_
New Modules New Modules
----------- -----------

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

@ -46,7 +46,7 @@ Role Defaults
|:---------|:------------|:--------| |:---------|:------------|:--------|
|`keycloak_quarkus_bootstrap_admin_user`| Administration console user account | `admin` | |`keycloak_quarkus_bootstrap_admin_user`| Administration console user account | `admin` |
|`keycloak_quarkus_admin_user`| Deprecated, use `keycloak_quarkus_bootstrap_admin_user` instead. | | |`keycloak_quarkus_admin_user`| Deprecated, use `keycloak_quarkus_bootstrap_admin_user` instead. | |
|`keycloak_quarkus_bind_address`| Address for binding service ports | `0.0.0.0` | |`keycloak_quarkus_bind_address`| Deprecated, use `keycloak_quarkus_http_host` instead | `0.0.0.0` |
|`keycloak_quarkus_host`| Deprecated, use `keycloak_quarkus_hostname` instead. | | |`keycloak_quarkus_host`| Deprecated, use `keycloak_quarkus_hostname` instead. | |
|`keycloak_quarkus_port`| Deprecated, use `keycloak_quarkus_hostname` instead. | | |`keycloak_quarkus_port`| Deprecated, use `keycloak_quarkus_hostname` instead. | |
|`keycloak_quarkus_path`| Deprecated, use `keycloak_quarkus_hostname` instead. | | |`keycloak_quarkus_path`| Deprecated, use `keycloak_quarkus_hostname` instead. | |
@ -107,6 +107,7 @@ Role Defaults
| Variable | Description | Default | | Variable | Description | Default |
|:---------|:------------|:--------| |:---------|:------------|:--------|
|`keycloak_quarkus_http_relative_path`| Set the path relative to / for serving resources. The path must start with a / | `/` | |`keycloak_quarkus_http_relative_path`| Set the path relative to / for serving resources. The path must start with a / | `/` |
|`keycloak_quarkus_http_host`| The http host, ie. the address used to bind the service | `0.0.0.0` |
|`keycloak_quarkus_http_port`| HTTP listening port | `8080` | |`keycloak_quarkus_http_port`| HTTP listening port | `8080` |
|`keycloak_quarkus_https_port`| TLS HTTP listening port | `8443` | |`keycloak_quarkus_https_port`| TLS HTTP listening port | `8443` |
|`keycloak_quarkus_http_management_port`| Port of the management interface. Relevant only when something is exposed on the management interface - see the guide for details. | `9000` | |`keycloak_quarkus_http_management_port`| Port of the management interface. Relevant only when something is exposed on the management interface - see the guide for details. | `9000` |

48
main/roles/keycloak_quarkus.html
View file

@ -203,7 +203,7 @@
<td class="text-left"><p></p></td> <td class="text-left"><p></p></td>
</tr> </tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_bind_address</span></code></p></td> <tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_bind_address</span></code></p></td>
<td class="text-left"><p>Address for binding service ports</p></td> <td class="text-left"><p>Deprecated, use <code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_http_host</span></code> instead</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">0.0.0.0</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">0.0.0.0</span></code></p></td>
</tr> </tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_host</span></code></p></td> <tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_host</span></code></p></td>
@ -417,87 +417,91 @@
<td class="text-left"><p>Set the path relative to / for serving resources. The path must start with a /</p></td> <td class="text-left"><p>Set the path relative to / for serving resources. The path must start with a /</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">/</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">/</span></code></p></td>
</tr> </tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_http_port</span></code></p></td> <tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_http_host</span></code></p></td>
<td class="text-left"><p>The http host, ie. the address used to bind the service</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">0.0.0.0</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_http_port</span></code></p></td>
<td class="text-left"><p>HTTP listening port</p></td> <td class="text-left"><p>HTTP listening port</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">8080</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">8080</span></code></p></td>
</tr> </tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_port</span></code></p></td> <tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_port</span></code></p></td>
<td class="text-left"><p>TLS HTTP listening port</p></td> <td class="text-left"><p>TLS HTTP listening port</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">8443</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">8443</span></code></p></td>
</tr> </tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_http_management_port</span></code></p></td> <tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_http_management_port</span></code></p></td>
<td class="text-left"><p>Port of the management interface. Relevant only when something is exposed on the management interface - see the guide for details.</p></td> <td class="text-left"><p>Port of the management interface. Relevant only when something is exposed on the management interface - see the guide for details.</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">9000</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">9000</span></code></p></td>
</tr> </tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_key_store_file</span></code></p></td> <tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_key_store_file</span></code></p></td>
<td class="text-left"><p>The file path to the key store</p></td> <td class="text-left"><p>The file path to the key store</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">keycloak.home</span> <span class="pre">}}/conf/key_store.p12</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">keycloak.home</span> <span class="pre">}}/conf/key_store.p12</span></code></p></td>
</tr> </tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_key_store_password</span></code></p></td> <tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_key_store_password</span></code></p></td>
<td class="text-left"><p>Password for the key store</p></td> <td class="text-left"><p>Password for the key store</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">&quot;&quot;</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">&quot;&quot;</span></code></p></td>
</tr> </tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_trust_store_enabled</span></code></p></td> <tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_trust_store_enabled</span></code></p></td>
<td class="text-left"><p>Enable configuration of the https trust store</p></td> <td class="text-left"><p>Enable configuration of the https trust store</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p></td>
</tr> </tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_trust_store_file</span></code></p></td> <tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_trust_store_file</span></code></p></td>
<td class="text-left"><p>The file path to the trust store</p></td> <td class="text-left"><p>The file path to the trust store</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">keycloak.home</span> <span class="pre">}}/conf/trust_store.p12</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">keycloak.home</span> <span class="pre">}}/conf/trust_store.p12</span></code></p></td>
</tr> </tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_trust_store_password</span></code></p></td> <tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_trust_store_password</span></code></p></td>
<td class="text-left"><p>Password for the trust store</p></td> <td class="text-left"><p>Password for the trust store</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">&quot;&quot;</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">&quot;&quot;</span></code></p></td>
</tr> </tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_key_file_enabled</span></code></p></td> <tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_key_file_enabled</span></code></p></td>
<td class="text-left"><p>Enable listener on HTTPS port</p></td> <td class="text-left"><p>Enable listener on HTTPS port</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p></td>
</tr> </tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_key_file_copy_enabled</span></code></p></td> <tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_key_file_copy_enabled</span></code></p></td>
<td class="text-left"><p>Enable copy of key file to target host</p></td> <td class="text-left"><p>Enable copy of key file to target host</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p></td>
</tr> </tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_key_content</span></code></p></td> <tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_key_content</span></code></p></td>
<td class="text-left"><p>Content of the TLS private key. Use <code class="docutils literal notranslate"><span class="pre">&quot;{{</span> <span class="pre">lookup('file',</span> <span class="pre">'server.key.pem')</span> <span class="pre">}}&quot;</span></code> to lookup a file.</p></td> <td class="text-left"><p>Content of the TLS private key. Use <code class="docutils literal notranslate"><span class="pre">&quot;{{</span> <span class="pre">lookup('file',</span> <span class="pre">'server.key.pem')</span> <span class="pre">}}&quot;</span></code> to lookup a file.</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">&quot;&quot;</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">&quot;&quot;</span></code></p></td>
</tr> </tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_key_file</span></code></p></td> <tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_key_file</span></code></p></td>
<td class="text-left"><p>The file path to a private key in PEM format</p></td> <td class="text-left"><p>The file path to a private key in PEM format</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">/etc/pki/tls/private/server.key.pem</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">/etc/pki/tls/private/server.key.pem</span></code></p></td>
</tr> </tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_cert_file_copy_enabled</span></code></p></td> <tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_cert_file_copy_enabled</span></code></p></td>
<td class="text-left"><p>Enable copy of cert file to target host</p></td> <td class="text-left"><p>Enable copy of cert file to target host</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p></td>
</tr> </tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_cert_file_src</span></code></p></td> <tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_cert_file_src</span></code></p></td>
<td class="text-left"><p>Set the source file path</p></td> <td class="text-left"><p>Set the source file path</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">&quot;&quot;</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">&quot;&quot;</span></code></p></td>
</tr> </tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_cert_file</span></code></p></td> <tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_cert_file</span></code></p></td>
<td class="text-left"><p>The file path to a server certificate or certificate chain in PEM format</p></td> <td class="text-left"><p>The file path to a server certificate or certificate chain in PEM format</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">/etc/pki/tls/certs/server.crt.pem</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">/etc/pki/tls/certs/server.crt.pem</span></code></p></td>
</tr> </tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_key_store_enabled</span></code></p></td> <tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_key_store_enabled</span></code></p></td>
<td class="text-left"><p>Enable configuration of HTTPS via a key store</p></td> <td class="text-left"><p>Enable configuration of HTTPS via a key store</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p></td>
</tr> </tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_key_store_file</span></code></p></td> <tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_key_store_file</span></code></p></td>
<td class="text-left"><p>Deprecated, use <code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_key_store_file</span></code> instead.</p></td> <td class="text-left"><p>Deprecated, use <code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_key_store_file</span></code> instead.</p></td>
<td class="text-left"><p></p></td> <td class="text-left"><p></p></td>
</tr> </tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_key_store_password</span></code></p></td> <tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_key_store_password</span></code></p></td>
<td class="text-left"><p>Deprecated, use <code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_key_store_password</span></code> instead.</p></td> <td class="text-left"><p>Deprecated, use <code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_key_store_password</span></code> instead.</p></td>
<td class="text-left"><p></p></td> <td class="text-left"><p></p></td>
</tr> </tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_http_relative_path</span></code></p></td> <tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_http_relative_path</span></code></p></td>
<td class="text-left"><p>Set the path relative to / for serving resources. The path must start with a /</p></td> <td class="text-left"><p>Set the path relative to / for serving resources. The path must start with a /</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">/</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">/</span></code></p></td>
</tr> </tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_http_management_relative_path</span></code></p></td> <tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_http_management_relative_path</span></code></p></td>
<td class="text-left"><p>Set the path relative to / for serving resources from management interface. The path must start with a /. If not given, the value is inherited from HTTP options. Relevant only when something is exposed on the management interface - see the guide for details.</p></td> <td class="text-left"><p>Set the path relative to / for serving resources from management interface. The path must start with a /. If not given, the value is inherited from HTTP options. Relevant only when something is exposed on the management interface - see the guide for details.</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">/</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">/</span></code></p></td>
</tr> </tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_http_enabled</span></code></p></td> <tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_http_enabled</span></code></p></td>
<td class="text-left"><p>Enable listener on HTTP port</p></td> <td class="text-left"><p>Enable listener on HTTP port</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">True</span></code></p></td> <td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">True</span></code></p></td>
</tr> </tr>

2
main/searchindex.js
View file

File diff suppressed because one or more lines are too long