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
fd8cbbb3c8
commit
5d50c62097
20 changed files with 336 additions and 325 deletions
|
@ -41,6 +41,7 @@
|
|||
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="README.html">Ansible Collection - middleware_automation.keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Middleware_Automation.Keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
|
||||
|
@ -58,7 +59,7 @@
|
|||
</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="#id3">Bugfixes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id4">Bugfixes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-0-5">v1.0.5</a><ul>
|
||||
|
@ -68,23 +69,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="#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-0-2">v1.0.2</a><ul>
|
||||
<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>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id13">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-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="#id17">Major Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id19">Minor Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id18">Major Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id20">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="#id21">Release Summary</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id22">Release Summary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
@ -116,52 +117,52 @@
|
|||
<div itemprop="articleBody">
|
||||
|
||||
<section id="middleware-automation-keycloak-release-notes">
|
||||
<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>
|
||||
<h1><a class="toc-backref" href="#id23">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="id22">middleware_automation.keycloak Release Notes</a></p>
|
||||
<li><p><a class="reference internal" href="#middleware-automation-keycloak-release-notes" id="id23">middleware_automation.keycloak Release Notes</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#v1-0-7" id="id23">v1.0.7</a></p>
|
||||
<li><p><a class="reference internal" href="#v1-0-7" id="id24">v1.0.7</a></p>
|
||||
<ul>
|
||||
<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>
|
||||
<li><p><a class="reference internal" href="#breaking-changes-porting-guide" id="id25">Breaking Changes / Porting Guide</a></p></li>
|
||||
<li><p><a class="reference internal" href="#bugfixes" id="id26">Bugfixes</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-0-6" id="id26">v1.0.6</a></p>
|
||||
<li><p><a class="reference internal" href="#v1-0-6" id="id27">v1.0.6</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id3" id="id27">Bugfixes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id4" id="id28">Bugfixes</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-0-5" id="id28">v1.0.5</a></p>
|
||||
<li><p><a class="reference internal" href="#v1-0-5" id="id29">v1.0.5</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#minor-changes" id="id29">Minor Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#minor-changes" id="id30">Minor Changes</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<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>
|
||||
<li><p><a class="reference internal" href="#v1-0-4" id="id31">v1.0.4</a></p></li>
|
||||
<li><p><a class="reference internal" href="#v1-0-3" id="id32">v1.0.3</a></p>
|
||||
<ul>
|
||||
<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>
|
||||
<li><p><a class="reference internal" href="#major-changes" id="id33">Major Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id9" id="id34">Minor Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id11" id="id35">Bugfixes</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-0-2" id="id35">v1.0.2</a></p>
|
||||
<li><p><a class="reference internal" href="#v1-0-2" id="id36">v1.0.2</a></p>
|
||||
<ul>
|
||||
<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>
|
||||
<li><p><a class="reference internal" href="#id13" id="id37">Minor Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id16" id="id38">Bugfixes</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-0-1" id="id38">v1.0.1</a></p>
|
||||
<li><p><a class="reference internal" href="#v1-0-1" id="id39">v1.0.1</a></p>
|
||||
<ul>
|
||||
<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>
|
||||
<li><p><a class="reference internal" href="#release-summary" id="id40">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id18" id="id41">Major Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id20" id="id42">Minor Changes</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-0-0" id="id42">v1.0.0</a></p>
|
||||
<li><p><a class="reference internal" href="#v1-0-0" id="id43">v1.0.0</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id21" id="id43">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id22" id="id44">Release Summary</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
@ -170,24 +171,25 @@
|
|||
</div>
|
||||
<p>This changelog describes changes after version 0.2.6.</p>
|
||||
<section id="v1-0-7">
|
||||
<h2><a class="toc-backref" href="#id23">v1.0.7</a><a class="headerlink" href="#v1-0-7" title="Permalink to this heading"></a></h2>
|
||||
<h2><a class="toc-backref" href="#id24">v1.0.7</a><a class="headerlink" href="#v1-0-7" 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>
|
||||
<h3><a class="toc-backref" href="#id25">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>
|
||||
<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>
|
||||
<h3><a class="toc-backref" href="#id26">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="#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>
|
||||
<h2><a class="toc-backref" href="#id27">v1.0.6</a><a class="headerlink" href="#v1-0-6" title="Permalink to this heading"></a></h2>
|
||||
<section id="id4">
|
||||
<h3><a class="toc-backref" href="#id28">Bugfixes</a><a class="headerlink" href="#id4" 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>
|
||||
|
@ -195,77 +197,77 @@
|
|||
</section>
|
||||
</section>
|
||||
<section id="v1-0-5">
|
||||
<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>
|
||||
<h2><a class="toc-backref" href="#id29">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="#id29">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Permalink to this heading"></a></h3>
|
||||
<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>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="#id30">v1.0.4</a><a class="headerlink" href="#v1-0-4" title="Permalink to this heading"></a></h2>
|
||||
<h2><a class="toc-backref" href="#id31">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="#id31">v1.0.3</a><a class="headerlink" href="#v1-0-3" title="Permalink to this heading"></a></h2>
|
||||
<h2><a class="toc-backref" href="#id32">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="#id32">Major Changes</a><a class="headerlink" href="#major-changes" title="Permalink to this heading"></a></h3>
|
||||
<h3><a class="toc-backref" href="#id33">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 >= 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="id8">
|
||||
<h3><a class="toc-backref" href="#id33">Minor Changes</a><a class="headerlink" href="#id8" title="Permalink to this heading"></a></h3>
|
||||
<section id="id9">
|
||||
<h3><a class="toc-backref" href="#id34">Minor Changes</a><a class="headerlink" href="#id9" 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="id10">
|
||||
<h3><a class="toc-backref" href="#id34">Bugfixes</a><a class="headerlink" href="#id10" title="Permalink to this heading"></a></h3>
|
||||
<section id="id11">
|
||||
<h3><a class="toc-backref" href="#id35">Bugfixes</a><a class="headerlink" href="#id11" 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="#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>
|
||||
<h2><a class="toc-backref" href="#id36">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Permalink to this heading"></a></h2>
|
||||
<section id="id13">
|
||||
<h3><a class="toc-backref" href="#id37">Minor Changes</a><a class="headerlink" href="#id13" 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="id15">
|
||||
<h3><a class="toc-backref" href="#id37">Bugfixes</a><a class="headerlink" href="#id15" title="Permalink to this heading"></a></h3>
|
||||
<section id="id16">
|
||||
<h3><a class="toc-backref" href="#id38">Bugfixes</a><a class="headerlink" href="#id16" 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="#id38">v1.0.1</a><a class="headerlink" href="#v1-0-1" title="Permalink to this heading"></a></h2>
|
||||
<h2><a class="toc-backref" href="#id39">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="#id39">Release Summary</a><a class="headerlink" href="#release-summary" title="Permalink to this heading"></a></h3>
|
||||
<h3><a class="toc-backref" href="#id40">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="id17">
|
||||
<h3><a class="toc-backref" href="#id40">Major Changes</a><a class="headerlink" href="#id17" title="Permalink to this heading"></a></h3>
|
||||
<section id="id18">
|
||||
<h3><a class="toc-backref" href="#id41">Major Changes</a><a class="headerlink" href="#id18" 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="id19">
|
||||
<h3><a class="toc-backref" href="#id41">Minor Changes</a><a class="headerlink" href="#id19" title="Permalink to this heading"></a></h3>
|
||||
<section id="id20">
|
||||
<h3><a class="toc-backref" href="#id42">Minor Changes</a><a class="headerlink" href="#id20" 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="#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>
|
||||
<h2><a class="toc-backref" href="#id43">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Permalink to this heading"></a></h2>
|
||||
<section id="id22">
|
||||
<h3><a class="toc-backref" href="#id44">Release Summary</a><a class="headerlink" href="#id22" 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>
|
||||
|
|
|
@ -20,7 +20,7 @@
|
|||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Role Index" href="roles/index.html" />
|
||||
<link rel="next" title="Middleware_Automation.Keycloak" href="plugins/index.html" />
|
||||
<link rel="prev" title="Welcome to Keycloak Collection documentation" href="index.html" />
|
||||
</head>
|
||||
|
||||
|
@ -49,10 +49,7 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#usage">Usage</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#install-playbook">Install Playbook</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#choosing-between-upstream-project-keycloak-and-red-hat-single-sign-on-rhsso">Choosing between upstream project (Keycloak) and Red Hat Single Sign-On (RHSSO)</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#install-upstream-keycloak-from-keycloak-releases">Install upstream (Keycloak) from keycloak releases</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#install-rhsso-from-the-red-hat-customer-support-portal">Install RHSSO from the Red Hat Customer Support Portal</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#install-playbook">Install Playbook</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#install-from-controller-node-local-source">Install from controller node (local source)</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#install-from-alternate-sources-like-corporate-nexus-artifactory-proxy-etc">Install from alternate sources (like corporate Nexus, artifactory, proxy, etc)</a></li>
|
||||
</ul>
|
||||
|
@ -69,6 +66,7 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Middleware_Automation.Keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
|
||||
|
@ -159,24 +157,6 @@
|
|||
</ul>
|
||||
<p>Both playbooks include the <code class="docutils literal notranslate"><span class="pre">keycloak</span></code> role, with different settings, as described in the following sections.</p>
|
||||
<p>For full service configuration details, refer to the <a class="reference external" href="https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak/README.md">keycloak role README</a>.</p>
|
||||
</section>
|
||||
<section id="choosing-between-upstream-project-keycloak-and-red-hat-single-sign-on-rhsso">
|
||||
<h3>Choosing between upstream project (Keycloak) and Red Hat Single Sign-On (RHSSO)<a class="headerlink" href="#choosing-between-upstream-project-keycloak-and-red-hat-single-sign-on-rhsso" title="Permalink to this heading"></a></h3>
|
||||
<p>The general flag <code class="docutils literal notranslate"><span class="pre">keycloak_rhsso_enable</span></code> controls what to install between upstream (Keycloak, when <code class="docutils literal notranslate"><span class="pre">False</span></code>) or Red Hat Single Sign-On (when <code class="docutils literal notranslate"><span class="pre">True</span></code>).
|
||||
The default value for the flag if <code class="docutils literal notranslate"><span class="pre">True</span></code> when Red Hat Network credentials are defined, <code class="docutils literal notranslate"><span class="pre">False</span></code> otherwise.</p>
|
||||
<section id="install-upstream-keycloak-from-keycloak-releases">
|
||||
<h4>Install upstream (Keycloak) from keycloak releases<a class="headerlink" href="#install-upstream-keycloak-from-keycloak-releases" title="Permalink to this heading"></a></h4>
|
||||
<p>This is the default approach when RHN credentials are not defined. Keycloak is downloaded from keycloak builds (hosted on github.com) locally, and distributed to target nodes.</p>
|
||||
</section>
|
||||
<section id="install-rhsso-from-the-red-hat-customer-support-portal">
|
||||
<h4>Install RHSSO from the Red Hat Customer Support Portal<a class="headerlink" href="#install-rhsso-from-the-red-hat-customer-support-portal" title="Permalink to this heading"></a></h4>
|
||||
<p>Define the credentials as follows, and the default behaviour is to download a fresh archive of RHSSO on the controller node, then distribute to target nodes.</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">rhn_username</span><span class="p">:</span><span class="w"> </span><span class="s">'<customer_portal_username>'</span><span class="w"></span>
|
||||
<span class="nt">rhn_password</span><span class="p">:</span><span class="w"> </span><span class="s">'<customer_portal_password>'</span><span class="w"></span>
|
||||
<span class="c1"># (keycloak_rhsso_enable defaults to True)</span><span class="w"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="install-from-controller-node-local-source">
|
||||
<h4>Install from controller node (local source)<a class="headerlink" href="#install-from-controller-node-local-source" title="Permalink to this heading"></a></h4>
|
||||
<p>Making the keycloak zip archive (or the RHSSO zip archive), available to the playbook repository root directory, and setting <code class="docutils literal notranslate"><span class="pre">keycloak_offline_install</span></code> to <code class="docutils literal notranslate"><span class="pre">True</span></code>, allows to skip
|
||||
|
@ -193,13 +173,11 @@ the download tasks. The local path for the archive matches the downloaded archiv
|
|||
<section id="install-from-alternate-sources-like-corporate-nexus-artifactory-proxy-etc">
|
||||
<h4>Install from alternate sources (like corporate Nexus, artifactory, proxy, etc)<a class="headerlink" href="#install-from-alternate-sources-like-corporate-nexus-artifactory-proxy-etc" title="Permalink to this heading"></a></h4>
|
||||
<p>For RHSSO:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">keycloak_rhsso_enable</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">True</span><span class="w"></span>
|
||||
<span class="nt">keycloak_rhsso_download_url</span><span class="p">:</span><span class="w"> </span><span class="s">"https://<internal-nexus.private.net>/<path>/<to>/rh-sso-x.y.z-server-dist.zip"</span><span class="w"></span>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">sso_download_url</span><span class="p">:</span><span class="w"> </span><span class="s">"https://<internal-nexus.private.net>/<path>/<to>/rh-sso-x.y.z-server-dist.zip"</span><span class="w"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>For keycloak:</p>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">keycloak_rhsso_enable</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">False</span><span class="w"></span>
|
||||
<span class="nt">keycloak_download_url</span><span class="p">:</span><span class="w"> </span><span class="s">"https://<internal-nexus.private.net>/<path>/<to>/keycloak-x.y.zip"</span><span class="w"></span>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">keycloak_download_url</span><span class="p">:</span><span class="w"> </span><span class="s">"https://<internal-nexus.private.net>/<path>/<to>/keycloak-x.y.zip"</span><span class="w"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
|
@ -262,7 +240,7 @@ the download tasks. The local path for the archive matches the downloaded archiv
|
|||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to Keycloak Collection documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="roles/index.html" class="btn btn-neutral float-right" title="Role Index" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="plugins/index.html" class="btn btn-neutral float-right" title="Middleware_Automation.Keycloak" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
|
|
@ -12,6 +12,7 @@ v1.0.7
|
|||
Breaking Changes / Porting Guide
|
||||
--------------------------------
|
||||
|
||||
- Rename variables from ``infinispan_`` prefix to ``keycloak_infinispan_`` `#42 <https://github.com/ansible-middleware/keycloak/pull/42>`_
|
||||
- keycloak_quarkus: use absolute path for certificate files `#39 <https://github.com/ansible-middleware/keycloak/pull/39>`_
|
||||
|
||||
Bugfixes
|
||||
|
|
|
@ -59,28 +59,6 @@ Both playbooks include the `keycloak` role, with different settings, as describe
|
|||
For full service configuration details, refer to the [keycloak role README](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak/README.md).
|
||||
|
||||
|
||||
### Choosing between upstream project (Keycloak) and Red Hat Single Sign-On (RHSSO)
|
||||
|
||||
The general flag `keycloak_rhsso_enable` controls what to install between upstream (Keycloak, when `False`) or Red Hat Single Sign-On (when `True`).
|
||||
The default value for the flag if `True` when Red Hat Network credentials are defined, `False` otherwise.
|
||||
|
||||
|
||||
#### Install upstream (Keycloak) from keycloak releases
|
||||
|
||||
This is the default approach when RHN credentials are not defined. Keycloak is downloaded from keycloak builds (hosted on github.com) locally, and distributed to target nodes.
|
||||
|
||||
|
||||
#### Install RHSSO from the Red Hat Customer Support Portal
|
||||
|
||||
Define the credentials as follows, and the default behaviour is to download a fresh archive of RHSSO on the controller node, then distribute to target nodes.
|
||||
|
||||
```yaml
|
||||
rhn_username: '<customer_portal_username>'
|
||||
rhn_password: '<customer_portal_password>'
|
||||
# (keycloak_rhsso_enable defaults to True)
|
||||
```
|
||||
|
||||
|
||||
#### Install from controller node (local source)
|
||||
|
||||
Making the keycloak zip archive (or the RHSSO zip archive), available to the playbook repository root directory, and setting `keycloak_offline_install` to `True`, allows to skip
|
||||
|
@ -101,14 +79,12 @@ And depending on `keycloak_rhsso_enable`:
|
|||
For RHSSO:
|
||||
|
||||
```yaml
|
||||
keycloak_rhsso_enable: True
|
||||
keycloak_rhsso_download_url: "https://<internal-nexus.private.net>/<path>/<to>/rh-sso-x.y.z-server-dist.zip"
|
||||
sso_download_url: "https://<internal-nexus.private.net>/<path>/<to>/rh-sso-x.y.z-server-dist.zip"
|
||||
```
|
||||
|
||||
For keycloak:
|
||||
|
||||
```yaml
|
||||
keycloak_rhsso_enable: False
|
||||
keycloak_download_url: "https://<internal-nexus.private.net>/<path>/<to>/keycloak-x.y.zip"
|
||||
```
|
||||
|
||||
|
|
53
main/_sources/plugins/index.rst.txt
Normal file
53
main/_sources/plugins/index.rst.txt
Normal file
|
@ -0,0 +1,53 @@
|
|||
|
||||
|
||||
|
||||
.. _plugins_in_middleware_automation.keycloak:
|
||||
|
||||
Middleware_Automation.Keycloak
|
||||
==============================
|
||||
|
||||
Collection version 1.0.7
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
:depth: 1
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Install and configure a keycloak, or Red Hat Single Sign-on, service.
|
||||
|
||||
**Authors:**
|
||||
|
||||
* Romain Pelisse <rpelisse@redhat.com>
|
||||
* Guido Grazioli <ggraziol@redhat.com>
|
||||
* Pavan Kumar Motaparthi <pmotapar@redhat.com>
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<p class="ansible-links">
|
||||
<a href="https://github.com/ansible-middleware/keycloak/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
||||
<a href="https://github.com/ansible-middleware/keycloak" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
|
||||
Plugin Index
|
||||
------------
|
||||
|
||||
There are no plugins in the middleware_automation.keycloak collection with automatically generated documentation.
|
||||
|
||||
|
||||
|
||||
.. seealso::
|
||||
|
||||
List of :ref:`collections <list_of_collections>` with docs hosted here.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
|
@ -74,16 +74,11 @@ Role Defaults
|
|||
|
||||
| Variable | Description | Default |
|
||||
|:---------|:------------|:---------|
|
||||
|`keycloak_rhsso_enable`| Enable Red Hat Single Sign-on installation | `False` |
|
||||
|`keycloak_offline_install` | perform an offline install | `False`|
|
||||
|`keycloak_download_url`| Download URL for keycloak | `https://github.com/keycloak/keycloak/releases/download/<version>/<archive>`|
|
||||
|`keycloak_rhsso_download_url`| Download URL for RHSSO | `https://access.redhat.com/jbossnetwork/restricted/softwareDownload.html?softwareId=<productID>`|
|
||||
|`keycloak_version`| keycloak.org package version | `15.0.2` |
|
||||
|`keycloak_rhsso_version`| RHSSO version | `7.5.0` |
|
||||
|`keycloak_rhsso_apply_patches`| Install RHSSO more recent cumulative patch | `False` |
|
||||
|`keycloak_dest`| Installation root path | `/opt/keycloak` |
|
||||
|`keycloak_download_url` | Download URL for keycloak | `https://github.com/keycloak/keycloak/releases/download/{{ keycloak_version }}/{{ keycloak_archive }}` |
|
||||
|`keycloak_rhn_url` | Base download URI for customer portal | `https://access.redhat.com/jbossnetwork/restricted/softwareDownload.html?softwareId=` |
|
||||
|`keycloak_configure_firewalld` | Ensure firewalld is running and configure keycloak ports | `False` |
|
||||
|
||||
|
||||
|
@ -94,9 +89,6 @@ Role Defaults
|
|||
|`keycloak_archive` | keycloak install archive filename | `keycloak-{{ keycloak_version }}.zip` |
|
||||
|`keycloak_download_url_9x` | Download URL for keycloak (deprecated) | `https://downloads.jboss.org/keycloak/{{ keycloak_version }}/{{ keycloak_archive }}` |
|
||||
|`keycloak_installdir` | Installation path | `{{ keycloak_dest }}/keycloak-{{ keycloak_version }}` |
|
||||
|`keycloak_rhsso_archive` | Red Hat SSO install archive filename | `rh-sso-{{ keycloak_rhsso_version }}-server-dist.zip` |
|
||||
|`keycloak_rhsso_installdir`| Installation path for Red Hat SSO | `{{ keycloak_dest }}/rh-sso-{{ keycloak_rhsso_version | regex_replace('^([0-9])\.([0-9]*).*', '\1.\2') }}` |
|
||||
|`keycloak_rhsso_download_url`| Full download URI for Red Hat SSO | `{{ keycloak_rhn_url }}{{ rhsso_rhn_id }}` |
|
||||
|`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 }}` |
|
||||
|
@ -106,7 +98,6 @@ Role Defaults
|
|||
|`keycloak_force_install` | Remove pre-existing versions of service | `False` |
|
||||
|`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 }}` |
|
||||
|`rhsso_rhn_id` | Customer Portal product ID for Red Hat SSO | `{{ rhsso_rhn_ids[keycloak_rhsso_version].id }}` |
|
||||
|
||||
|
||||
Role Variables
|
||||
|
@ -126,13 +117,13 @@ The following variables are _required_ only when `keycloak_ha_enabled` is True:
|
|||
|:---------|:------------|:---------|
|
||||
|`keycloak_modcluster_url` | URL for the modcluster reverse proxy | `localhost` |
|
||||
|`keycloak_jdbc_engine` | backend database engine when db is enabled: [ postgres, mariadb ] | `postgres` |
|
||||
|`infinispan_url` | URL for the infinispan remote-cache server | `localhost:11122` |
|
||||
|`infinispan_user` | username for connecting to infinispan | `supervisor` |
|
||||
|`infinispan_pass` | password for connecting to infinispan | `supervisor` |
|
||||
|`infinispan_sasl_mechanism`| Authentication type | `SCRAM-SHA-512` |
|
||||
|`infinispan_use_ssl`| Enable hotrod TLS communication | `False` |
|
||||
|`infinispan_trust_store_path`| Path to truststore with infinispan server certificate | `/etc/pki/java/cacerts` |
|
||||
|`infinispan_trust_store_password`| Password for opening truststore | `changeit` |
|
||||
|`keycloak_infinispan_url` | URL for the infinispan remote-cache server | `localhost:11122` |
|
||||
|`keycloak_infinispan_user` | username for connecting to infinispan | `supervisor` |
|
||||
|`keycloak_infinispan_pass` | password for connecting to infinispan | `supervisor` |
|
||||
|`keycloak_infinispan_sasl_mechanism`| Authentication type | `SCRAM-SHA-512` |
|
||||
|`keycloak_infinispan_use_ssl`| Enable hotrod TLS communication | `False` |
|
||||
|`keycloak_infinispan_trust_store_path`| Path to truststore with infinispan server certificate | `/etc/pki/java/cacerts` |
|
||||
|`keycloak_infinispan_trust_store_password`| Password for opening truststore | `changeit` |
|
||||
|
||||
|
||||
The following variables are _required_ only when `keycloak_db_enabled` is True:
|
||||
|
@ -145,12 +136,9 @@ The following variables are _required_ only when `keycloak_db_enabled` is True:
|
|||
|`keycloak_db_pass` | password for connecting to postgres | `keycloak-pass` |
|
||||
|
||||
|
||||
Example Playbooks
|
||||
Example Playbook
|
||||
-----------------
|
||||
|
||||
_NOTE_: use ansible vaults or other security systems for storing credentials.
|
||||
|
||||
|
||||
* The following is an example playbook that makes use of the role to install keycloak from remote:
|
||||
|
||||
```yaml
|
||||
|
@ -164,27 +152,6 @@ _NOTE_: use ansible vaults or other security systems for storing credentials.
|
|||
- middleware_automation.keycloak.keycloak
|
||||
```
|
||||
|
||||
* The following is an example playbook that makes use of the role to install Red Hat Single Sign-On from RHN:
|
||||
|
||||
```yaml
|
||||
---
|
||||
- name: Playbook for RHSSO
|
||||
hosts: keycloak
|
||||
collections:
|
||||
- middleware_automation.redhat_csp_download
|
||||
roles:
|
||||
- redhat_csp_download
|
||||
tasks:
|
||||
- name: Keycloak Role
|
||||
include_role:
|
||||
name: keycloak
|
||||
vars:
|
||||
keycloak_admin_password: "remembertochangeme"
|
||||
keycloak_rhsso_enable: True
|
||||
rhn_username: '<customer portal username>'
|
||||
rhn_password: '<customer portal password>'
|
||||
```
|
||||
|
||||
|
||||
* The following example playbook makes use of the role to install keycloak from the controller node:
|
||||
|
||||
|
@ -203,45 +170,6 @@ _NOTE_: use ansible vaults or other security systems for storing credentials.
|
|||
# This should be the filename of keycloak archive on Ansible node: keycloak-16.1.0.zip
|
||||
```
|
||||
|
||||
|
||||
* This playbook installs Red Hat Single Sign-On from an alternate url:
|
||||
|
||||
```yaml
|
||||
---
|
||||
- hosts: keycloak
|
||||
collections:
|
||||
- middleware_automation.keycloak
|
||||
tasks:
|
||||
- name: Keycloak Role
|
||||
include_role:
|
||||
name: keycloak
|
||||
vars:
|
||||
keycloak_admin_password: "remembertochangeme"
|
||||
keycloak_rhsso_enable: True
|
||||
keycloak_rhsso_download_url: "<REPLACE with download url>"
|
||||
# This should be the full of remote source rhsso zip file and can contain basic authentication credentials
|
||||
```
|
||||
|
||||
|
||||
* The following is an example playbook that makes use of the role to install Red Hat Single Sign-On offline from the controller node, and apply latest cumulative patch:
|
||||
|
||||
```yaml
|
||||
---
|
||||
- hosts: keycloak
|
||||
collections:
|
||||
- middleware_automation.keycloak
|
||||
tasks:
|
||||
- name: Keycloak Role
|
||||
include_role:
|
||||
name: keycloak
|
||||
vars:
|
||||
keycloak_admin_password: "remembertochangeme"
|
||||
keycloak_rhsso_enable: True
|
||||
keycloak_offline_install: True
|
||||
keycloak_rhsso_apply_patches: True
|
||||
# This should be the filename of rhsso zip file on Ansible node: rh-sso-7.5-server-dist.zip
|
||||
```
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
|
|
|
@ -15,7 +15,6 @@ Role Defaults
|
|||
|`keycloak_http_port`| HTTP port | `8080` |
|
||||
|`keycloak_https_port`| TLS HTTP port | `8443` |
|
||||
|`keycloak_auth_realm`| Name of the main authentication realm | `master` |
|
||||
|`keycloak_rhsso_enable`| Define service is an upstream(Keycloak) or RHSSO | `master` |
|
||||
|`keycloak_management_http_port`| Management port | `9990` |
|
||||
|`keycloak_auth_client`| Authentication client for configuration REST calls | `admin-cli` |
|
||||
|`keycloak_client_public`| Configure a public realm client | `True` |
|
||||
|
|
|
@ -42,6 +42,7 @@
|
|||
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="README.html">Ansible Collection - middleware_automation.keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Middleware_Automation.Keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
|
||||
|
|
|
@ -39,6 +39,7 @@
|
|||
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="README.html">Ansible Collection - middleware_automation.keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Middleware_Automation.Keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
|
||||
|
|
|
@ -41,6 +41,7 @@
|
|||
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="README.html">Ansible Collection - middleware_automation.keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Middleware_Automation.Keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
|
||||
|
@ -92,6 +93,11 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="README.html#license">License</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Middleware_Automation.Keycloak</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="plugins/index.html#description">Description</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="plugins/index.html#plugin-index">Plugin Index</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="roles/keycloak.html">keycloak</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="roles/keycloak_quarkus.html">keycloak_quarkus</a></li>
|
||||
|
|
BIN
main/objects.inv
BIN
main/objects.inv
Binary file not shown.
158
main/plugins/index.html
Normal file
158
main/plugins/index.html
Normal file
|
@ -0,0 +1,158 @@
|
|||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Middleware_Automation.Keycloak — Keycloak Ansible Collection documentation</title>
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/ansible-basic-sphinx-ext.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
<script src="../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="Role Index" href="../roles/index.html" />
|
||||
<link rel="prev" title="Ansible Collection - middleware_automation.keycloak" href="../README.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
<a href="../index.html" class="icon icon-home"> Keycloak Ansible Collection
|
||||
</a>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="../README.html">Ansible Collection - middleware_automation.keycloak</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Middleware_Automation.Keycloak</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#description">Description</a><ul class="simple">
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#plugin-index">Plugin Index</a><ul class="simple">
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../roles/index.html">Role Index</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../testing.html">Testing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../developing.html">Contributor’s Guidelines</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../releasing.html">Collection Versioning Strategy</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">General</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../CHANGELOG.html">Changelog</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="../index.html">Keycloak Ansible Collection</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../index.html" class="icon icon-home"></a> »</li>
|
||||
<li>Middleware_Automation.Keycloak</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="../_sources/plugins/index.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="middleware-automation-keycloak">
|
||||
<span id="plugins-in-middleware-automation-keycloak"></span><h1>Middleware_Automation.Keycloak<a class="headerlink" href="#middleware-automation-keycloak" title="Permalink to this heading"></a></h1>
|
||||
<p>Collection version 1.0.7</p>
|
||||
<div class="contents local topic" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#description" id="id1">Description</a></p></li>
|
||||
<li><p><a class="reference internal" href="#plugin-index" id="id2">Plugin Index</a></p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<section id="description">
|
||||
<h2><a class="toc-backref" href="#id1">Description</a><a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
|
||||
<p>Install and configure a keycloak, or Red Hat Single Sign-on, service.</p>
|
||||
<p><strong>Authors:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p>Romain Pelisse <<a class="reference external" href="mailto:rpelisse%40redhat.com">rpelisse<span>@</span>redhat<span>.</span>com</a>></p></li>
|
||||
<li><p>Guido Grazioli <<a class="reference external" href="mailto:ggraziol%40redhat.com">ggraziol<span>@</span>redhat<span>.</span>com</a>></p></li>
|
||||
<li><p>Pavan Kumar Motaparthi <<a class="reference external" href="mailto:pmotapar%40redhat.com">pmotapar<span>@</span>redhat<span>.</span>com</a>></p></li>
|
||||
</ul>
|
||||
<p class="ansible-links">
|
||||
<a href="https://github.com/ansible-middleware/keycloak/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
|
||||
<a href="https://github.com/ansible-middleware/keycloak" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
|
||||
</p><div class="toctree-wrapper compound">
|
||||
</div>
|
||||
</section>
|
||||
<section id="plugin-index">
|
||||
<h2><a class="toc-backref" href="#id2">Plugin Index</a><a class="headerlink" href="#plugin-index" title="Permalink to this heading"></a></h2>
|
||||
<p>There are no plugins in the middleware_automation.keycloak collection with automatically generated documentation.</p>
|
||||
<div class="admonition seealso">
|
||||
<p class="admonition-title">See also</p>
|
||||
<p>List of <a class="reference external" href="https://docs.ansible.com/ansible/latest/collections/index.html#list-of-collections" title="(in Ansible v6)"><span class="xref std std-ref">collections</span></a> with docs hosted here.</p>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound">
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="../README.html" class="btn btn-neutral float-left" title="Ansible Collection - middleware_automation.keycloak" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="../roles/index.html" class="btn btn-neutral float-right" title="Role Index" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2022, Red Hat, Inc..</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
|
@ -42,6 +42,7 @@
|
|||
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="README.html">Ansible Collection - middleware_automation.keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Middleware_Automation.Keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
|
||||
|
|
|
@ -21,7 +21,7 @@
|
|||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="keycloak" href="keycloak.html" />
|
||||
<link rel="prev" title="Ansible Collection - middleware_automation.keycloak" href="../README.html" />
|
||||
<link rel="prev" title="Middleware_Automation.Keycloak" href="../plugins/index.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
@ -42,6 +42,7 @@
|
|||
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="../README.html">Ansible Collection - middleware_automation.keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../plugins/index.html">Middleware_Automation.Keycloak</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Role Index</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="keycloak.html">keycloak</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="keycloak_quarkus.html">keycloak_quarkus</a></li>
|
||||
|
@ -95,7 +96,7 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="keycloak.html#patching">Patching</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="keycloak.html#role-defaults">Role Defaults</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="keycloak.html#role-variables">Role Variables</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="keycloak.html#example-playbooks">Example Playbooks</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="keycloak.html#example-playbook">Example Playbook</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="keycloak.html#license">License</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="keycloak.html#author-information">Author Information</a></li>
|
||||
</ul>
|
||||
|
@ -124,7 +125,7 @@
|
|||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="../README.html" class="btn btn-neutral float-left" title="Ansible Collection - middleware_automation.keycloak" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="../plugins/index.html" class="btn btn-neutral float-left" title="Middleware_Automation.Keycloak" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="keycloak.html" class="btn btn-neutral float-right" title="keycloak" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
|
|
|
@ -42,6 +42,7 @@
|
|||
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="../README.html">Ansible Collection - middleware_automation.keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../plugins/index.html">Middleware_Automation.Keycloak</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Role Index</a><ul class="current">
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">keycloak</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#requirements">Requirements</a></li>
|
||||
|
@ -50,7 +51,7 @@
|
|||
<li class="toctree-l3"><a class="reference internal" href="#patching">Patching</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#role-defaults">Role Defaults</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#role-variables">Role Variables</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#example-playbooks">Example Playbooks</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#example-playbook">Example Playbook</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#license">License</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#author-information">Author Information</a></li>
|
||||
</ul>
|
||||
|
@ -259,34 +260,18 @@
|
|||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_rhsso_enable</span></code></p></td>
|
||||
<td class="text-left"><p>Enable Red Hat Single Sign-on installation</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_offline_install</span></code></p></td>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_offline_install</span></code></p></td>
|
||||
<td class="text-left"><p>perform an offline install</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_download_url</span></code></p></td>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_download_url</span></code></p></td>
|
||||
<td class="text-left"><p>Download URL for keycloak</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">https://github.com/keycloak/keycloak/releases/download/<version>/<archive></span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_rhsso_download_url</span></code></p></td>
|
||||
<td class="text-left"><p>Download URL for RHSSO</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">https://access.redhat.com/jbossnetwork/restricted/softwareDownload.html?softwareId=<productID></span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_version</span></code></p></td>
|
||||
<td class="text-left"><p>keycloak.org package version</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">15.0.2</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_rhsso_version</span></code></p></td>
|
||||
<td class="text-left"><p>RHSSO version</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">7.5.0</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_rhsso_apply_patches</span></code></p></td>
|
||||
<td class="text-left"><p>Install RHSSO more recent cumulative patch</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_dest</span></code></p></td>
|
||||
<td class="text-left"><p>Installation root path</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">/opt/keycloak</span></code></p></td>
|
||||
|
@ -295,11 +280,7 @@
|
|||
<td class="text-left"><p>Download URL for keycloak</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">https://github.com/keycloak/keycloak/releases/download/{{</span> <span class="pre">keycloak_version</span> <span class="pre">}}/{{</span> <span class="pre">keycloak_archive</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_rhn_url</span></code></p></td>
|
||||
<td class="text-left"><p>Base download URI for customer portal</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">https://access.redhat.com/jbossnetwork/restricted/softwareDownload.html?softwareId=</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_configure_firewalld</span></code></p></td>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_configure_firewalld</span></code></p></td>
|
||||
<td class="text-left"><p>Ensure firewalld is running and configure keycloak ports</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p></td>
|
||||
</tr>
|
||||
|
@ -328,58 +309,42 @@
|
|||
<td class="text-left"><p>Installation path</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">keycloak_dest</span> <span class="pre">}}/keycloak-{{</span> <span class="pre">keycloak_version</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_rhsso_archive</span></code></p></td>
|
||||
<td class="text-left"><p>Red Hat SSO install archive filename</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">rh-sso-{{</span> <span class="pre">keycloak_rhsso_version</span> <span class="pre">}}-server-dist.zip</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_rhsso_installdir</span></code></p></td>
|
||||
<td class="text-left"><p>Installation path for Red Hat SSO</p></td>
|
||||
<td class="text-left"><p>`{{ keycloak_dest }}/rh-sso-{{ keycloak_rhsso_version</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_rhsso_download_url</span></code></p></td>
|
||||
<td class="text-left"><p>Full download URI for Red Hat SSO</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">keycloak_rhn_url</span> <span class="pre">}}{{</span> <span class="pre">rhsso_rhn_id</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">keycloak_jboss_home</span></code></p></td>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_jboss_home</span></code></p></td>
|
||||
<td class="text-left"><p>Installation work directory</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">keycloak_rhsso_installdir</span> <span class="pre">if</span> <span class="pre">keycloak_rhsso_enable</span> <span class="pre">else</span> <span class="pre">keycloak_installdir</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_config_dir</span></code></p></td>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_config_dir</span></code></p></td>
|
||||
<td class="text-left"><p>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></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_config_path_to_standalone_xml</span></code></p></td>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_config_path_to_standalone_xml</span></code></p></td>
|
||||
<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_config_override_template</span></code></p></td>
|
||||
<tr class="row-even"><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>
|
||||
<tr class="row-odd"><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-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_auth_client</span></code></p></td>
|
||||
<tr class="row-even"><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-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_force_install</span></code></p></td>
|
||||
<tr class="row-odd"><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-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_url</span></code></p></td>
|
||||
<tr class="row-even"><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-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_management_url</span></code></p></td>
|
||||
<tr class="row-odd"><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-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>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
|
@ -418,31 +383,31 @@
|
|||
<td class="text-left"><p>backend database engine when db is enabled: [ postgres, mariadb ]</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">postgres</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">infinispan_url</span></code></p></td>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_infinispan_url</span></code></p></td>
|
||||
<td class="text-left"><p>URL for the infinispan remote-cache server</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">localhost:11122</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">infinispan_user</span></code></p></td>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_infinispan_user</span></code></p></td>
|
||||
<td class="text-left"><p>username for connecting to infinispan</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">supervisor</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">infinispan_pass</span></code></p></td>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_infinispan_pass</span></code></p></td>
|
||||
<td class="text-left"><p>password for connecting to infinispan</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">supervisor</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">infinispan_sasl_mechanism</span></code></p></td>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_infinispan_sasl_mechanism</span></code></p></td>
|
||||
<td class="text-left"><p>Authentication type</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">SCRAM-SHA-512</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">infinispan_use_ssl</span></code></p></td>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_infinispan_use_ssl</span></code></p></td>
|
||||
<td class="text-left"><p>Enable hotrod TLS communication</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">infinispan_trust_store_path</span></code></p></td>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_infinispan_trust_store_path</span></code></p></td>
|
||||
<td class="text-left"><p>Path to truststore with infinispan server certificate</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">/etc/pki/java/cacerts</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">infinispan_trust_store_password</span></code></p></td>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_infinispan_trust_store_password</span></code></p></td>
|
||||
<td class="text-left"><p>Password for opening truststore</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">changeit</span></code></p></td>
|
||||
</tr>
|
||||
|
@ -476,9 +441,8 @@
|
|||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section id="example-playbooks">
|
||||
<h2>Example Playbooks<a class="headerlink" href="#example-playbooks" title="Permalink to this heading"></a></h2>
|
||||
<p><em>NOTE</em>: use ansible vaults or other security systems for storing credentials.</p>
|
||||
<section id="example-playbook">
|
||||
<h2>Example Playbook<a class="headerlink" href="#example-playbook" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>The following is an example playbook that makes use of the role to install keycloak from remote:</p></li>
|
||||
</ul>
|
||||
|
@ -493,27 +457,6 @@
|
|||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>The following is an example playbook that makes use of the role to install Red Hat Single Sign-On from RHN:</p></li>
|
||||
</ul>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nn">---</span><span class="w"></span>
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Playbook for RHSSO</span><span class="w"></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">keycloak</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">collections</span><span class="p">:</span><span class="w"></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.redhat_csp_download</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">roles</span><span class="p">:</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">redhat_csp_download</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">tasks</span><span class="p">:</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Keycloak Role</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">include_role</span><span class="p">:</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">keycloak</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">vars</span><span class="p">:</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">keycloak_admin_password</span><span class="p">:</span><span class="w"> </span><span class="s">"remembertochangeme"</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">keycloak_rhsso_enable</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">True</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">rhn_username</span><span class="p">:</span><span class="w"> </span><span class="s">'<customer</span><span class="nv"> </span><span class="s">portal</span><span class="nv"> </span><span class="s">username>'</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">rhn_password</span><span class="p">:</span><span class="w"> </span><span class="s">'<customer</span><span class="nv"> </span><span class="s">portal</span><span class="nv"> </span><span class="s">password>'</span><span class="w"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>The following example playbook makes use of the role to install keycloak from the controller node:</p></li>
|
||||
</ul>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nn">---</span><span class="w"></span>
|
||||
|
@ -530,43 +473,6 @@
|
|||
<span class="w"> </span><span class="c1"># This should be the filename of keycloak archive on Ansible node: keycloak-16.1.0.zip</span><span class="w"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>This playbook installs Red Hat Single Sign-On from an alternate url:</p></li>
|
||||
</ul>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nn">---</span><span class="w"></span>
|
||||
<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">keycloak</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">collections</span><span class="p">:</span><span class="w"></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="w"> </span><span class="nt">tasks</span><span class="p">:</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Keycloak Role</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">include_role</span><span class="p">:</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">keycloak</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">vars</span><span class="p">:</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">keycloak_admin_password</span><span class="p">:</span><span class="w"> </span><span class="s">"remembertochangeme"</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">keycloak_rhsso_enable</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">True</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">keycloak_rhsso_download_url</span><span class="p">:</span><span class="w"> </span><span class="s">"<REPLACE</span><span class="nv"> </span><span class="s">with</span><span class="nv"> </span><span class="s">download</span><span class="nv"> </span><span class="s">url>"</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="c1"># This should be the full of remote source rhsso zip file and can contain basic authentication credentials</span><span class="w"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<ul class="simple">
|
||||
<li><p>The following is an example playbook that makes use of the role to install Red Hat Single Sign-On offline from the controller node, and apply latest cumulative patch:</p></li>
|
||||
</ul>
|
||||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nn">---</span><span class="w"></span>
|
||||
<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">keycloak</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">collections</span><span class="p">:</span><span class="w"></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="w"> </span><span class="nt">tasks</span><span class="p">:</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Keycloak Role</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">include_role</span><span class="p">:</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">keycloak</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">vars</span><span class="p">:</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">keycloak_admin_password</span><span class="p">:</span><span class="w"> </span><span class="s">"remembertochangeme"</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">keycloak_rhsso_enable</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">True</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">keycloak_offline_install</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">True</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="nt">keycloak_rhsso_apply_patches</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">True</span><span class="w"></span>
|
||||
<span class="w"> </span><span class="c1"># This should be the filename of rhsso zip file on Ansible node: rh-sso-7.5-server-dist.zip</span><span class="w"></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="license">
|
||||
<h2>License<a class="headerlink" href="#license" title="Permalink to this heading"></a></h2>
|
||||
|
|
|
@ -42,6 +42,7 @@
|
|||
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="../README.html">Ansible Collection - middleware_automation.keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../plugins/index.html">Middleware_Automation.Keycloak</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Role Index</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="keycloak.html">keycloak</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">keycloak_quarkus</a><ul>
|
||||
|
|
|
@ -42,6 +42,7 @@
|
|||
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="../README.html">Ansible Collection - middleware_automation.keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../plugins/index.html">Middleware_Automation.Keycloak</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Role Index</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="keycloak.html">keycloak</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="keycloak_quarkus.html">keycloak_quarkus</a></li>
|
||||
|
@ -130,31 +131,27 @@
|
|||
<td class="text-left"><p>Name of the main 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_rhsso_enable</span></code></p></td>
|
||||
<td class="text-left"><p>Define service is an upstream(Keycloak) or RHSSO</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">master</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_management_http_port</span></code></p></td>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_management_http_port</span></code></p></td>
|
||||
<td class="text-left"><p>Management port</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">9990</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_client_public</span></code></p></td>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_client_public</span></code></p></td>
|
||||
<td class="text-left"><p>Configure a public realm client</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">True</span></code></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_client_web_origins</span></code></p></td>
|
||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_client_web_origins</span></code></p></td>
|
||||
<td class="text-left"><p>Web origins for realm client</p></td>
|
||||
<td class="text-left"><p><code class="docutils literal notranslate"><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_url</span></code></p></td>
|
||||
<tr class="row-even"><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-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_management_url</span></code></p></td>
|
||||
<tr class="row-odd"><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>
|
||||
|
|
|
@ -42,6 +42,7 @@
|
|||
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="README.html">Ansible Collection - middleware_automation.keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Middleware_Automation.Keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
|
||||
|
|
File diff suppressed because one or more lines are too long
|
@ -42,6 +42,7 @@
|
|||
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="README.html">Ansible Collection - middleware_automation.keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Middleware_Automation.Keycloak</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
|
||||
|
|
Loading…
Add table
Reference in a new issue