Update docs for main

This commit is contained in:
github-actions 2022-12-13 14:24:48 +00:00
parent b4220e943c
commit 9062d59ea4
5 changed files with 91 additions and 73 deletions

View file

@ -55,43 +55,44 @@
<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-1-0-devel">v1.1.0-devel</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#minor-changes">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="#bugfixes">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="#id3">Breaking Changes / Porting Guide</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id5">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id4">Breaking Changes / Porting Guide</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id6">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="#id7">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id8">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="#minor-changes">Minor 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-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="#id12">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="#id14">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id16">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="#id16">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id19">Bugfixes</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="#id21">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="#id21">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id23">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id23">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id25">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="#id25">Release Summary</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id27">Release Summary</a></li>
</ul>
</li>
</ul>
@ -123,58 +124,59 @@
<div itemprop="articleBody">
<section id="middleware-automation-keycloak-release-notes">
<h1><a class="toc-backref" href="#id26">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="#id28">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="id26">middleware_automation.keycloak Release Notes</a></p>
<li><p><a class="reference internal" href="#middleware-automation-keycloak-release-notes" id="id28">middleware_automation.keycloak Release Notes</a></p>
<ul>
<li><p><a class="reference internal" href="#v1-1-0-devel" id="id27">v1.1.0-devel</a></p>
<li><p><a class="reference internal" href="#v1-1-0-devel" id="id29">v1.1.0-devel</a></p>
<ul>
<li><p><a class="reference internal" href="#breaking-changes-porting-guide" id="id28">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#bugfixes" id="id29">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#minor-changes" id="id30">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#breaking-changes-porting-guide" id="id31">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#bugfixes" id="id32">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-7" id="id30">v1.0.7</a></p>
<li><p><a class="reference internal" href="#v1-0-7" id="id33">v1.0.7</a></p>
<ul>
<li><p><a class="reference internal" href="#id3" id="id31">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#id5" id="id32">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id4" id="id34">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#id6" id="id35">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-6" id="id33">v1.0.6</a></p>
<li><p><a class="reference internal" href="#v1-0-6" id="id36">v1.0.6</a></p>
<ul>
<li><p><a class="reference internal" href="#id7" id="id34">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id8" id="id37">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-5" id="id35">v1.0.5</a></p>
<li><p><a class="reference internal" href="#v1-0-5" id="id38">v1.0.5</a></p>
<ul>
<li><p><a class="reference internal" href="#minor-changes" id="id36">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id11" id="id39">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-4" id="id37">v1.0.4</a></p></li>
<li><p><a class="reference internal" href="#v1-0-3" id="id38">v1.0.3</a></p>
<li><p><a class="reference internal" href="#v1-0-4" id="id40">v1.0.4</a></p></li>
<li><p><a class="reference internal" href="#v1-0-3" id="id41">v1.0.3</a></p>
<ul>
<li><p><a class="reference internal" href="#major-changes" id="id39">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id12" id="id40">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id14" id="id41">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#major-changes" id="id42">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id14" id="id43">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id16" id="id44">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-2" id="id42">v1.0.2</a></p>
<li><p><a class="reference internal" href="#v1-0-2" id="id45">v1.0.2</a></p>
<ul>
<li><p><a class="reference internal" href="#id16" id="id43">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id19" id="id44">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id18" id="id46">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id21" id="id47">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-1" id="id45">v1.0.1</a></p>
<li><p><a class="reference internal" href="#v1-0-1" id="id48">v1.0.1</a></p>
<ul>
<li><p><a class="reference internal" href="#release-summary" id="id46">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id21" id="id47">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id23" id="id48">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#release-summary" id="id49">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id23" id="id50">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id25" id="id51">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-0" id="id49">v1.0.0</a></p>
<li><p><a class="reference internal" href="#v1-0-0" id="id52">v1.0.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id25" id="id50">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id27" id="id53">Release Summary</a></p></li>
</ul>
</li>
</ul>
@ -183,39 +185,45 @@
</div>
<p>This changelog describes changes after version 0.2.6.</p>
<section id="v1-1-0-devel">
<h2><a class="toc-backref" href="#id27">v1.1.0-devel</a><a class="headerlink" href="#v1-1-0-devel" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id29">v1.1.0-devel</a><a class="headerlink" href="#v1-1-0-devel" title="Permalink to this heading"></a></h2>
<section id="minor-changes">
<h3><a class="toc-backref" href="#id30">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>keycloak_quarkus: variable to enable development mode <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/45">#45</a></p></li>
</ul>
</section>
<section id="breaking-changes-porting-guide">
<h3><a class="toc-backref" href="#id28">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="#id31">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="bugfixes">
<h3><a class="toc-backref" href="#id29">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id32">Bugfixes</a><a class="headerlink" href="#bugfixes" 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="#id30">v1.0.7</a><a class="headerlink" href="#v1-0-7" title="Permalink to this heading"></a></h2>
<section id="id3">
<h3><a class="toc-backref" href="#id31">Breaking Changes / Porting Guide</a><a class="headerlink" href="#id3" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id33">v1.0.7</a><a class="headerlink" href="#v1-0-7" title="Permalink to this heading"></a></h2>
<section id="id4">
<h3><a class="toc-backref" href="#id34">Breaking Changes / Porting Guide</a><a class="headerlink" href="#id4" 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="id5">
<h3><a class="toc-backref" href="#id32">Bugfixes</a><a class="headerlink" href="#id5" title="Permalink to this heading"></a></h3>
<section id="id6">
<h3><a class="toc-backref" href="#id35">Bugfixes</a><a class="headerlink" href="#id6" 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="#id33">v1.0.6</a><a class="headerlink" href="#v1-0-6" title="Permalink to this heading"></a></h2>
<section id="id7">
<h3><a class="toc-backref" href="#id34">Bugfixes</a><a class="headerlink" href="#id7" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id36">v1.0.6</a><a class="headerlink" href="#v1-0-6" title="Permalink to this heading"></a></h2>
<section id="id8">
<h3><a class="toc-backref" href="#id37">Bugfixes</a><a class="headerlink" href="#id8" 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>
@ -223,77 +231,77 @@
</section>
</section>
<section id="v1-0-5">
<h2><a class="toc-backref" href="#id35">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="#id36">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id38">v1.0.5</a><a class="headerlink" href="#v1-0-5" title="Permalink to this heading"></a></h2>
<section id="id11">
<h3><a class="toc-backref" href="#id39">Minor Changes</a><a class="headerlink" href="#id11" 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="#id37">v1.0.4</a><a class="headerlink" href="#v1-0-4" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id40">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="#id38">v1.0.3</a><a class="headerlink" href="#v1-0-3" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id41">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="#id39">Major Changes</a><a class="headerlink" href="#major-changes" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id42">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="id12">
<h3><a class="toc-backref" href="#id40">Minor Changes</a><a class="headerlink" href="#id12" title="Permalink to this heading"></a></h3>
<section id="id14">
<h3><a class="toc-backref" href="#id43">Minor Changes</a><a class="headerlink" href="#id14" 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="id14">
<h3><a class="toc-backref" href="#id41">Bugfixes</a><a class="headerlink" href="#id14" title="Permalink to this heading"></a></h3>
<section id="id16">
<h3><a class="toc-backref" href="#id44">Bugfixes</a><a class="headerlink" href="#id16" 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="#id42">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Permalink to this heading"></a></h2>
<section id="id16">
<h3><a class="toc-backref" href="#id43">Minor Changes</a><a class="headerlink" href="#id16" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id45">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Permalink to this heading"></a></h2>
<section id="id18">
<h3><a class="toc-backref" href="#id46">Minor Changes</a><a class="headerlink" href="#id18" 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="id19">
<h3><a class="toc-backref" href="#id44">Bugfixes</a><a class="headerlink" href="#id19" title="Permalink to this heading"></a></h3>
<section id="id21">
<h3><a class="toc-backref" href="#id47">Bugfixes</a><a class="headerlink" href="#id21" 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="#id45">v1.0.1</a><a class="headerlink" href="#v1-0-1" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id48">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="#id46">Release Summary</a><a class="headerlink" href="#release-summary" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id49">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="id21">
<h3><a class="toc-backref" href="#id47">Major Changes</a><a class="headerlink" href="#id21" title="Permalink to this heading"></a></h3>
<section id="id23">
<h3><a class="toc-backref" href="#id50">Major Changes</a><a class="headerlink" href="#id23" 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="id23">
<h3><a class="toc-backref" href="#id48">Minor Changes</a><a class="headerlink" href="#id23" title="Permalink to this heading"></a></h3>
<section id="id25">
<h3><a class="toc-backref" href="#id51">Minor Changes</a><a class="headerlink" href="#id25" 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="#id49">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Permalink to this heading"></a></h2>
<section id="id25">
<h3><a class="toc-backref" href="#id50">Release Summary</a><a class="headerlink" href="#id25" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id52">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Permalink to this heading"></a></h2>
<section id="id27">
<h3><a class="toc-backref" href="#id53">Release Summary</a><a class="headerlink" href="#id27" 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>

View file

@ -9,6 +9,11 @@ This changelog describes changes after version 0.2.6.
v1.1.0-devel
============
Minor Changes
-------------
- keycloak_quarkus: variable to enable development mode `#45 <https://github.com/ansible-middleware/keycloak/pull/45>`_
Breaking Changes / Porting Guide
--------------------------------

View file

@ -97,6 +97,7 @@ Role Defaults
|`keycloak_quarkus_log_file`| Set the log file path and filename relative to keycloak home | `data/log/keycloak.log` |
|`keycloak_quarkus_log_format`| Set a format specific to file log entries | `%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n` |
|`keycloak_quarkus_proxy_mode`| The proxy address forwarding mode if the server is behind a reverse proxy | `edge` |
|`keycloak_quarkus_start_dev`| Whether to start the service in development mode (start-dev) | `False` |
Role Variables

View file

@ -398,6 +398,10 @@
<td class="text-left"><p>The proxy address forwarding mode if the server is behind a reverse proxy</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">edge</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_start_dev</span></code></p></td>
<td class="text-left"><p>Whether to start the service in development mode (start-dev)</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p></td>
</tr>
</tbody>
</table>
</section>

File diff suppressed because one or more lines are too long