ansible-collections/middleware_automation.keycloak
1
0
Fork 0
mirror of https://github.com/ansible-middleware/keycloak.git synced 2025-07-29 08:01:33 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update docs for main

Browse source 
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
This commit is contained in:
ansible-middleware-core 2024-04-30 10:48:58 +00:00
commit 53187ec0fd
6 changed files with 299 additions and 235 deletions
Download patch file Download diff file Expand all files Collapse all files

1
main/roles/index.html
View file

@ -130,6 +130,7 @@
<li class="toctree-l3"><a class="reference internal" href="keycloak_quarkus.html#remote-caches-configuration">Remote caches configuration</a></li>
<li class="toctree-l3"><a class="reference internal" href="keycloak_quarkus.html#miscellaneous-configuration">Miscellaneous configuration</a></li>
<li class="toctree-l3"><a class="reference internal" href="keycloak_quarkus.html#vault-spi">Vault SPI</a></li>
<li class="toctree-l3"><a class="reference internal" href="keycloak_quarkus.html#configuring-providers">Configuring providers</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="keycloak_quarkus.html#role-variables">Role Variables</a></li>

34
main/roles/keycloak_quarkus.html
View file

@ -62,6 +62,7 @@
<li class="toctree-l4"><a class="reference internal" href="#remote-caches-configuration">Remote caches configuration</a></li>
<li class="toctree-l4"><a class="reference internal" href="#miscellaneous-configuration">Miscellaneous configuration</a></li>
<li class="toctree-l4"><a class="reference internal" href="#vault-spi">Vault SPI</a></li>
<li class="toctree-l4"><a class="reference internal" href="#configuring-providers">Configuring providers</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#role-variables">Role Variables</a></li>
@ -591,6 +592,39 @@
</tbody>
</table>
</section>
<section id="configuring-providers">
<h3>Configuring providers<a class="headerlink" href="#configuring-providers" title="Link to this heading"></a></h3>
<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>
<th class="head text-left"><p>Default</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_providers</span></code></p></td>
<td class="text-left"><p>List of provider definitions; see below</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">[]</span></code></p></td>
</tr>
</tbody>
</table>
<p>Provider definition:</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">keycloak_quarkus_providers</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http-client</span><span class="w"> </span><span class="c1"># required</span>
<span class="w"> </span><span class="nt">spi</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">connections</span><span class="w"> </span><span class="c1"># required if url is not specified</span>
<span class="w"> </span><span class="nt">default</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="c1"># optional, whether to set default for spi, default false</span>
<span class="w"> </span><span class="nt">restart</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="c1"># optional, whether to restart, default true</span>
<span class="w"> </span><span class="nt">url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://.../.../custom_spi.jar</span><span class="w"> </span><span class="c1"># optional, url for download</span>
<span class="w"> </span><span class="nt">properties</span><span class="p">:</span><span class="w"> </span><span class="c1"># optional, list of key-values</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default-connection-pool-size</span>
<span class="w"> </span><span class="nt">value</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10</span>
</pre></div>
</div>
<p>the definition above will generate the following build command:</p>
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">bin/kc.sh build --spi-connections-provider=http-client --spi-connections-http-client-default-connection-pool-size=10</span>
</pre></div>
</div>
</section>
</section>
<section id="role-variables">
<h2>Role Variables<a class="headerlink" href="#role-variables" title="Link to this heading"></a></h2>