Update docs for main

Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
This commit is contained in:
ansible-middleware-core 2024-04-19 12:45:12 +00:00
commit 9db3d21064
6 changed files with 263 additions and 235 deletions

View file

@ -133,6 +133,7 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_quarkus.html#role-variables">Role Variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_quarkus.html#role-custom-facts">Role custom facts</a></li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_quarkus.html#license">License</a></li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_quarkus.html#author-information">Author Information</a></li>
</ul>

View file

@ -65,6 +65,7 @@
</ul>
</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="#role-custom-facts">Role custom facts</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>
@ -608,6 +609,22 @@
</tbody>
</table>
</section>
<section id="role-custom-facts">
<h2>Role custom facts<a class="headerlink" href="#role-custom-facts" title="Link to this heading"></a></h2>
<p>The role uses the following <a class="reference external" href="https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_vars_facts.html#adding-custom-facts">custom facts</a> found in <code class="docutils literal notranslate"><span class="pre">/etc/ansible/facts.d/keycloak.fact</span></code> (and thus identified by the <code class="docutils literal notranslate"><span class="pre">ansible_local.keycloak.</span></code> prefix):</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head text-left"><p>Variable</p></th>
<th class="head text-left"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">general.bootstrapped</span></code></p></td>
<td class="text-left"><p>A custom fact indicating whether this role has been used for bootstrapping keycloak on the respective host before; set to <code class="docutils literal notranslate"><span class="pre">false</span></code> (e.g., when starting off with a new, empty database) ensures that the initial admin user as defined by <code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_admin_user[_pass]</span></code> gets created</p></td>
</tr>
</tbody>
</table>
</section>
<section id="license">
<h2>License<a class="headerlink" href="#license" title="Link to this heading"></a></h2>
<p>Apache License 2.0</p>