Update docs for main

Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
This commit is contained in:
ansible-middleware-core 2025-04-09 18:31:02 +00:00
parent d34f1f7001
commit 39c5de55f5
10 changed files with 336 additions and 321 deletions

File diff suppressed because it is too large Load diff

View file

@ -131,7 +131,7 @@
<!--start requires_ansible-->
<section id="ansible-version-compatibility">
<h2>Ansible version compatibility<a class="headerlink" href="#ansible-version-compatibility" title="Link to this heading"></a></h2>
<p>This collection has been tested against following Ansible versions: <strong>&gt;=2.15.0</strong>.</p>
<p>This collection has been tested against following Ansible versions: <strong>&gt;=2.16.0</strong>.</p>
<p>Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions.</p>
<!--end requires_ansible-->
</section>

View file

@ -6,7 +6,7 @@ middleware\_automation.keycloak Release Notes
This changelog describes changes after version 0.2.6.
v2.4.4-devel
v3.0.0-devel
============
Minor Changes
@ -17,6 +17,7 @@ Minor Changes
Breaking Changes / Porting Guide
--------------------------------
- Bump major and ansible-core versions `#266 <https://github.com/ansible-middleware/keycloak/pull/266>`_
- Role support for keycloak/RHBK v26 `#254 <https://github.com/ansible-middleware/keycloak/pull/254>`_
Bugfixes
@ -25,6 +26,11 @@ Bugfixes
- 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>`_
New Modules
-----------
- middleware_automation.keycloak.keycloak_realm - Allows administration of Keycloak realm via Keycloak API
v2.4.3
======

View file

@ -12,7 +12,7 @@ Collection to install and configure [Keycloak](https://www.keycloak.org/) or [Re
<!--start requires_ansible-->
## Ansible version compatibility
This collection has been tested against following Ansible versions: **>=2.15.0**.
This collection has been tested against following Ansible versions: **>=2.16.0**.
Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions.
<!--end requires_ansible-->

View file

@ -24,7 +24,7 @@ virtualenv $PATH_TO_DEV_VIRTUALENV
# activate the virtual env
source $PATH_TO_DEV_VIRTUALENV/bin/activate
# install ansible and tools onto the virtualenv
pip install yamllint 'molecule>=6.0' 'molecule-plugins[docker]' 'ansible-core>=2.15' ansible-lint
pip install yamllint 'molecule>=6.0' 'molecule-plugins[docker]' 'ansible-core>=2.16' ansible-lint
# install collection dependencies
ansible-galaxy collection install -r requirements.yml
# install python dependencies

View file

@ -112,7 +112,7 @@ Role Defaults
|`keycloak_quarkus_restart_strategy`| Strategy task file for restarting in HA (one of provided restart/['serial.yml','none.yml','serial_then_parallel.yml']) or path to file when providing custom strategy | `restart/serial.yml` |
|`keycloak_quarkus_restart_health_check`| Whether to wait for successful health check after restart | `true` |
|`keycloak_quarkus_restart_health_check_delay`| Seconds to let pass before starting healch checks | `10` |
|`keycloak_quarkus_restart_health_check_reries`| Number of attempts for successful health check before failing | `25` |
|`keycloak_quarkus_restart_health_check_retries`| Number of attempts for successful health check before failing | `25` |
|`keycloak_quarkus_restart_pause`| Seconds to wait between restarts in HA strategy | `15` |

View file

@ -122,7 +122,7 @@ ansible-galaxy collection install middleware_automation-keycloak-*.tar.gz
<span class="l l-Scalar l-Scalar-Plain"># activate the virtual env</span>
<span class="l l-Scalar l-Scalar-Plain">source $PATH_TO_DEV_VIRTUALENV/bin/activate</span>
<span class="l l-Scalar l-Scalar-Plain"># install ansible and tools onto the virtualenv</span>
<span class="l l-Scalar l-Scalar-Plain">pip install yamllint &#39;molecule&gt;=6.0&#39; &#39;molecule-plugins[docker]&#39; &#39;ansible-core&gt;=2.15&#39; ansible-lint</span>
<span class="l l-Scalar l-Scalar-Plain">pip install yamllint &#39;molecule&gt;=6.0&#39; &#39;molecule-plugins[docker]&#39; &#39;ansible-core&gt;=2.16&#39; ansible-lint</span>
<span class="l l-Scalar l-Scalar-Plain"># install collection dependencies</span>
<span class="l l-Scalar l-Scalar-Plain">ansible-galaxy collection install -r requirements.yml</span>
<span class="l l-Scalar l-Scalar-Plain"># install python dependencies</span>

View file

@ -120,7 +120,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="CHANGELOG.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-4-4-devel">v2.4.4-devel</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v3-0-0-devel">v3.0.0-devel</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-4-3">v2.4.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-4-2">v2.4.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-4-1">v2.4.1</a></li>

View file

@ -453,7 +453,7 @@
<td class="text-left"><p>Seconds to let pass before starting healch checks</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">10</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_restart_health_check_reries</span></code></p></td>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_restart_health_check_retries</span></code></p></td>
<td class="text-left"><p>Number of attempts for successful health check before failing</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">25</span></code></p></td>
</tr>

File diff suppressed because one or more lines are too long