ansible-collections/middleware_automation.keycloak
1
0
Fork 0
mirror of https://github.com/ansible-middleware/keycloak.git synced 2025-04-09 04:10:27 -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-11-25 07:41:53 +00:00
parent 2c1d240d24
commit 91ce0d473a
15 changed files with 353 additions and 322 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

622
main/CHANGELOG.html
View file

File diff suppressed because it is too large Load diff

10
main/_sources/CHANGELOG.rst.txt
View file

@ -6,9 +6,17 @@ middleware\_automation.keycloak Release Notes
This changelog describes changes after version 0.2.6. This changelog describes changes after version 0.2.6.
v2.4.3-devel v2.4.4-devel
============ ============
Bugfixes
--------
- Rebuild config and restart service for local providers `#250 <https://github.com/ansible-middleware/keycloak/pull/250>`_
v2.4.3
======
Minor Changes Minor Changes
------------- -------------

2
main/_sources/plugins/keycloak_client.rst.txt
View file

@ -6,7 +6,7 @@
:trim: :trim:
.. meta:: .. meta::
:antsibull-docs: 2.15.0 :antsibull-docs: 2.16.1
.. Anchors .. Anchors

2
main/_sources/plugins/keycloak_realm.rst.txt
View file

@ -6,7 +6,7 @@
:trim: :trim:
.. meta:: .. meta::
:antsibull-docs: 2.15.0 :antsibull-docs: 2.16.1
.. Anchors .. Anchors

2
main/_sources/plugins/keycloak_role.rst.txt
View file

@ -6,7 +6,7 @@
:trim: :trim:
.. meta:: .. meta::
:antsibull-docs: 2.15.0 :antsibull-docs: 2.16.1
.. Anchors .. Anchors

2
main/_sources/plugins/keycloak_user_federation.rst.txt
View file

@ -6,7 +6,7 @@
:trim: :trim:
.. meta:: .. meta::
:antsibull-docs: 2.15.0 :antsibull-docs: 2.16.1
.. Anchors .. Anchors

2
main/_sources/roles/keycloak_quarkus.md.txt
View file

@ -200,7 +200,7 @@ keycloak_quarkus_providers:
- id: http-client # required; "{{ id }}.jar" identifies the file name on RHBK - id: http-client # required; "{{ id }}.jar" identifies the file name on RHBK
spi: connections # required if neither url, local_path nor maven are specified; required for setting properties spi: connections # required if neither url, local_path nor maven are specified; required for setting properties
default: true # optional, whether to set default for spi, default false default: true # optional, whether to set default for spi, default false
restart: true # optional, whether to restart, default true restart: true # optional, whether to rebuild config and restart the service after deploying, default true
url: https://.../.../custom_spi.jar # optional, url for download via http url: https://.../.../custom_spi.jar # optional, url for download via http
local_path: my_theme_spi.jar # optional, path on local controller for SPI to be uploaded local_path: my_theme_spi.jar # optional, path on local controller for SPI to be uploaded
maven: # optional, for download using maven maven: # optional, for download using maven

10
main/_static/js/versions.js
View file

@ -1,6 +1,6 @@
const themeFlyoutDisplay = "hidden"; const themeFlyoutDisplay = "hidden";
const themeVersionSelector = "True"; const themeVersionSelector = true;
const themeLanguageSelector = "True"; const themeLanguageSelector = true;
if (themeFlyoutDisplay === "attached") { if (themeFlyoutDisplay === "attached") {
function renderLanguages(config) { function renderLanguages(config) {
@ -8,10 +8,14 @@ if (themeFlyoutDisplay === "attached") {
return ""; return "";
} }
// Insert the current language to the options on the selector
let languages = config.projects.translations.concat(config.projects.current);
languages = languages.sort((a, b) => a.language.name.localeCompare(b.language.name));
const languagesHTML = ` const languagesHTML = `
<dl> <dl>
<dt>Languages</dt> <dt>Languages</dt>
${config.projects.translations ${languages
.map( .map(
(translation) => ` (translation) => `
<dd ${translation.slug == config.projects.current.slug ? 'class="rtd-current-item"' : ""}> <dd ${translation.slug == config.projects.current.slug ? 'class="rtd-current-item"' : ""}>

3
main/index.html
View file

@ -120,7 +120,8 @@
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="CHANGELOG.html">Changelog</a><ul> <li class="toctree-l1"><a class="reference internal" href="CHANGELOG.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-4-3-devel">v2.4.3-devel</a></li> <li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-4-4-devel">v2.4.4-devel</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-4-3">v2.4.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-4-2">v2.4.2</a></li> <li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-4-2">v2.4.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-4-1">v2.4.1</a></li> <li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-4-1">v2.4.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-4-0">v2.4.0</a></li> <li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-4-0">v2.4.0</a></li>

4
main/plugins/keycloak_client.html
View file

@ -4,7 +4,7 @@
<html class="writer-html5" lang="en" data-content_root="../"> <html class="writer-html5" lang="en" data-content_root="../">
<head> <head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta content="2.15.0" name="antsibull-docs" /> <meta content="2.16.1" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>keycloak_client – Allows administration of Keycloak clients via Keycloak API &mdash; Keycloak Ansible Collection documentation</title> <title>keycloak_client – Allows administration of Keycloak clients via Keycloak API &mdash; Keycloak Ansible Collection documentation</title>
@ -1747,7 +1747,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</section> </section>
<section id="return-values"> <section id="return-values">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2>
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible v10)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p> <p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible v11)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%"> <table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"> <tr class="row-odd">

4
main/plugins/keycloak_realm.html
View file

@ -4,7 +4,7 @@
<html class="writer-html5" lang="en" data-content_root="../"> <html class="writer-html5" lang="en" data-content_root="../">
<head> <head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta content="2.15.0" name="antsibull-docs" /> <meta content="2.16.1" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>keycloak_realm – Allows administration of Keycloak realm via Keycloak API &mdash; Keycloak Ansible Collection documentation</title> <title>keycloak_realm – Allows administration of Keycloak realm via Keycloak API &mdash; Keycloak Ansible Collection documentation</title>
@ -1634,7 +1634,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</section> </section>
<section id="return-values"> <section id="return-values">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2>
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible v10)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p> <p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible v11)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%"> <table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"> <tr class="row-odd">

4
main/plugins/keycloak_role.html
View file

@ -4,7 +4,7 @@
<html class="writer-html5" lang="en" data-content_root="../"> <html class="writer-html5" lang="en" data-content_root="../">
<head> <head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta content="2.15.0" name="antsibull-docs" /> <meta content="2.16.1" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>keycloak_role – Allows administration of Keycloak roles via Keycloak API &mdash; Keycloak Ansible Collection documentation</title> <title>keycloak_role – Allows administration of Keycloak roles via Keycloak API &mdash; Keycloak Ansible Collection documentation</title>
@ -579,7 +579,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</section> </section>
<section id="return-values"> <section id="return-values">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2>
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible v10)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p> <p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible v11)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%"> <table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"> <tr class="row-odd">

4
main/plugins/keycloak_user_federation.html
View file

@ -4,7 +4,7 @@
<html class="writer-html5" lang="en" data-content_root="../"> <html class="writer-html5" lang="en" data-content_root="../">
<head> <head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta content="2.15.0" name="antsibull-docs" /> <meta content="2.16.1" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>keycloak_user_federation – Allows administration of Keycloak user federations via Keycloak API &mdash; Keycloak Ansible Collection documentation</title> <title>keycloak_user_federation – Allows administration of Keycloak user federations via Keycloak API &mdash; Keycloak Ansible Collection documentation</title>
@ -1486,7 +1486,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</section> </section>
<section id="return-values"> <section id="return-values">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2> <h2><a class="toc-backref" href="#id5" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2>
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible v10)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p> <p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible v11)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%"> <table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
<thead> <thead>
<tr class="row-odd"> <tr class="row-odd">

2
main/roles/keycloak_quarkus.html
View file

@ -696,7 +696,7 @@
<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; &quot;{{ id }}.jar&quot; identifies the file name on RHBK</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; &quot;{{ id }}.jar&quot; identifies the file name on RHBK</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 neither url, local_path nor maven are specified; required for setting properties</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 neither url, local_path nor maven are specified; required for setting properties</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">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">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 rebuild config and restart the service after deploying, 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 via http</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 via http</span>
<span class="w"> </span><span class="nt">local_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_theme_spi.jar</span><span class="w"> </span><span class="c1"># optional, path on local controller for SPI to be uploaded</span> <span class="w"> </span><span class="nt">local_path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_theme_spi.jar</span><span class="w"> </span><span class="c1"># optional, path on local controller for SPI to be uploaded</span>
<span class="w"> </span><span class="nt">maven</span><span class="p">:</span><span class="w"> </span><span class="c1"># optional, for download using maven</span> <span class="w"> </span><span class="nt">maven</span><span class="p">:</span><span class="w"> </span><span class="c1"># optional, for download using maven</span>

2
main/searchindex.js
View file

File diff suppressed because one or more lines are too long