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-07-05 12:07:08 +00:00
parent deceee4e97
commit f17a32e445
5 changed files with 79 additions and 66 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

128
main/CHANGELOG.html
View file

@ -53,11 +53,12 @@
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-7-devel">v1.0.7-devel</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#breaking-changes-porting-guide">Breaking Changes / Porting Guide</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-6">v1.0.6</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id2">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id3">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-5">v1.0.5</a><ul>
@ -67,23 +68,23 @@
<li class="toctree-l2"><a class="reference internal" href="#v1-0-4">v1.0.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-3">v1.0.3</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="#id7">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id9">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id8">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id10">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="#id11">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id14">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id12">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id15">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="#id16">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id18">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id17">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id19">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="#id20">Release Summary</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id21">Release Summary</a></li>
</ul>
</li>
</ul>
@ -115,51 +116,52 @@
<div itemprop="articleBody">
<section id="middleware-automation-keycloak-release-notes">
<h1><a class="toc-backref" href="#id21">middleware_automation.keycloak Release Notes</a><a class="headerlink" href="#middleware-automation-keycloak-release-notes" title="Permalink to this heading"></a></h1>
<h1><a class="toc-backref" href="#id22">middleware_automation.keycloak Release Notes</a><a class="headerlink" href="#middleware-automation-keycloak-release-notes" title="Permalink to this heading"></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="id21">middleware_automation.keycloak Release Notes</a></p>
<li><p><a class="reference internal" href="#middleware-automation-keycloak-release-notes" id="id22">middleware_automation.keycloak Release Notes</a></p>
<ul>
<li><p><a class="reference internal" href="#v1-0-7-devel" id="id22">v1.0.7-devel</a></p>
<li><p><a class="reference internal" href="#v1-0-7-devel" id="id23">v1.0.7-devel</a></p>
<ul>
<li><p><a class="reference internal" href="#bugfixes" id="id23">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#breaking-changes-porting-guide" id="id24">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#bugfixes" id="id25">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-6" id="id24">v1.0.6</a></p>
<li><p><a class="reference internal" href="#v1-0-6" id="id26">v1.0.6</a></p>
<ul>
<li><p><a class="reference internal" href="#id2" id="id25">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id3" id="id27">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-5" id="id26">v1.0.5</a></p>
<li><p><a class="reference internal" href="#v1-0-5" id="id28">v1.0.5</a></p>
<ul>
<li><p><a class="reference internal" href="#minor-changes" id="id27">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#minor-changes" id="id29">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-4" id="id28">v1.0.4</a></p></li>
<li><p><a class="reference internal" href="#v1-0-3" id="id29">v1.0.3</a></p>
<li><p><a class="reference internal" href="#v1-0-4" id="id30">v1.0.4</a></p></li>
<li><p><a class="reference internal" href="#v1-0-3" id="id31">v1.0.3</a></p>
<ul>
<li><p><a class="reference internal" href="#major-changes" id="id30">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id7" id="id31">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id9" id="id32">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#major-changes" id="id32">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id8" id="id33">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id10" id="id34">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-2" id="id33">v1.0.2</a></p>
<li><p><a class="reference internal" href="#v1-0-2" id="id35">v1.0.2</a></p>
<ul>
<li><p><a class="reference internal" href="#id11" id="id34">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id14" id="id35">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id12" id="id36">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id15" id="id37">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-1" id="id36">v1.0.1</a></p>
<li><p><a class="reference internal" href="#v1-0-1" id="id38">v1.0.1</a></p>
<ul>
<li><p><a class="reference internal" href="#release-summary" id="id37">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id16" id="id38">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id18" id="id39">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#release-summary" id="id39">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id17" id="id40">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id19" id="id41">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-0" id="id40">v1.0.0</a></p>
<li><p><a class="reference internal" href="#v1-0-0" id="id42">v1.0.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id20" id="id41">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id21" id="id43">Release Summary</a></p></li>
</ul>
</li>
</ul>
@ -168,18 +170,24 @@
</div>
<p>This changelog describes changes after version 0.2.6.</p>
<section id="v1-0-7-devel">
<h2><a class="toc-backref" href="#id22">v1.0.7-devel</a><a class="headerlink" href="#v1-0-7-devel" title="Permalink to this heading"></a></h2>
<section id="bugfixes">
<h3><a class="toc-backref" href="#id23">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id23">v1.0.7-devel</a><a class="headerlink" href="#v1-0-7-devel" title="Permalink to this heading"></a></h2>
<section id="breaking-changes-porting-guide">
<h3><a class="toc-backref" href="#id24">Breaking Changes / Porting Guide</a><a class="headerlink" href="#breaking-changes-porting-guide" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Use become for tasks that will otherwise fail <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/38">#38</a></p></li>
<li><p>keycloak_quarkus: use absolute path for certificate files <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/39">#39</a></p></li>
</ul>
</section>
<section id="bugfixes">
<h3><a class="toc-backref" href="#id25">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>keycloak_quarkus: use become for tasks that will otherwise fail <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/38">#38</a></p></li>
</ul>
</section>
</section>
<section id="v1-0-6">
<h2><a class="toc-backref" href="#id24">v1.0.6</a><a class="headerlink" href="#v1-0-6" title="Permalink to this heading"></a></h2>
<section id="id2">
<h3><a class="toc-backref" href="#id25">Bugfixes</a><a class="headerlink" href="#id2" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id26">v1.0.6</a><a class="headerlink" href="#v1-0-6" title="Permalink to this heading"></a></h2>
<section id="id3">
<h3><a class="toc-backref" href="#id27">Bugfixes</a><a class="headerlink" href="#id3" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>keycloak_quarkus: add selected java to PATH in systemd unit <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/34">#34</a></p></li>
<li><p>keycloak_quarkus: set logfile path correctly under keycloak home <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/35">#35</a></p></li>
@ -187,77 +195,77 @@
</section>
</section>
<section id="v1-0-5">
<h2><a class="toc-backref" href="#id26">v1.0.5</a><a class="headerlink" href="#v1-0-5" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id28">v1.0.5</a><a class="headerlink" href="#v1-0-5" title="Permalink to this heading"></a></h2>
<section id="minor-changes">
<h3><a class="toc-backref" href="#id27">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id29">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Update config options: keycloak and quarkus <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/32">#32</a></p></li>
</ul>
</section>
</section>
<section id="v1-0-4">
<h2><a class="toc-backref" href="#id28">v1.0.4</a><a class="headerlink" href="#v1-0-4" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id30">v1.0.4</a><a class="headerlink" href="#v1-0-4" title="Permalink to this heading"></a></h2>
</section>
<section id="v1-0-3">
<h2><a class="toc-backref" href="#id29">v1.0.3</a><a class="headerlink" href="#v1-0-3" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id31">v1.0.3</a><a class="headerlink" href="#v1-0-3" title="Permalink to this heading"></a></h2>
<section id="major-changes">
<h3><a class="toc-backref" href="#id30">Major Changes</a><a class="headerlink" href="#major-changes" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id32">Major Changes</a><a class="headerlink" href="#major-changes" title="Permalink to this heading"></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="id7">
<h3><a class="toc-backref" href="#id31">Minor Changes</a><a class="headerlink" href="#id7" title="Permalink to this heading"></a></h3>
<section id="id8">
<h3><a class="toc-backref" href="#id33">Minor Changes</a><a class="headerlink" href="#id8" title="Permalink to this heading"></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="id9">
<h3><a class="toc-backref" href="#id32">Bugfixes</a><a class="headerlink" href="#id9" title="Permalink to this heading"></a></h3>
<section id="id10">
<h3><a class="toc-backref" href="#id34">Bugfixes</a><a class="headerlink" href="#id10" title="Permalink to this heading"></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="#id33">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Permalink to this heading"></a></h2>
<section id="id11">
<h3><a class="toc-backref" href="#id34">Minor Changes</a><a class="headerlink" href="#id11" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id35">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Permalink to this heading"></a></h2>
<section id="id12">
<h3><a class="toc-backref" href="#id36">Minor Changes</a><a class="headerlink" href="#id12" title="Permalink to this heading"></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="id14">
<h3><a class="toc-backref" href="#id35">Bugfixes</a><a class="headerlink" href="#id14" title="Permalink to this heading"></a></h3>
<section id="id15">
<h3><a class="toc-backref" href="#id37">Bugfixes</a><a class="headerlink" href="#id15" title="Permalink to this heading"></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="#id36">v1.0.1</a><a class="headerlink" href="#v1-0-1" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id38">v1.0.1</a><a class="headerlink" href="#v1-0-1" title="Permalink to this heading"></a></h2>
<section id="release-summary">
<h3><a class="toc-backref" href="#id37">Release Summary</a><a class="headerlink" href="#release-summary" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id39">Release Summary</a><a class="headerlink" href="#release-summary" title="Permalink to this heading"></a></h3>
<p>Minor enhancements, bug and documentation fixes.</p>
</section>
<section id="id16">
<h3><a class="toc-backref" href="#id38">Major Changes</a><a class="headerlink" href="#id16" title="Permalink to this heading"></a></h3>
<section id="id17">
<h3><a class="toc-backref" href="#id40">Major Changes</a><a class="headerlink" href="#id17" title="Permalink to this heading"></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="id18">
<h3><a class="toc-backref" href="#id39">Minor Changes</a><a class="headerlink" href="#id18" title="Permalink to this heading"></a></h3>
<section id="id19">
<h3><a class="toc-backref" href="#id41">Minor Changes</a><a class="headerlink" href="#id19" title="Permalink to this heading"></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="#id40">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Permalink to this heading"></a></h2>
<section id="id20">
<h3><a class="toc-backref" href="#id41">Release Summary</a><a class="headerlink" href="#id20" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id42">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Permalink to this heading"></a></h2>
<section id="id21">
<h3><a class="toc-backref" href="#id43">Release Summary</a><a class="headerlink" href="#id21" title="Permalink to this heading"></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>

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

@ -9,10 +9,15 @@ This changelog describes changes after version 0.2.6.
v1.0.7-devel
============
Breaking Changes / Porting Guide
--------------------------------
- keycloak_quarkus: use absolute path for certificate files `#39 <https://github.com/ansible-middleware/keycloak/pull/39>`_
Bugfixes
--------
- Use become for tasks that will otherwise fail `#38 <https://github.com/ansible-middleware/keycloak/pull/38>`_
- keycloak_quarkus: use become for tasks that will otherwise fail `#38 <https://github.com/ansible-middleware/keycloak/pull/38>`_
v1.0.6
======

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

@ -37,8 +37,8 @@ Role Defaults
|`keycloak_quarkus_http_relative_path` | Service context path | `auth` |
|`keycloak_quarkus_http_enabled`| Enable listener on HTTP port | `True` |
|`keycloak_quarkus_https_enabled`| Enable listener on HTTPS port | `False` |
|`keycloak_quarkus_key_file`| The file path to a private key in PEM format | `conf/server.key.pem` |
|`keycloak_quarkus_cert_file`| The file path to a server certificate or certificate chain in PEM format | `conf/server.crt.pem` |
|`keycloak_quarkus_key_file`| The file path to a private key in PEM format | `{{ keycloak.home }}/conf/server.key.pem` |
|`keycloak_quarkus_cert_file`| The file path to a server certificate or certificate chain in PEM format | `{{ keycloak.home }}/conf/server.crt.pem` |
* Database configuration

4
main/roles/keycloak_quarkus.html
View file

@ -202,11 +202,11 @@
</tr>
<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><code class="docutils literal notranslate"><span class="pre">conf/server.key.pem</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/server.key.pem</span></code></p></td>
</tr>
<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><code class="docutils literal notranslate"><span class="pre">conf/server.crt.pem</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/server.crt.pem</span></code></p></td>
</tr>
</tbody>
</table>

2
main/searchindex.js
View file

File diff suppressed because one or more lines are too long