mirror of
https://github.com/ansible-middleware/keycloak.git
synced 2025-04-14 23:00:28 -07:00
Update docs for main
This commit is contained in:
parent
11d5e57977
commit
f639648312
5 changed files with 57 additions and 39 deletions
|
@ -53,21 +53,22 @@
|
|||
<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-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>
|
||||
</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="#minor-changes">Minor Changes</a></li>
|
||||
<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>
|
||||
</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="#id5">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="#id7">Major Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id9">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="#id9">Release Summary</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id11">Release Summary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
@ -99,33 +100,34 @@
|
|||
<div itemprop="articleBody">
|
||||
|
||||
<section id="middleware-automation-keycloak-release-notes">
|
||||
<h1><a class="toc-backref" href="#id10">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="#id12">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="id10">middleware_automation.keycloak Release Notes</a></p>
|
||||
<li><p><a class="reference internal" href="#middleware-automation-keycloak-release-notes" id="id12">middleware_automation.keycloak Release Notes</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#v1-0-3-devel" id="id11">v1.0.3-devel</a></p>
|
||||
<li><p><a class="reference internal" href="#v1-0-3-devel" id="id13">v1.0.3-devel</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#major-changes" id="id12">Major Changes</a></p></li>
|
||||
<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="id13">v1.0.2</a></p>
|
||||
<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="#minor-changes" id="id14">Minor Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#bugfixes" id="id15">Bugfixes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id3" 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="id16">v1.0.1</a></p>
|
||||
<li><p><a class="reference internal" href="#v1-0-1" id="id19">v1.0.1</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#release-summary" id="id17">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id5" id="id18">Major Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id7" id="id19">Minor Changes</a></p></li>
|
||||
<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>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-0-0" id="id20">v1.0.0</a></p>
|
||||
<li><p><a class="reference internal" href="#v1-0-0" id="id23">v1.0.0</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id9" id="id21">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id11" id="id24">Release Summary</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
@ -134,53 +136,59 @@
|
|||
</div>
|
||||
<p>This changelog describes changes after version 0.2.6.</p>
|
||||
<section id="v1-0-3-devel">
|
||||
<h2><a class="toc-backref" href="#id11">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="#id13">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="#id12">Major Changes</a><a class="headerlink" href="#major-changes" title="Permalink to this headline"></a></h3>
|
||||
<h3><a class="toc-backref" href="#id14">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 >= 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>
|
||||
<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>
|
||||
<section id="v1-0-2">
|
||||
<h2><a class="toc-backref" href="#id13">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Permalink to this headline"></a></h2>
|
||||
<section id="minor-changes">
|
||||
<h3><a class="toc-backref" href="#id14">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Permalink to this headline"></a></h3>
|
||||
<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>
|
||||
<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="#id15">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Permalink to this headline"></a></h3>
|
||||
<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>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="#id16">v1.0.1</a><a class="headerlink" href="#v1-0-1" title="Permalink to this headline"></a></h2>
|
||||
<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>
|
||||
<section id="release-summary">
|
||||
<h3><a class="toc-backref" href="#id17">Release Summary</a><a class="headerlink" href="#release-summary" title="Permalink to this headline"></a></h3>
|
||||
<h3><a class="toc-backref" href="#id20">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="id5">
|
||||
<h3><a class="toc-backref" href="#id18">Major Changes</a><a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3>
|
||||
<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>
|
||||
<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="id7">
|
||||
<h3><a class="toc-backref" href="#id19">Minor Changes</a><a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
|
||||
<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>
|
||||
<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="#id20">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Permalink to this headline"></a></h2>
|
||||
<section id="id9">
|
||||
<h3><a class="toc-backref" href="#id21">Release Summary</a><a class="headerlink" href="#id9" title="Permalink to this headline"></a></h3>
|
||||
<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>
|
||||
<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>
|
||||
|
|
|
@ -14,6 +14,11 @@ Major Changes
|
|||
|
||||
- New role for installing keycloak >= 17.0.0 (quarkus) `#29 <https://github.com/ansible-middleware/keycloak/pull/29>`_
|
||||
|
||||
Minor Changes
|
||||
-------------
|
||||
|
||||
- Add ``keycloak_config_override_template`` parameter for passing a custom xml config template `#30 <https://github.com/ansible-middleware/keycloak/pull/30>`_
|
||||
|
||||
v1.0.2
|
||||
======
|
||||
|
||||
|
|
|
@ -99,6 +99,7 @@ Role Defaults
|
|||
|`keycloak_jboss_home` | Installation work directory | `{{ keycloak_rhsso_installdir if keycloak_rhsso_enable else keycloak_installdir }}` |
|
||||
|`keycloak_config_dir` | Path for configuration | `{{ keycloak_jboss_home }}/standalone/configuration` |
|
||||
|`keycloak_config_path_to_standalone_xml` | Custom path for configuration | `{{ keycloak_jboss_home }}/standalone/configuration/{{ keycloak_config_standalone_xml }}` |
|
||||
|`keycloak_config_override_template` | Path to custom template for standalone.xml configuration | `''` |
|
||||
|`keycloak_auth_realm` | Name for rest authentication realm | `master` |
|
||||
|`keycloak_auth_client` | Authentication client for configuration REST calls | `admin-cli` |
|
||||
|`keycloak_force_install` | Remove pre-existing versions of service | `False` |
|
||||
|
|
|
@ -347,27 +347,31 @@
|
|||
<td class="text-left"><p>Custom path for configuration</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">keycloak_jboss_home</span> <span class="pre">}}/standalone/configuration/{{</span> <span class="pre">keycloak_config_standalone_xml</span> <span class="pre">}}</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_auth_realm</span></code></p></td>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_config_override_template</span></code></p></td>
|
||||
<td class="text-left"><p>Path to custom template for standalone.xml configuration</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">''</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_auth_realm</span></code></p></td>
|
||||
<td class="text-left"><p>Name for rest authentication realm</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">master</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_auth_client</span></code></p></td>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_auth_client</span></code></p></td>
|
||||
<td class="text-left"><p>Authentication client for configuration REST calls</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">admin-cli</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_force_install</span></code></p></td>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_force_install</span></code></p></td>
|
||||
<td class="text-left"><p>Remove pre-existing versions of service</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_url</span></code></p></td>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_url</span></code></p></td>
|
||||
<td class="text-left"><p>URL for configuration rest calls</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">http://{{</span> <span class="pre">keycloak_host</span> <span class="pre">}}:{{</span> <span class="pre">keycloak_http_port</span> <span class="pre">}}</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_management_url</span></code></p></td>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_management_url</span></code></p></td>
|
||||
<td class="text-left"><p>URL for management console rest calls</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">http://{{</span> <span class="pre">keycloak_host</span> <span class="pre">}}:{{</span> <span class="pre">keycloak_management_http_port</span> <span class="pre">}}</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">rhsso_rhn_id</span></code></p></td>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">rhsso_rhn_id</span></code></p></td>
|
||||
<td class="text-left"><p>Customer Portal product ID for Red Hat SSO</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">rhsso_rhn_ids[keycloak_rhsso_version].id</span> <span class="pre">}}</span></code></p></td>
|
||||
</tr>
|
||||
|
|
File diff suppressed because one or more lines are too long
Loading…
Add table
Reference in a new issue