mirror of
https://github.com/ansible-middleware/keycloak.git
synced 2025-09-29 21:13:31 -07:00
Update docs for main
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
This commit is contained in:
parent
d09ba9b325
commit
2b90af4bcb
13 changed files with 363 additions and 365 deletions
File diff suppressed because it is too large
Load diff
|
@ -13,6 +13,7 @@ Major Changes
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
- Update to keycloak 26.3.0 `#293 <https://github.com/ansible-middleware/keycloak/pull/293>`_
|
- Update to keycloak 26.3.0 `#293 <https://github.com/ansible-middleware/keycloak/pull/293>`_
|
||||||
|
- ansible-core 2.19 compatibility `#310 <https://github.com/ansible-middleware/keycloak/pull/310>`_
|
||||||
|
|
||||||
Minor Changes
|
Minor Changes
|
||||||
-------------
|
-------------
|
||||||
|
|
|
@ -6,7 +6,7 @@
|
||||||
:trim:
|
:trim:
|
||||||
|
|
||||||
.. meta::
|
.. meta::
|
||||||
:antsibull-docs: 2.18.0
|
:antsibull-docs: 2.21.0
|
||||||
|
|
||||||
.. Anchors
|
.. Anchors
|
||||||
|
|
||||||
|
@ -1855,7 +1855,6 @@ Authors
|
||||||
- Eike Frost (@eikef)
|
- Eike Frost (@eikef)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
.. Extra links
|
.. Extra links
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -6,7 +6,7 @@
|
||||||
:trim:
|
:trim:
|
||||||
|
|
||||||
.. meta::
|
.. meta::
|
||||||
:antsibull-docs: 2.18.0
|
:antsibull-docs: 2.21.0
|
||||||
|
|
||||||
.. Anchors
|
.. Anchors
|
||||||
|
|
||||||
|
@ -1744,7 +1744,6 @@ Authors
|
||||||
- Christophe Gilles (@kris2kris)
|
- Christophe Gilles (@kris2kris)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
.. Extra links
|
.. Extra links
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -6,7 +6,7 @@
|
||||||
:trim:
|
:trim:
|
||||||
|
|
||||||
.. meta::
|
.. meta::
|
||||||
:antsibull-docs: 2.18.0
|
:antsibull-docs: 2.21.0
|
||||||
|
|
||||||
.. Anchors
|
.. Anchors
|
||||||
|
|
||||||
|
@ -689,7 +689,6 @@ Authors
|
||||||
- Laurent Paumier (@laurpaum)
|
- Laurent Paumier (@laurpaum)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
.. Extra links
|
.. Extra links
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -6,7 +6,7 @@
|
||||||
:trim:
|
:trim:
|
||||||
|
|
||||||
.. meta::
|
.. meta::
|
||||||
:antsibull-docs: 2.18.0
|
:antsibull-docs: 2.21.0
|
||||||
|
|
||||||
.. Anchors
|
.. Anchors
|
||||||
|
|
||||||
|
@ -1596,7 +1596,6 @@ Authors
|
||||||
- Laurent Paumier (@laurpaum)
|
- Laurent Paumier (@laurpaum)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
.. Extra links
|
.. Extra links
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -98,7 +98,7 @@ Role Defaults
|
||||||
| Variable | Description | Default |
|
| Variable | Description | Default |
|
||||||
|:---------|:------------|:--------|
|
|:---------|:------------|:--------|
|
||||||
|`keycloak_quarkus_hostname`| Address at which is the server exposed. Can be a full URL, or just a hostname. When only hostname is provided, scheme, port and context path are resolved from the request. | |
|
|`keycloak_quarkus_hostname`| Address at which is the server exposed. Can be a full URL, or just a hostname. When only hostname is provided, scheme, port and context path are resolved from the request. | |
|
||||||
|`keycloak_quarkus_hostname_admin`| Set the base URL for accessing the administration console, including scheme, host, port and path | |
|
|`keycloak_quarkus_hostname_admin`| Set the base URL for accessing the administration console, including scheme, host, port and path | `` |
|
||||||
|`keycloak_quarkus_hostname_strict`| Disables dynamically resolving the hostname from request headers | `true` |
|
|`keycloak_quarkus_hostname_strict`| Disables dynamically resolving the hostname from request headers | `true` |
|
||||||
|`keycloak_quarkus_hostname_backchannel_dynamic`| Enables dynamic resolving of backchannel URLs, including hostname, scheme, port and context path. Set to true if your application accesses Keycloak via a private network. If set to true, hostname option needs to be specified as a full URL. | `false` |
|
|`keycloak_quarkus_hostname_backchannel_dynamic`| Enables dynamic resolving of backchannel URLs, including hostname, scheme, port and context path. Set to true if your application accesses Keycloak via a private network. If set to true, hostname option needs to be specified as a full URL. | `false` |
|
||||||
|`keycloak_quarkus_hostname_strict_backchannel`| Deprecated, use (the inverted!)`keycloak_quarkus_hostname_backchannel_dynamic` instead. | |
|
|`keycloak_quarkus_hostname_strict_backchannel`| Deprecated, use (the inverted!)`keycloak_quarkus_hostname_backchannel_dynamic` instead. | |
|
||||||
|
|
|
@ -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.18.0" name="antsibull-docs" />
|
<meta content="2.21.0" 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 — Keycloak Ansible Collection documentation</title>
|
<title>keycloak_client – Allows administration of Keycloak clients via Keycloak API — 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 v11)"><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 v12)"><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,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.18.0" name="antsibull-docs" />
|
<meta content="2.21.0" 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 — Keycloak Ansible Collection documentation</title>
|
<title>keycloak_realm – Allows administration of Keycloak realm via Keycloak API — 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 v11)"><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 v12)"><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,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.18.0" name="antsibull-docs" />
|
<meta content="2.21.0" 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 — Keycloak Ansible Collection documentation</title>
|
<title>keycloak_role – Allows administration of Keycloak roles via Keycloak API — 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 v11)"><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 v12)"><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,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.18.0" name="antsibull-docs" />
|
<meta content="2.21.0" 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 — Keycloak Ansible Collection documentation</title>
|
<title>keycloak_user_federation – Allows administration of Keycloak user federations via Keycloak API — 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 v11)"><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 v12)"><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">
|
||||||
|
|
|
@ -390,7 +390,7 @@
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_hostname_admin</span></code></p></td>
|
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_hostname_admin</span></code></p></td>
|
||||||
<td class="text-left"><p>Set the base URL for accessing the administration console, including scheme, host, port and path</p></td>
|
<td class="text-left"><p>Set the base URL for accessing the administration console, including scheme, host, port and path</p></td>
|
||||||
<td class="text-left"><p></p></td>
|
<td class="text-left"><p>``</p></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_hostname_strict</span></code></p></td>
|
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_hostname_strict</span></code></p></td>
|
||||||
<td class="text-left"><p>Disables dynamically resolving the hostname from request headers</p></td>
|
<td class="text-left"><p>Disables dynamically resolving the hostname from request headers</p></td>
|
||||||
|
|
File diff suppressed because one or more lines are too long
Loading…
Add table
Add a link
Reference in a new issue