ansible-collections/middleware_automation.keycloak
1
0
Fork 0
mirror of https://github.com/ansible-middleware/keycloak.git synced 2025-04-09 20:30: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 2023-05-26 14:11:28 +00:00
parent ee294bb4ed
commit 5196888bca
5 changed files with 165 additions and 126 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

233
main/CHANGELOG.html
View file

@ -62,63 +62,63 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-4">v1.2.4</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="#id4">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-2-1">v1.2.1</a><ul>
<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>
<li class="toctree-l3"><a class="reference internal" href="#id9">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id11">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-0">v1.2.0</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="#id13">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id14">Minor Changes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-1-1">v1.1.1</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id18">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id19">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-1-0">v1.1.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id20">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id21">Minor Changes</a></li>
<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="#id26">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id27">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-7">v1.0.7</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id28">Breaking Changes / Porting Guide</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id30">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id29">Breaking Changes / Porting Guide</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id31">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="#id32">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id33">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-5">v1.0.5</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id35">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id36">Minor Changes</a></li>
</ul>
</li>
<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="#id37">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id39">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id41">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id38">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id40">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id42">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="#id43">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id46">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id44">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id47">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="#id48">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id50">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id49">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id51">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="#id52">Release Summary</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id53">Release Summary</a></li>
</ul>
</li>
</ul>
@ -161,87 +161,87 @@
<div itemprop="articleBody">
<section id="middleware-automation-keycloak-release-notes">
<h1><a class="toc-backref" href="#id53" role="doc-backlink">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="#id54" role="doc-backlink">middleware_automation.keycloak Release Notes</a><a class="headerlink" href="#middleware-automation-keycloak-release-notes" title="Permalink to this heading"></a></h1>
<nav class="contents" id="topics">
<p class="topic-title">Topics</p>
<ul class="simple">
<li><p><a class="reference internal" href="#middleware-automation-keycloak-release-notes" id="id53">middleware_automation.keycloak Release Notes</a></p>
<li><p><a class="reference internal" href="#middleware-automation-keycloak-release-notes" id="id54">middleware_automation.keycloak Release Notes</a></p>
<ul>
<li><p><a class="reference internal" href="#v1-2-5-devel" id="id54">v1.2.5-devel</a></p>
<li><p><a class="reference internal" href="#v1-2-5-devel" id="id55">v1.2.5-devel</a></p>
<ul>
<li><p><a class="reference internal" href="#minor-changes" id="id55">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#minor-changes" id="id56">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-2-4" id="id56">v1.2.4</a></p>
<li><p><a class="reference internal" href="#v1-2-4" id="id57">v1.2.4</a></p>
<ul>
<li><p><a class="reference internal" href="#id3" id="id57">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#bugfixes" id="id58">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id4" id="id58">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#bugfixes" id="id59">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-2-1" id="id59">v1.2.1</a></p>
<li><p><a class="reference internal" href="#v1-2-1" id="id60">v1.2.1</a></p>
<ul>
<li><p><a class="reference internal" href="#id8" id="id60">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id10" id="id61">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id9" id="id61">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id11" id="id62">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-2-0" id="id62">v1.2.0</a></p>
<li><p><a class="reference internal" href="#v1-2-0" id="id63">v1.2.0</a></p>
<ul>
<li><p><a class="reference internal" href="#major-changes" id="id63">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id13" id="id64">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#major-changes" id="id64">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id14" id="id65">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-1-1" id="id65">v1.1.1</a></p>
<li><p><a class="reference internal" href="#v1-1-1" id="id66">v1.1.1</a></p>
<ul>
<li><p><a class="reference internal" href="#id18" id="id66">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id19" id="id67">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-1-0" id="id67">v1.1.0</a></p>
<li><p><a class="reference internal" href="#v1-1-0" id="id68">v1.1.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id20" id="id68">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#breaking-changes-porting-guide" id="id69">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#id26" id="id70">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id21" id="id69">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#breaking-changes-porting-guide" id="id70">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#id27" id="id71">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-7" id="id71">v1.0.7</a></p>
<li><p><a class="reference internal" href="#v1-0-7" id="id72">v1.0.7</a></p>
<ul>
<li><p><a class="reference internal" href="#id28" id="id72">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#id30" id="id73">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id29" id="id73">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#id31" id="id74">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-6" id="id74">v1.0.6</a></p>
<li><p><a class="reference internal" href="#v1-0-6" id="id75">v1.0.6</a></p>
<ul>
<li><p><a class="reference internal" href="#id32" id="id75">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id33" id="id76">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-5" id="id76">v1.0.5</a></p>
<li><p><a class="reference internal" href="#v1-0-5" id="id77">v1.0.5</a></p>
<ul>
<li><p><a class="reference internal" href="#id35" id="id77">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id36" id="id78">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-4" id="id78">v1.0.4</a></p></li>
<li><p><a class="reference internal" href="#v1-0-3" id="id79">v1.0.3</a></p>
<li><p><a class="reference internal" href="#v1-0-4" id="id79">v1.0.4</a></p></li>
<li><p><a class="reference internal" href="#v1-0-3" id="id80">v1.0.3</a></p>
<ul>
<li><p><a class="reference internal" href="#id37" id="id80">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id39" id="id81">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id41" id="id82">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id38" id="id81">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id40" id="id82">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id42" id="id83">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-2" id="id83">v1.0.2</a></p>
<li><p><a class="reference internal" href="#v1-0-2" id="id84">v1.0.2</a></p>
<ul>
<li><p><a class="reference internal" href="#id43" id="id84">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id46" id="id85">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id44" id="id85">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id47" id="id86">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-1" id="id86">v1.0.1</a></p>
<li><p><a class="reference internal" href="#v1-0-1" id="id87">v1.0.1</a></p>
<ul>
<li><p><a class="reference internal" href="#release-summary" id="id87">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id48" id="id88">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id50" id="id89">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#release-summary" id="id88">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id49" id="id89">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id51" id="id90">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-0" id="id90">v1.0.0</a></p>
<li><p><a class="reference internal" href="#v1-0-0" id="id91">v1.0.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id52" id="id91">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id53" id="id92">Release Summary</a></p></li>
</ul>
</li>
</ul>
@ -250,26 +250,27 @@
</nav>
<p>This changelog describes changes after version 0.2.6.</p>
<section id="v1-2-5-devel">
<h2><a class="toc-backref" href="#id54" role="doc-backlink">v1.2.5-devel</a><a class="headerlink" href="#v1-2-5-devel" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id55" role="doc-backlink">v1.2.5-devel</a><a class="headerlink" href="#v1-2-5-devel" title="Permalink to this heading"></a></h2>
<section id="minor-changes">
<h3><a class="toc-backref" href="#id55" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id56" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Add configuration for database connection pool validation <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/85">#85</a></p></li>
<li><p>Allow to force backend URLs to frontend URLs <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/84">#84</a></p></li>
<li><p>Introduce systemd unit restart behavior <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/81">#81</a></p></li>
</ul>
</section>
</section>
<section id="v1-2-4">
<h2><a class="toc-backref" href="#id56" role="doc-backlink">v1.2.4</a><a class="headerlink" href="#v1-2-4" title="Permalink to this heading"></a></h2>
<section id="id3">
<h3><a class="toc-backref" href="#id57" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id3" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id57" role="doc-backlink">v1.2.4</a><a class="headerlink" href="#v1-2-4" title="Permalink to this heading"></a></h2>
<section id="id4">
<h3><a class="toc-backref" href="#id58" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id4" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Add <code class="docutils literal notranslate"><span class="pre">sqlserver</span></code> to keycloak role jdbc configurations <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/78">#78</a></p></li>
<li><p>Add configurability for XA transactions <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/73">#73</a></p></li>
</ul>
</section>
<section id="bugfixes">
<h3><a class="toc-backref" href="#id58" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id59" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Fix deprecation warning for <code class="docutils literal notranslate"><span class="pre">ipaddr</span></code> <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/77">#77</a></p></li>
<li><p>Fix undefined facts when offline patching sso <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/71">#71</a></p></li>
@ -277,30 +278,30 @@
</section>
</section>
<section id="v1-2-1">
<h2><a class="toc-backref" href="#id59" role="doc-backlink">v1.2.1</a><a class="headerlink" href="#v1-2-1" title="Permalink to this heading"></a></h2>
<section id="id8">
<h3><a class="toc-backref" href="#id60" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id8" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id60" role="doc-backlink">v1.2.1</a><a class="headerlink" href="#v1-2-1" title="Permalink to this heading"></a></h2>
<section id="id9">
<h3><a class="toc-backref" href="#id61" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id9" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Allow to setup keycloak HA cluster without remote cache store <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/68">#68</a></p></li>
</ul>
</section>
<section id="id10">
<h3><a class="toc-backref" href="#id61" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id10" title="Permalink to this heading"></a></h3>
<section id="id11">
<h3><a class="toc-backref" href="#id62" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id11" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Pass attributes to realm clients <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/69">#69</a></p></li>
</ul>
</section>
</section>
<section id="v1-2-0">
<h2><a class="toc-backref" href="#id62" role="doc-backlink">v1.2.0</a><a class="headerlink" href="#v1-2-0" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id63" role="doc-backlink">v1.2.0</a><a class="headerlink" href="#v1-2-0" title="Permalink to this heading"></a></h2>
<section id="major-changes">
<h3><a class="toc-backref" href="#id63" role="doc-backlink">Major Changes</a><a class="headerlink" href="#major-changes" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id64" role="doc-backlink">Major Changes</a><a class="headerlink" href="#major-changes" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Provide config for multiple modcluster proxies <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/60">#60</a></p></li>
</ul>
</section>
<section id="id13">
<h3><a class="toc-backref" href="#id64" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id13" title="Permalink to this heading"></a></h3>
<section id="id14">
<h3><a class="toc-backref" href="#id65" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id14" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Allow to configure TCPPING for cluster discovery <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/62">#62</a></p></li>
<li><p>Drop community.general from dependencies <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/61">#61</a></p></li>
@ -310,18 +311,18 @@
</section>
</section>
<section id="v1-1-1">
<h2><a class="toc-backref" href="#id65" role="doc-backlink">v1.1.1</a><a class="headerlink" href="#v1-1-1" title="Permalink to this heading"></a></h2>
<section id="id18">
<h3><a class="toc-backref" href="#id66" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id18" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id66" role="doc-backlink">v1.1.1</a><a class="headerlink" href="#v1-1-1" title="Permalink to this heading"></a></h2>
<section id="id19">
<h3><a class="toc-backref" href="#id67" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id19" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>keycloak-quarkus: fix <code class="docutils literal notranslate"><span class="pre">cache-config-file</span></code> path in keycloak.conf.j2 template <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/53">#53</a></p></li>
</ul>
</section>
</section>
<section id="v1-1-0">
<h2><a class="toc-backref" href="#id67" role="doc-backlink">v1.1.0</a><a class="headerlink" href="#v1-1-0" title="Permalink to this heading"></a></h2>
<section id="id20">
<h3><a class="toc-backref" href="#id68" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id20" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id68" role="doc-backlink">v1.1.0</a><a class="headerlink" href="#v1-1-0" title="Permalink to this heading"></a></h2>
<section id="id21">
<h3><a class="toc-backref" href="#id69" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id21" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Update keycloak to 18.0.2 - sso to 7.6.1 <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/46">#46</a></p></li>
<li><p>Variable <code class="docutils literal notranslate"><span class="pre">keycloak_no_log</span></code> controls ansible <code class="docutils literal notranslate"><span class="pre">no_log</span></code> parameter (for debugging purposes) <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/47">#47</a></p></li>
@ -330,37 +331,37 @@
</ul>
</section>
<section id="breaking-changes-porting-guide">
<h3><a class="toc-backref" href="#id69" role="doc-backlink">Breaking Changes / Porting Guide</a><a class="headerlink" href="#breaking-changes-porting-guide" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id70" role="doc-backlink">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>Rename variables from <code class="docutils literal notranslate"><span class="pre">infinispan_</span></code> prefix to <code class="docutils literal notranslate"><span class="pre">keycloak_infinispan_</span></code> <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/42">#42</a></p></li>
</ul>
</section>
<section id="id26">
<h3><a class="toc-backref" href="#id70" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id26" title="Permalink to this heading"></a></h3>
<section id="id27">
<h3><a class="toc-backref" href="#id71" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id27" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>keycloak_quarkus: fix /var/log/keycloak symlink to keycloak log directory <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/44">#44</a></p></li>
</ul>
</section>
</section>
<section id="v1-0-7">
<h2><a class="toc-backref" href="#id71" role="doc-backlink">v1.0.7</a><a class="headerlink" href="#v1-0-7" title="Permalink to this heading"></a></h2>
<section id="id28">
<h3><a class="toc-backref" href="#id72" role="doc-backlink">Breaking Changes / Porting Guide</a><a class="headerlink" href="#id28" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id72" role="doc-backlink">v1.0.7</a><a class="headerlink" href="#v1-0-7" title="Permalink to this heading"></a></h2>
<section id="id29">
<h3><a class="toc-backref" href="#id73" role="doc-backlink">Breaking Changes / Porting Guide</a><a class="headerlink" href="#id29" title="Permalink to this heading"></a></h3>
<ul class="simple">
<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="id30">
<h3><a class="toc-backref" href="#id73" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id30" title="Permalink to this heading"></a></h3>
<section id="id31">
<h3><a class="toc-backref" href="#id74" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id31" 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="#id74" role="doc-backlink">v1.0.6</a><a class="headerlink" href="#v1-0-6" title="Permalink to this heading"></a></h2>
<section id="id32">
<h3><a class="toc-backref" href="#id75" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id32" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id75" role="doc-backlink">v1.0.6</a><a class="headerlink" href="#v1-0-6" title="Permalink to this heading"></a></h2>
<section id="id33">
<h3><a class="toc-backref" href="#id76" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id33" 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>
@ -368,77 +369,77 @@
</section>
</section>
<section id="v1-0-5">
<h2><a class="toc-backref" href="#id76" role="doc-backlink">v1.0.5</a><a class="headerlink" href="#v1-0-5" title="Permalink to this heading"></a></h2>
<section id="id35">
<h3><a class="toc-backref" href="#id77" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id35" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id77" role="doc-backlink">v1.0.5</a><a class="headerlink" href="#v1-0-5" title="Permalink to this heading"></a></h2>
<section id="id36">
<h3><a class="toc-backref" href="#id78" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id36" 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="#id78" role="doc-backlink">v1.0.4</a><a class="headerlink" href="#v1-0-4" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id79" role="doc-backlink">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="#id79" role="doc-backlink">v1.0.3</a><a class="headerlink" href="#v1-0-3" title="Permalink to this heading"></a></h2>
<section id="id37">
<h3><a class="toc-backref" href="#id80" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id37" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id80" role="doc-backlink">v1.0.3</a><a class="headerlink" href="#v1-0-3" title="Permalink to this heading"></a></h2>
<section id="id38">
<h3><a class="toc-backref" href="#id81" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id38" 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="id39">
<h3><a class="toc-backref" href="#id81" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id39" title="Permalink to this heading"></a></h3>
<section id="id40">
<h3><a class="toc-backref" href="#id82" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id40" 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="id41">
<h3><a class="toc-backref" href="#id82" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id41" title="Permalink to this heading"></a></h3>
<section id="id42">
<h3><a class="toc-backref" href="#id83" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id42" 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="#id83" role="doc-backlink">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Permalink to this heading"></a></h2>
<section id="id43">
<h3><a class="toc-backref" href="#id84" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id43" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id84" role="doc-backlink">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Permalink to this heading"></a></h2>
<section id="id44">
<h3><a class="toc-backref" href="#id85" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id44" 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="id46">
<h3><a class="toc-backref" href="#id85" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id46" title="Permalink to this heading"></a></h3>
<section id="id47">
<h3><a class="toc-backref" href="#id86" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id47" 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="#id86" role="doc-backlink">v1.0.1</a><a class="headerlink" href="#v1-0-1" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id87" role="doc-backlink">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="#id87" role="doc-backlink">Release Summary</a><a class="headerlink" href="#release-summary" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id88" role="doc-backlink">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="id48">
<h3><a class="toc-backref" href="#id88" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id48" title="Permalink to this heading"></a></h3>
<section id="id49">
<h3><a class="toc-backref" href="#id89" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id49" 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="id50">
<h3><a class="toc-backref" href="#id89" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id50" title="Permalink to this heading"></a></h3>
<section id="id51">
<h3><a class="toc-backref" href="#id90" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id51" 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="#id90" role="doc-backlink">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Permalink to this heading"></a></h2>
<section id="id52">
<h3><a class="toc-backref" href="#id91" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id52" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id91" role="doc-backlink">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Permalink to this heading"></a></h2>
<section id="id53">
<h3><a class="toc-backref" href="#id92" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id53" 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>

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

@ -12,6 +12,7 @@ v1.2.5-devel
Minor Changes
-------------
- Add configuration for database connection pool validation `#85 <https://github.com/ansible-middleware/keycloak/pull/85>`_
- Allow to force backend URLs to frontend URLs `#84 <https://github.com/ansible-middleware/keycloak/pull/84>`_
- Introduce systemd unit restart behavior `#81 <https://github.com/ansible-middleware/keycloak/pull/81>`_

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

@ -111,6 +111,11 @@ Role Defaults
|`keycloak_url` | URL for configuration rest calls | `http://{{ keycloak_host }}:{{ keycloak_http_port }}` |
|`keycloak_management_url` | URL for management console rest calls | `http://{{ keycloak_host }}:{{ keycloak_management_http_port }}` |
|`keycloak_frontend_url_force` | Force backend requests to use the frontend URL | `False` |
|`keycloak_db_background_validation` | Enable background validation of database connection | `False` |
|`keycloak_db_background_validation_millis`| How frequenly the connection pool is validated in the background | `10000` if background validation enabled |
|`keycloak_db_background_validate_on_match` | Enable validate on match for database connections | `False` |
|`keycloak_frontend_url` | frontend URL for keycloak endpoint | `http://localhost:8080/auth/` |
Role Variables
--------------
@ -123,7 +128,7 @@ The following are a set of _required_ variables for the role:
|`keycloak_frontend_url` | frontend URL for keycloak endpoint | `http://localhost:8080/auth/` |
The following variables are _required_ only when `keycloak_ha_enabled` is True:
The following parameters are _required_ only when `keycloak_ha_enabled` is True:
| Variable | Description | Default |
|:---------|:------------|:--------|
@ -141,7 +146,7 @@ The following variables are _required_ only when `keycloak_ha_enabled` is True:
|`keycloak_infinispan_trust_store_password`| Password for opening truststore | `changeit` |
The following variables are _required_ only when `keycloak_db_enabled` is True:
The following parameters are _required_ only when `keycloak_db_enabled` is True:
| Variable | Description | Default |
|:---------|:------------|:---------|
@ -151,6 +156,13 @@ The following variables are _required_ only when `keycloak_db_enabled` is True:
|`keycloak_db_pass` | password for connecting to postgres | `keycloak-pass` |
The following variables are _optional_:
| Variable | Description |
|:---------|:------------|
|`keycloak_db_valid_conn_sql` | Override the default database connection validation query sql |
Example Playbook
-----------------
@ -161,8 +173,6 @@ Example Playbook
- hosts: ...
vars:
keycloak_admin_password: "remembertochangeme"
collections:
- middleware_automation.keycloak
roles:
- middleware_automation.keycloak.keycloak
```

37
main/roles/keycloak.html
View file

@ -407,6 +407,22 @@
<td class="text-left"><p>Force backend requests to use the frontend URL</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_db_background_validation</span></code></p></td>
<td class="text-left"><p>Enable background validation of database connection</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_db_background_validation_millis</span></code></p></td>
<td class="text-left"><p>How frequenly the connection pool is validated in the background</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">10000</span></code> if background validation enabled</p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_db_background_validate_on_match</span></code></p></td>
<td class="text-left"><p>Enable validate on match for database connections</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_frontend_url</span></code></p></td>
<td class="text-left"><p>frontend URL for keycloak endpoint</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">http://localhost:8080/auth/</span></code></p></td>
</tr>
</tbody>
</table>
</section>
@ -428,7 +444,7 @@
</tr>
</tbody>
</table>
<p>The following variables are <em>required</em> only when <code class="docutils literal notranslate"><span class="pre">keycloak_ha_enabled</span></code> is True:</p>
<p>The following parameters are <em>required</em> only when <code class="docutils literal notranslate"><span class="pre">keycloak_ha_enabled</span></code> is True:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head text-left"><p>Variable</p></th>
@ -487,7 +503,7 @@
</tr>
</tbody>
</table>
<p>The following variables are <em>required</em> only when <code class="docutils literal notranslate"><span class="pre">keycloak_db_enabled</span></code> is True:</p>
<p>The following parameters are <em>required</em> only when <code class="docutils literal notranslate"><span class="pre">keycloak_db_enabled</span></code> is True:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head text-left"><p>Variable</p></th>
@ -514,6 +530,19 @@
</tr>
</tbody>
</table>
<p>The following variables are <em>optional</em>:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head text-left"><p>Variable</p></th>
<th class="head text-left"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_db_valid_conn_sql</span></code></p></td>
<td class="text-left"><p>Override the default database connection validation query sql</p></td>
</tr>
</tbody>
</table>
</section>
<section id="example-playbook">
<h2>Example Playbook<a class="headerlink" href="#example-playbook" title="Permalink to this heading"></a></h2>
@ -524,9 +553,7 @@
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">hosts</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
<span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vars</span><span class="p p-Indicator">:</span>
<span class="w"> </span><span class="nt">keycloak_admin_password</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;remembertochangeme&quot;</span>
<span class="w"> </span><span class="w w-Error"> </span><span class="nt">collections</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">middleware_automation.keycloak</span>
<span class="w"> </span><span class="nt">roles</span><span class="p">:</span>
<span class="w"> </span><span class="w w-Error"> </span><span class="nt">roles</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">middleware_automation.keycloak.keycloak</span>
</pre></div>
</div>

2
main/searchindex.js
View file

File diff suppressed because one or more lines are too long