ansible-collections/middleware_automation.keycloak
1
0
Fork 0
mirror of https://github.com/ansible-middleware/keycloak.git synced 2025-04-14 23:00:28 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Update docs for main

Browse source
This commit is contained in:
github-actions 2022-04-28 13:07:22 +00:00
parent f639648312
commit 989e513a8c
5 changed files with 68 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

84
main/CHANGELOG.html
View file

@ -54,21 +54,22 @@
<li class="toctree-l2"><a class="reference internal" href="#v1-0-3-devel">v1.0.3-devel</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#major-changes">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#minor-changes">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#bugfixes">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-2">v1.0.2</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id3">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#bugfixes">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id4">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id7">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-1">v1.0.1</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#release-summary">Release Summary</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id7">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id9">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id9">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id11">Minor Changes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-0">v1.0.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id11">Release Summary</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id13">Release Summary</a></li>
</ul>
</li>
</ul>
@ -100,34 +101,35 @@
<div itemprop="articleBody">
<section id="middleware-automation-keycloak-release-notes">
<h1><a class="toc-backref" href="#id12">middleware_automation.keycloak Release Notes</a><a class="headerlink" href="#middleware-automation-keycloak-release-notes" title="Permalink to this headline"></a></h1>
<h1><a class="toc-backref" href="#id14">middleware_automation.keycloak Release Notes</a><a class="headerlink" href="#middleware-automation-keycloak-release-notes" title="Permalink to this headline"></a></h1>
<div class="contents topic" id="topics">
<p class="topic-title">Topics</p>
<ul class="simple">
<li><p><a class="reference internal" href="#middleware-automation-keycloak-release-notes" id="id12">middleware_automation.keycloak Release Notes</a></p>
<li><p><a class="reference internal" href="#middleware-automation-keycloak-release-notes" id="id14">middleware_automation.keycloak Release Notes</a></p>
<ul>
<li><p><a class="reference internal" href="#v1-0-3-devel" id="id13">v1.0.3-devel</a></p>
<li><p><a class="reference internal" href="#v1-0-3-devel" id="id15">v1.0.3-devel</a></p>
<ul>
<li><p><a class="reference internal" href="#major-changes" id="id14">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#minor-changes" id="id15">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-2" id="id16">v1.0.2</a></p>
<ul>
<li><p><a class="reference internal" href="#id3" id="id17">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#major-changes" id="id16">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#minor-changes" id="id17">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#bugfixes" id="id18">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-1" id="id19">v1.0.1</a></p>
<li><p><a class="reference internal" href="#v1-0-2" id="id19">v1.0.2</a></p>
<ul>
<li><p><a class="reference internal" href="#release-summary" id="id20">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id7" id="id21">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id9" id="id22">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id4" id="id20">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id7" id="id21">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-0" id="id23">v1.0.0</a></p>
<li><p><a class="reference internal" href="#v1-0-1" id="id22">v1.0.1</a></p>
<ul>
<li><p><a class="reference internal" href="#id11" id="id24">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#release-summary" id="id23">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id9" id="id24">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id11" id="id25">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-0" id="id26">v1.0.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id13" id="id27">Release Summary</a></p></li>
</ul>
</li>
</ul>
@ -136,59 +138,65 @@
</div>
<p>This changelog describes changes after version 0.2.6.</p>
<section id="v1-0-3-devel">
<h2><a class="toc-backref" href="#id13">v1.0.3-devel</a><a class="headerlink" href="#v1-0-3-devel" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id15">v1.0.3-devel</a><a class="headerlink" href="#v1-0-3-devel" title="Permalink to this headline"></a></h2>
<section id="major-changes">
<h3><a class="toc-backref" href="#id14">Major Changes</a><a class="headerlink" href="#major-changes" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id16">Major Changes</a><a class="headerlink" href="#major-changes" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>New role for installing keycloak &gt;= 17.0.0 (quarkus) <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/29">#29</a></p></li>
</ul>
</section>
<section id="minor-changes">
<h3><a class="toc-backref" href="#id15">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id17">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Add <code class="docutils literal notranslate"><span class="pre">keycloak_config_override_template</span></code> parameter for passing a custom xml config template <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/30">#30</a></p></li>
</ul>
</section>
<section id="bugfixes">
<h3><a class="toc-backref" href="#id18">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Make sure systemd unit starts with selected java JVM <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/31">#31</a></p></li>
</ul>
</section>
</section>
<section id="v1-0-2">
<h2><a class="toc-backref" href="#id16">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Permalink to this headline"></a></h2>
<section id="id3">
<h3><a class="toc-backref" href="#id17">Minor Changes</a><a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<h2><a class="toc-backref" href="#id19">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Permalink to this headline"></a></h2>
<section id="id4">
<h3><a class="toc-backref" href="#id20">Minor Changes</a><a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Make <code class="docutils literal notranslate"><span class="pre">keycloak_admin_password</span></code> a default with assert (was: role variable) <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/26">#26</a></p></li>
<li><p>Simplify dependency install logic and reduce play execution time <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/19">#19</a></p></li>
</ul>
</section>
<section id="bugfixes">
<h3><a class="toc-backref" href="#id18">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Permalink to this headline"></a></h3>
<section id="id7">
<h3><a class="toc-backref" href="#id21">Bugfixes</a><a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Set <code class="docutils literal notranslate"><span class="pre">keycloak_frontend_url</span></code> default according to other defaults <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/25">#25</a></p></li>
</ul>
</section>
</section>
<section id="v1-0-1">
<h2><a class="toc-backref" href="#id19">v1.0.1</a><a class="headerlink" href="#v1-0-1" title="Permalink to this headline"></a></h2>
<h2><a class="toc-backref" href="#id22">v1.0.1</a><a class="headerlink" href="#v1-0-1" title="Permalink to this headline"></a></h2>
<section id="release-summary">
<h3><a class="toc-backref" href="#id20">Release Summary</a><a class="headerlink" href="#release-summary" title="Permalink to this headline"></a></h3>
<h3><a class="toc-backref" href="#id23">Release Summary</a><a class="headerlink" href="#release-summary" title="Permalink to this headline"></a></h3>
<p>Minor enhancements, bug and documentation fixes.</p>
</section>
<section id="id7">
<h3><a class="toc-backref" href="#id21">Major Changes</a><a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
<section id="id9">
<h3><a class="toc-backref" href="#id24">Major Changes</a><a class="headerlink" href="#id9" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Apply latest cumulative patch of RH-SSO automatically when new parameter <code class="docutils literal notranslate"><span class="pre">keycloak_rhsso_apply_patches</span></code> is <code class="docutils literal notranslate"><span class="pre">true</span></code> <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/18">#18</a></p></li>
</ul>
</section>
<section id="id9">
<h3><a class="toc-backref" href="#id22">Minor Changes</a><a class="headerlink" href="#id9" title="Permalink to this headline"></a></h3>
<section id="id11">
<h3><a class="toc-backref" href="#id25">Minor Changes</a><a class="headerlink" href="#id11" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Clustered installs now perform database initialization on first node to avoid locking issues <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/17">#17</a></p></li>
</ul>
</section>
</section>
<section id="v1-0-0">
<h2><a class="toc-backref" href="#id23">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Permalink to this headline"></a></h2>
<section id="id11">
<h3><a class="toc-backref" href="#id24">Release Summary</a><a class="headerlink" href="#id11" title="Permalink to this headline"></a></h3>
<h2><a class="toc-backref" href="#id26">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Permalink to this headline"></a></h2>
<section id="id13">
<h3><a class="toc-backref" href="#id27">Release Summary</a><a class="headerlink" href="#id13" title="Permalink to this headline"></a></h3>
<p>This is the first stable release of the <code class="docutils literal notranslate"><span class="pre">middleware_automation.keycloak</span></code> collection.</p>
</section>
</section>

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

@ -19,6 +19,11 @@ Minor Changes
- Add ``keycloak_config_override_template`` parameter for passing a custom xml config template `#30 <https://github.com/ansible-middleware/keycloak/pull/30>`_
Bugfixes
--------
- Make sure systemd unit starts with selected java JVM `#31 <https://github.com/ansible-middleware/keycloak/pull/31>`_
v1.0.2
======

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

@ -60,13 +60,14 @@ Role Defaults
|`keycloak_jgroups_port`| jgroups cluster tcp port | `7600` |
|`keycloak_management_http_port`| Management port | `9990` |
|`keycloak_management_https_port`| TLS management port | `9993` |
|`keycloak_java_opts`| Additional JVM options | `-Xms1024m -Xmx2048m` |
|`keycloak_prefer_ipv4`| Prefer IPv4 stack and addresses for port binding | `True` |
|`keycloak_config_standalone_xml`| filename for configuration | `keycloak.xml` |
|`keycloak_service_user`| posix account username | `keycloak` |
|`keycloak_service_group`| posix account group | `keycloak` |
|`keycloak_service_pidfile`| pid file path for service | `/run/keycloak.pid` |
|`keycloak_jvm_package`| RHEL java package runtime | `java-1.8.0-openjdk-devel` |
|`keycloak_java_home`| JAVA_HOME of installed JRE, leave empty for using specified keycloak_jvm_package RPM path | `None` |
|`keycloak_java_opts`| Additional JVM options | `-Xms1024m -Xmx2048m` |
* Install options

24
main/roles/keycloak.html
View file

@ -213,34 +213,38 @@
<td class="text-left"><p>TLS management port</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">9993</span></code></p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_java_opts</span></code></p></td>
<td class="text-left"><p>Additional JVM options</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">-Xms1024m</span> <span class="pre">-Xmx2048m</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_prefer_ipv4</span></code></p></td>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_prefer_ipv4</span></code></p></td>
<td class="text-left"><p>Prefer IPv4 stack and addresses for port binding</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">True</span></code></p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_config_standalone_xml</span></code></p></td>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_config_standalone_xml</span></code></p></td>
<td class="text-left"><p>filename for configuration</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak.xml</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_service_user</span></code></p></td>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_service_user</span></code></p></td>
<td class="text-left"><p>posix account username</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak</span></code></p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_service_group</span></code></p></td>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_service_group</span></code></p></td>
<td class="text-left"><p>posix account group</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_service_pidfile</span></code></p></td>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_service_pidfile</span></code></p></td>
<td class="text-left"><p>pid file path for service</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">/run/keycloak.pid</span></code></p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_jvm_package</span></code></p></td>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_jvm_package</span></code></p></td>
<td class="text-left"><p>RHEL java package runtime</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">java-1.8.0-openjdk-devel</span></code></p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_java_home</span></code></p></td>
<td class="text-left"><p>JAVA_HOME of installed JRE, leave empty for using specified keycloak_jvm_package RPM path</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">None</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_java_opts</span></code></p></td>
<td class="text-left"><p>Additional JVM options</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">-Xms1024m</span> <span class="pre">-Xmx2048m</span></code></p></td>
</tr>
</tbody>
</table>
<ul class="simple">

2
main/searchindex.js
View file

File diff suppressed because one or more lines are too long