Update docs for main

Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
This commit is contained in:
ansible-middleware-core 2023-11-13 10:37:58 +00:00
parent 8a703a3975
commit 3a1eb663af
12 changed files with 6019 additions and 9735 deletions

View file

@ -60,90 +60,91 @@
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#v1-3-1-devel">v1.3.1-devel</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#minor-changes">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#breaking-changes-porting-guide">Breaking Changes / Porting Guide</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-3-0">v1.3.0</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="#id5">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id6">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#bugfixes">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-8">v1.2.8</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id10">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id13">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id11">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id14">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-7">v1.2.7</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id17">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id18">Minor Changes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-6">v1.2.6</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id20">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id24">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id21">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id25">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-5">v1.2.5</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id26">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id27">Minor Changes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-4">v1.2.4</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id31">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id34">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id32">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id35">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-1">v1.2.1</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id37">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id39">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id38">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id40">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-0">v1.2.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id41">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id43">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id42">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id44">Minor Changes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-1-1">v1.1.1</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id48">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id49">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-1-0">v1.1.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id50">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#breaking-changes-porting-guide">Breaking Changes / Porting Guide</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id56">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id51">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id56">Breaking Changes / Porting Guide</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id58">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-7">v1.0.7</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id58">Breaking Changes / Porting Guide</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id60">Bugfixes</a></li>
</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="#id60">Breaking Changes / Porting Guide</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id62">Bugfixes</a></li>
</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="#id64">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-5">v1.0.5</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id65">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id67">Minor Changes</a></li>
</ul>
</li>
<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="#id67">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id69">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id71">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id69">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id71">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id73">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="#id73">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id76">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id75">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id78">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="#id78">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id80">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id80">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id82">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="#id82">Release Summary</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id84">Release Summary</a></li>
</ul>
</li>
</ul>
@ -186,116 +187,117 @@
<div itemprop="articleBody">
<section id="middleware-automation-keycloak-release-notes">
<h1><a class="toc-backref" href="#id83" role="doc-backlink">middleware_automation.keycloak Release Notes</a><a class="headerlink" href="#middleware-automation-keycloak-release-notes" title="Link to this heading"></a></h1>
<h1><a class="toc-backref" href="#id85" role="doc-backlink">middleware_automation.keycloak Release Notes</a><a class="headerlink" href="#middleware-automation-keycloak-release-notes" title="Link to this heading"></a></h1>
<nav class="contents" id="topics">
<p class="topic-title">Topics</p>
<ul class="simple">
<li><p><a class="reference internal" href="#middleware-automation-keycloak-release-notes" id="id83">middleware_automation.keycloak Release Notes</a></p>
<li><p><a class="reference internal" href="#middleware-automation-keycloak-release-notes" id="id85">middleware_automation.keycloak Release Notes</a></p>
<ul>
<li><p><a class="reference internal" href="#v1-3-1-devel" id="id84">v1.3.1-devel</a></p>
<li><p><a class="reference internal" href="#v1-3-1-devel" id="id86">v1.3.1-devel</a></p>
<ul>
<li><p><a class="reference internal" href="#minor-changes" id="id85">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#minor-changes" id="id87">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#breaking-changes-porting-guide" id="id88">Breaking Changes / Porting Guide</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-3-0" id="id86">v1.3.0</a></p>
<li><p><a class="reference internal" href="#v1-3-0" id="id89">v1.3.0</a></p>
<ul>
<li><p><a class="reference internal" href="#major-changes" id="id87">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id5" id="id88">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#bugfixes" id="id89">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#major-changes" id="id90">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id6" id="id91">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#bugfixes" id="id92">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-2-8" id="id90">v1.2.8</a></p>
<li><p><a class="reference internal" href="#v1-2-8" id="id93">v1.2.8</a></p>
<ul>
<li><p><a class="reference internal" href="#id10" id="id91">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id13" id="id92">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id11" id="id94">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id14" id="id95">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-2-7" id="id93">v1.2.7</a></p>
<li><p><a class="reference internal" href="#v1-2-7" id="id96">v1.2.7</a></p>
<ul>
<li><p><a class="reference internal" href="#id17" id="id94">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id18" id="id97">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-2-6" id="id95">v1.2.6</a></p>
<li><p><a class="reference internal" href="#v1-2-6" id="id98">v1.2.6</a></p>
<ul>
<li><p><a class="reference internal" href="#id20" id="id96">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id24" id="id97">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id21" id="id99">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id25" id="id100">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-2-5" id="id98">v1.2.5</a></p>
<li><p><a class="reference internal" href="#v1-2-5" id="id101">v1.2.5</a></p>
<ul>
<li><p><a class="reference internal" href="#id26" id="id99">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id27" id="id102">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-2-4" id="id100">v1.2.4</a></p>
<li><p><a class="reference internal" href="#v1-2-4" id="id103">v1.2.4</a></p>
<ul>
<li><p><a class="reference internal" href="#id31" id="id101">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id34" id="id102">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id32" id="id104">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id35" id="id105">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-2-1" id="id103">v1.2.1</a></p>
<li><p><a class="reference internal" href="#v1-2-1" id="id106">v1.2.1</a></p>
<ul>
<li><p><a class="reference internal" href="#id37" id="id104">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id39" id="id105">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id38" id="id107">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id40" id="id108">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-2-0" id="id106">v1.2.0</a></p>
<li><p><a class="reference internal" href="#v1-2-0" id="id109">v1.2.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id41" id="id107">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id43" id="id108">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id42" id="id110">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id44" id="id111">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-1-1" id="id109">v1.1.1</a></p>
<li><p><a class="reference internal" href="#v1-1-1" id="id112">v1.1.1</a></p>
<ul>
<li><p><a class="reference internal" href="#id48" id="id110">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id49" id="id113">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-1-0" id="id111">v1.1.0</a></p>
<li><p><a class="reference internal" href="#v1-1-0" id="id114">v1.1.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id50" id="id112">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#breaking-changes-porting-guide" id="id113">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#id56" id="id114">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id51" id="id115">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id56" id="id116">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#id58" id="id117">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-7" id="id115">v1.0.7</a></p>
<li><p><a class="reference internal" href="#v1-0-7" id="id118">v1.0.7</a></p>
<ul>
<li><p><a class="reference internal" href="#id58" id="id116">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#id60" id="id117">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id60" id="id119">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#id62" id="id120">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-6" id="id118">v1.0.6</a></p>
<li><p><a class="reference internal" href="#v1-0-6" id="id121">v1.0.6</a></p>
<ul>
<li><p><a class="reference internal" href="#id62" id="id119">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id64" id="id122">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-5" id="id120">v1.0.5</a></p>
<li><p><a class="reference internal" href="#v1-0-5" id="id123">v1.0.5</a></p>
<ul>
<li><p><a class="reference internal" href="#id65" id="id121">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id67" id="id124">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-4" id="id122">v1.0.4</a></p></li>
<li><p><a class="reference internal" href="#v1-0-3" id="id123">v1.0.3</a></p>
<li><p><a class="reference internal" href="#v1-0-4" id="id125">v1.0.4</a></p></li>
<li><p><a class="reference internal" href="#v1-0-3" id="id126">v1.0.3</a></p>
<ul>
<li><p><a class="reference internal" href="#id67" id="id124">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id69" id="id125">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id71" id="id126">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id69" id="id127">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id71" id="id128">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id73" id="id129">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-2" id="id127">v1.0.2</a></p>
<li><p><a class="reference internal" href="#v1-0-2" id="id130">v1.0.2</a></p>
<ul>
<li><p><a class="reference internal" href="#id73" id="id128">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id76" id="id129">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id75" id="id131">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id78" id="id132">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-1" id="id130">v1.0.1</a></p>
<li><p><a class="reference internal" href="#v1-0-1" id="id133">v1.0.1</a></p>
<ul>
<li><p><a class="reference internal" href="#release-summary" id="id131">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id78" id="id132">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id80" id="id133">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#release-summary" id="id134">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id80" id="id135">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id82" id="id136">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-0" id="id134">v1.0.0</a></p>
<li><p><a class="reference internal" href="#v1-0-0" id="id137">v1.0.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id82" id="id135">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id84" id="id138">Release Summary</a></p></li>
</ul>
</li>
</ul>
@ -304,26 +306,32 @@
</nav>
<p>This changelog describes changes after version 0.2.6.</p>
<section id="v1-3-1-devel">
<h2><a class="toc-backref" href="#id84" role="doc-backlink">v1.3.1-devel</a><a class="headerlink" href="#v1-3-1-devel" title="Link to this heading"></a></h2>
<h2><a class="toc-backref" href="#id86" role="doc-backlink">v1.3.1-devel</a><a class="headerlink" href="#v1-3-1-devel" title="Link to this heading"></a></h2>
<section id="minor-changes">
<h3><a class="toc-backref" href="#id85" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Link to this heading"></a></h3>
<h3><a class="toc-backref" href="#id87" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Add new parameter for port offset configuration <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/124">#124</a></p></li>
<li><p>Update Keycloak to version 22.0.4 <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/117">#117</a></p></li>
<li><p>Update Keycloak to version 22.0.5 <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/122">#122</a></p></li>
<li><p>feat: jboss port offset configuration <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/124">#124</a></p></li>
</ul>
</section>
<section id="breaking-changes-porting-guide">
<h3><a class="toc-backref" href="#id88" role="doc-backlink">Breaking Changes / Porting Guide</a><a class="headerlink" href="#breaking-changes-porting-guide" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Add support for more http-related configs <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/115">#115</a></p></li>
</ul>
</section>
</section>
<section id="v1-3-0">
<h2><a class="toc-backref" href="#id86" role="doc-backlink">v1.3.0</a><a class="headerlink" href="#v1-3-0" title="Link to this heading"></a></h2>
<h2><a class="toc-backref" href="#id89" role="doc-backlink">v1.3.0</a><a class="headerlink" href="#v1-3-0" title="Link to this heading"></a></h2>
<section id="major-changes">
<h3><a class="toc-backref" href="#id87" role="doc-backlink">Major Changes</a><a class="headerlink" href="#major-changes" title="Link to this heading"></a></h3>
<h3><a class="toc-backref" href="#id90" role="doc-backlink">Major Changes</a><a class="headerlink" href="#major-changes" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Run service as <code class="docutils literal notranslate"><span class="pre">keycloak_service_user</span></code> <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/106">#106</a></p></li>
</ul>
</section>
<section id="id5">
<h3><a class="toc-backref" href="#id88" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id5" title="Link to this heading"></a></h3>
<section id="id6">
<h3><a class="toc-backref" href="#id91" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id6" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>keycloak_quarkus: Update Keycloak to version 22.0.3 <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/112">#112</a></p></li>
<li><p>keycloak_quarkus: fix admin console redirect when running locally <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/111">#111</a></p></li>
@ -331,23 +339,23 @@
</ul>
</section>
<section id="bugfixes">
<h3><a class="toc-backref" href="#id89" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Link to this heading"></a></h3>
<h3><a class="toc-backref" href="#id92" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>keycloak_quarkus: fix validation failure upon port configuration change <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/113">#113</a></p></li>
</ul>
</section>
</section>
<section id="v1-2-8">
<h2><a class="toc-backref" href="#id90" role="doc-backlink">v1.2.8</a><a class="headerlink" href="#v1-2-8" title="Link to this heading"></a></h2>
<section id="id10">
<h3><a class="toc-backref" href="#id91" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id10" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id93" role="doc-backlink">v1.2.8</a><a class="headerlink" href="#v1-2-8" title="Link to this heading"></a></h2>
<section id="id11">
<h3><a class="toc-backref" href="#id94" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id11" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>keycloak_quarkus: set openjdk 17 as default <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/103">#103</a></p></li>
<li><p>keycloak_quarkus: update to version 22.0.1 <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/107">#107</a></p></li>
</ul>
</section>
<section id="id13">
<h3><a class="toc-backref" href="#id92" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id13" title="Link to this heading"></a></h3>
<section id="id14">
<h3><a class="toc-backref" href="#id95" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id14" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Fix incorrect checks for <code class="docutils literal notranslate"><span class="pre">keycloak_jgroups_subnet</span></code> <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/98">#98</a></p></li>
<li><p>Undefine <code class="docutils literal notranslate"><span class="pre">keycloak_db_valid_conn_sql</span></code> default <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/91">#91</a></p></li>
@ -356,9 +364,9 @@
</section>
</section>
<section id="v1-2-7">
<h2><a class="toc-backref" href="#id93" role="doc-backlink">v1.2.7</a><a class="headerlink" href="#v1-2-7" title="Link to this heading"></a></h2>
<section id="id17">
<h3><a class="toc-backref" href="#id94" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id17" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id96" role="doc-backlink">v1.2.7</a><a class="headerlink" href="#v1-2-7" title="Link to this heading"></a></h2>
<section id="id18">
<h3><a class="toc-backref" href="#id97" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id18" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Allow to override jgroups subnet <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/93">#93</a></p></li>
<li><p>keycloak-quarkus: update keycloakx to v21.1.1 <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/92">#92</a></p></li>
@ -366,26 +374,26 @@
</section>
</section>
<section id="v1-2-6">
<h2><a class="toc-backref" href="#id95" role="doc-backlink">v1.2.6</a><a class="headerlink" href="#v1-2-6" title="Link to this heading"></a></h2>
<section id="id20">
<h3><a class="toc-backref" href="#id96" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id20" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id98" role="doc-backlink">v1.2.6</a><a class="headerlink" href="#v1-2-6" title="Link to this heading"></a></h2>
<section id="id21">
<h3><a class="toc-backref" href="#id99" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id21" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Add profile features enabling/disabling <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/87">#87</a></p></li>
<li><p>Improve service restart behavior configuration <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/88">#88</a></p></li>
<li><p>Update default xa_datasource_class value for mariadb jdbc configuration <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/89">#89</a></p></li>
</ul>
</section>
<section id="id24">
<h3><a class="toc-backref" href="#id97" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id24" title="Link to this heading"></a></h3>
<section id="id25">
<h3><a class="toc-backref" href="#id100" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id25" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Handle WFLYCTL0117 when background validation millis is 0 <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/90">#90</a></p></li>
</ul>
</section>
</section>
<section id="v1-2-5">
<h2><a class="toc-backref" href="#id98" role="doc-backlink">v1.2.5</a><a class="headerlink" href="#v1-2-5" title="Link to this heading"></a></h2>
<section id="id26">
<h3><a class="toc-backref" href="#id99" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id26" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id101" role="doc-backlink">v1.2.5</a><a class="headerlink" href="#v1-2-5" title="Link to this heading"></a></h2>
<section id="id27">
<h3><a class="toc-backref" href="#id102" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id27" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Add configuration for database connection pool validation <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/85">#85</a></p></li>
<li><p>Allow to configure administration endpoint URL <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/86">#86</a></p></li>
@ -395,16 +403,16 @@
</section>
</section>
<section id="v1-2-4">
<h2><a class="toc-backref" href="#id100" role="doc-backlink">v1.2.4</a><a class="headerlink" href="#v1-2-4" title="Link to this heading"></a></h2>
<section id="id31">
<h3><a class="toc-backref" href="#id101" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id31" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id103" role="doc-backlink">v1.2.4</a><a class="headerlink" href="#v1-2-4" title="Link to this heading"></a></h2>
<section id="id32">
<h3><a class="toc-backref" href="#id104" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id32" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Add <code class="docutils literal notranslate"><span class="pre">sqlserver</span></code> to keycloak role jdbc configurations <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/78">#78</a></p></li>
<li><p>Add configurability for XA transactions <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/73">#73</a></p></li>
</ul>
</section>
<section id="id34">
<h3><a class="toc-backref" href="#id102" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id34" title="Link to this heading"></a></h3>
<section id="id35">
<h3><a class="toc-backref" href="#id105" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id35" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Fix deprecation warning for <code class="docutils literal notranslate"><span class="pre">ipaddr</span></code> <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/77">#77</a></p></li>
<li><p>Fix undefined facts when offline patching sso <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/71">#71</a></p></li>
@ -412,30 +420,30 @@
</section>
</section>
<section id="v1-2-1">
<h2><a class="toc-backref" href="#id103" role="doc-backlink">v1.2.1</a><a class="headerlink" href="#v1-2-1" title="Link to this heading"></a></h2>
<section id="id37">
<h3><a class="toc-backref" href="#id104" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id37" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id106" role="doc-backlink">v1.2.1</a><a class="headerlink" href="#v1-2-1" title="Link to this heading"></a></h2>
<section id="id38">
<h3><a class="toc-backref" href="#id107" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id38" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Allow to setup keycloak HA cluster without remote cache store <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/68">#68</a></p></li>
</ul>
</section>
<section id="id39">
<h3><a class="toc-backref" href="#id105" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id39" title="Link to this heading"></a></h3>
<section id="id40">
<h3><a class="toc-backref" href="#id108" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id40" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Pass attributes to realm clients <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/69">#69</a></p></li>
</ul>
</section>
</section>
<section id="v1-2-0">
<h2><a class="toc-backref" href="#id106" role="doc-backlink">v1.2.0</a><a class="headerlink" href="#v1-2-0" title="Link to this heading"></a></h2>
<section id="id41">
<h3><a class="toc-backref" href="#id107" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id41" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id109" role="doc-backlink">v1.2.0</a><a class="headerlink" href="#v1-2-0" title="Link to this heading"></a></h2>
<section id="id42">
<h3><a class="toc-backref" href="#id110" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id42" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Provide config for multiple modcluster proxies <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/60">#60</a></p></li>
</ul>
</section>
<section id="id43">
<h3><a class="toc-backref" href="#id108" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id43" title="Link to this heading"></a></h3>
<section id="id44">
<h3><a class="toc-backref" href="#id111" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id44" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Allow to configure TCPPING for cluster discovery <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/62">#62</a></p></li>
<li><p>Drop community.general from dependencies <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/61">#61</a></p></li>
@ -445,18 +453,18 @@
</section>
</section>
<section id="v1-1-1">
<h2><a class="toc-backref" href="#id109" role="doc-backlink">v1.1.1</a><a class="headerlink" href="#v1-1-1" title="Link to this heading"></a></h2>
<section id="id48">
<h3><a class="toc-backref" href="#id110" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id48" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id112" role="doc-backlink">v1.1.1</a><a class="headerlink" href="#v1-1-1" title="Link to this heading"></a></h2>
<section id="id49">
<h3><a class="toc-backref" href="#id113" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id49" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>keycloak-quarkus: fix <code class="docutils literal notranslate"><span class="pre">cache-config-file</span></code> path in keycloak.conf.j2 template <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/53">#53</a></p></li>
</ul>
</section>
</section>
<section id="v1-1-0">
<h2><a class="toc-backref" href="#id111" role="doc-backlink">v1.1.0</a><a class="headerlink" href="#v1-1-0" title="Link to this heading"></a></h2>
<section id="id50">
<h3><a class="toc-backref" href="#id112" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id50" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id114" role="doc-backlink">v1.1.0</a><a class="headerlink" href="#v1-1-0" title="Link to this heading"></a></h2>
<section id="id51">
<h3><a class="toc-backref" href="#id115" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id51" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Update keycloak to 18.0.2 - sso to 7.6.1 <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/46">#46</a></p></li>
<li><p>Variable <code class="docutils literal notranslate"><span class="pre">keycloak_no_log</span></code> controls ansible <code class="docutils literal notranslate"><span class="pre">no_log</span></code> parameter (for debugging purposes) <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/47">#47</a></p></li>
@ -464,38 +472,38 @@
<li><p>keycloak_quarkus: variable to enable development mode <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/45">#45</a></p></li>
</ul>
</section>
<section id="breaking-changes-porting-guide">
<h3><a class="toc-backref" href="#id113" role="doc-backlink">Breaking Changes / Porting Guide</a><a class="headerlink" href="#breaking-changes-porting-guide" title="Link to this heading"></a></h3>
<section id="id56">
<h3><a class="toc-backref" href="#id116" role="doc-backlink">Breaking Changes / Porting Guide</a><a class="headerlink" href="#id56" title="Link 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>
</ul>
</section>
<section id="id56">
<h3><a class="toc-backref" href="#id114" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id56" title="Link to this heading"></a></h3>
<section id="id58">
<h3><a class="toc-backref" href="#id117" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id58" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>keycloak_quarkus: fix /var/log/keycloak symlink to keycloak log directory <a class="reference external" href="https://github.com/ansible-middleware/keycloak/pull/44">#44</a></p></li>
</ul>
</section>
</section>
<section id="v1-0-7">
<h2><a class="toc-backref" href="#id115" role="doc-backlink">v1.0.7</a><a class="headerlink" href="#v1-0-7" title="Link to this heading"></a></h2>
<section id="id58">
<h3><a class="toc-backref" href="#id116" role="doc-backlink">Breaking Changes / Porting Guide</a><a class="headerlink" href="#id58" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id118" role="doc-backlink">v1.0.7</a><a class="headerlink" href="#v1-0-7" title="Link to this heading"></a></h2>
<section id="id60">
<h3><a class="toc-backref" href="#id119" role="doc-backlink">Breaking Changes / Porting Guide</a><a class="headerlink" href="#id60" title="Link to this heading"></a></h3>
<ul class="simple">
<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="id60">
<h3><a class="toc-backref" href="#id117" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id60" title="Link to this heading"></a></h3>
<section id="id62">
<h3><a class="toc-backref" href="#id120" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id62" title="Link 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="#id118" role="doc-backlink">v1.0.6</a><a class="headerlink" href="#v1-0-6" title="Link to this heading"></a></h2>
<section id="id62">
<h3><a class="toc-backref" href="#id119" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id62" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id121" role="doc-backlink">v1.0.6</a><a class="headerlink" href="#v1-0-6" title="Link to this heading"></a></h2>
<section id="id64">
<h3><a class="toc-backref" href="#id122" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id64" title="Link 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>
@ -503,77 +511,77 @@
</section>
</section>
<section id="v1-0-5">
<h2><a class="toc-backref" href="#id120" role="doc-backlink">v1.0.5</a><a class="headerlink" href="#v1-0-5" title="Link to this heading"></a></h2>
<section id="id65">
<h3><a class="toc-backref" href="#id121" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id65" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id123" role="doc-backlink">v1.0.5</a><a class="headerlink" href="#v1-0-5" title="Link to this heading"></a></h2>
<section id="id67">
<h3><a class="toc-backref" href="#id124" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id67" title="Link 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="#id122" role="doc-backlink">v1.0.4</a><a class="headerlink" href="#v1-0-4" title="Link to this heading"></a></h2>
<h2><a class="toc-backref" href="#id125" role="doc-backlink">v1.0.4</a><a class="headerlink" href="#v1-0-4" title="Link to this heading"></a></h2>
</section>
<section id="v1-0-3">
<h2><a class="toc-backref" href="#id123" role="doc-backlink">v1.0.3</a><a class="headerlink" href="#v1-0-3" title="Link to this heading"></a></h2>
<section id="id67">
<h3><a class="toc-backref" href="#id124" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id67" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id126" role="doc-backlink">v1.0.3</a><a class="headerlink" href="#v1-0-3" title="Link to this heading"></a></h2>
<section id="id69">
<h3><a class="toc-backref" href="#id127" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id69" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>New role for installing keycloak &gt;= 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="id69">
<h3><a class="toc-backref" href="#id125" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id69" title="Link to this heading"></a></h3>
<section id="id71">
<h3><a class="toc-backref" href="#id128" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id71" title="Link 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="id71">
<h3><a class="toc-backref" href="#id126" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id71" title="Link to this heading"></a></h3>
<section id="id73">
<h3><a class="toc-backref" href="#id129" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id73" title="Link 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="#id127" role="doc-backlink">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Link to this heading"></a></h2>
<section id="id73">
<h3><a class="toc-backref" href="#id128" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id73" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id130" role="doc-backlink">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Link to this heading"></a></h2>
<section id="id75">
<h3><a class="toc-backref" href="#id131" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id75" title="Link 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="id76">
<h3><a class="toc-backref" href="#id129" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id76" title="Link to this heading"></a></h3>
<section id="id78">
<h3><a class="toc-backref" href="#id132" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id78" title="Link 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="#id130" role="doc-backlink">v1.0.1</a><a class="headerlink" href="#v1-0-1" title="Link to this heading"></a></h2>
<h2><a class="toc-backref" href="#id133" role="doc-backlink">v1.0.1</a><a class="headerlink" href="#v1-0-1" title="Link to this heading"></a></h2>
<section id="release-summary">
<h3><a class="toc-backref" href="#id131" role="doc-backlink">Release Summary</a><a class="headerlink" href="#release-summary" title="Link to this heading"></a></h3>
<h3><a class="toc-backref" href="#id134" role="doc-backlink">Release Summary</a><a class="headerlink" href="#release-summary" title="Link to this heading"></a></h3>
<p>Minor enhancements, bug and documentation fixes.</p>
</section>
<section id="id78">
<h3><a class="toc-backref" href="#id132" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id78" title="Link to this heading"></a></h3>
<section id="id80">
<h3><a class="toc-backref" href="#id135" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id80" title="Link 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="id80">
<h3><a class="toc-backref" href="#id133" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id80" title="Link to this heading"></a></h3>
<section id="id82">
<h3><a class="toc-backref" href="#id136" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id82" title="Link 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="#id134" role="doc-backlink">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Link to this heading"></a></h2>
<section id="id82">
<h3><a class="toc-backref" href="#id135" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id82" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id137" role="doc-backlink">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Link to this heading"></a></h2>
<section id="id84">
<h3><a class="toc-backref" href="#id138" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id84" title="Link 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>

View file

@ -12,9 +12,14 @@ v1.3.1-devel
Minor Changes
-------------
- Add new parameter for port offset configuration `#124 <https://github.com/ansible-middleware/keycloak/pull/124>`_
- Update Keycloak to version 22.0.4 `#117 <https://github.com/ansible-middleware/keycloak/pull/117>`_
- Update Keycloak to version 22.0.5 `#122 <https://github.com/ansible-middleware/keycloak/pull/122>`_
- feat: jboss port offset configuration `#124 <https://github.com/ansible-middleware/keycloak/pull/124>`_
Breaking Changes / Porting Guide
--------------------------------
- Add support for more http-related configs `#115 <https://github.com/ansible-middleware/keycloak/pull/115>`_
v1.3.0
======

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

View file

@ -24,6 +24,7 @@ Role Defaults
|`keycloak_quarkus_bind_address`| Address for binding service ports | `0.0.0.0` |
|`keycloak_quarkus_host`| Hostname for the Keycloak server | `localhost` |
|`keycloak_quarkus_port`| The port used by the proxy when exposing the hostname | `-1` |
|`keycloak_quarkus_path`| This should be set if proxy uses a different context-path for Keycloak | |
|`keycloak_quarkus_http_port`| HTTP listening port | `8080` |
|`keycloak_quarkus_https_port`| TLS HTTP listening port | `8443` |
|`keycloak_quarkus_ajp_port`| AJP port | `8009` |
@ -34,8 +35,9 @@ Role Defaults
|`keycloak_quarkus_jvm_package`| RHEL java package runtime | `java-17-openjdk-headless` |
|`keycloak_quarkus_java_home`| JAVA_HOME of installed JRE, leave empty for using specified keycloak_quarkus_jvm_package RPM path | `None` |
|`keycloak_quarkus_java_opts`| Additional JVM options | `-Xms1024m -Xmx2048m` |
|`keycloak_quarkus_frontend_url`| Service public URL | `http://localhost:8080/auth` |
|`keycloak_quarkus_http_relative_path` | Service context path | `auth` |
|`keycloak_quarkus_frontend_url`| Set the base URL for frontend URLs, including scheme, host, port and path | |
|`keycloak_quarkus_admin_url`| Set the base URL for accessing the administration console, including scheme, host, port and path | |
|`keycloak_quarkus_http_relative_path` | Set the path relative to / for serving resources. The path must start with a / | `/` |
|`keycloak_quarkus_http_enabled`| Enable listener on HTTP port | `True` |
|`keycloak_quarkus_https_enabled`| Enable listener on HTTPS port | `False` |
|`keycloak_quarkus_key_file`| The file path to a private key in PEM format | `{{ keycloak.home }}/conf/server.key.pem` |

Binary file not shown.

File diff suppressed because it is too large Load diff

View file

@ -143,156 +143,256 @@ To check whether it is installed, run <code class="code docutils literal notrans
</section>
<section id="parameters">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link to this heading"></a></h2>
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
<thead>
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
<th class="head"><p>Comments</p></th>
<tr class="row-odd">
<th class="head"><p>Parameter</p></th>
<th class="head"><p>Comments</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-attributes"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-attributes"><strong>attributes</strong></p>
<a class="ansibleOptionLink" href="#parameter-attributes" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>A dict of key/value pairs to set as custom attributes for the role.</p>
<p>Values may be single values (e.g. a string) or a list of strings.</p>
</div></td>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-attributes"></div>
<p class="ansible-option-title"><strong>attributes</strong></p>
<a class="ansibleOptionLink" href="#parameter-attributes" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">dictionary</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>A dict of key/value pairs to set as custom attributes for the role.</p>
<p>Values may be single values (e.g. a string) or a list of strings.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_client_id"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-auth-client-id"><strong>auth_client_id</strong></p>
<a class="ansibleOptionLink" href="#parameter-auth_client_id" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>OpenID Connect <em>client_id</em> to authenticate to the API with.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;admin-cli&quot;</span></code></p>
</div></td>
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_client_id"></div>
<p class="ansible-option-title"><strong>auth_client_id</strong></p>
<a class="ansibleOptionLink" href="#parameter-auth_client_id" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">string</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>OpenID Connect <em>client_id</em> to authenticate to the API with.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">&#34;admin-cli&#34;</code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_client_secret"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-auth-client-secret"><strong>auth_client_secret</strong></p>
<a class="ansibleOptionLink" href="#parameter-auth_client_secret" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Client Secret to use in conjunction with <em>auth_client_id</em> (if required).</p>
</div></td>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_client_secret"></div>
<p class="ansible-option-title"><strong>auth_client_secret</strong></p>
<a class="ansibleOptionLink" href="#parameter-auth_client_secret" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">string</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Client Secret to use in conjunction with <em>auth_client_id</em> (if required).</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_keycloak_url"></div>
<div class="ansibleOptionAnchor" id="parameter-url"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-url"><span id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-auth-keycloak-url"></span><strong>auth_keycloak_url</strong></p>
<a class="ansibleOptionLink" href="#parameter-auth_keycloak_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: url</span></p>
<p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>URL to the Keycloak instance.</p>
</div></td>
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_keycloak_url"></div>
<div class="ansibleOptionAnchor" id="parameter-url"></div>
<p class="ansible-option-title"><strong>auth_keycloak_url</strong></p>
<a class="ansibleOptionLink" href="#parameter-auth_keycloak_url" title="Permalink to this option"></a>
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: url</span></p>
<p class="ansible-option-type-line">
<span class="ansible-option-type">string</span>
/ <span class="ansible-option-required">required</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>URL to the Keycloak instance.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_password"></div>
<div class="ansibleOptionAnchor" id="parameter-password"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-password"><span id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-auth-password"></span><strong>auth_password</strong></p>
<a class="ansibleOptionLink" href="#parameter-auth_password" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: password</span></p>
<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Password to authenticate for API access with.</p>
</div></td>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_password"></div>
<div class="ansibleOptionAnchor" id="parameter-password"></div>
<p class="ansible-option-title"><strong>auth_password</strong></p>
<a class="ansibleOptionLink" href="#parameter-auth_password" title="Permalink to this option"></a>
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: password</span></p>
<p class="ansible-option-type-line">
<span class="ansible-option-type">string</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Password to authenticate for API access with.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_realm"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-auth-realm"><strong>auth_realm</strong></p>
<a class="ansibleOptionLink" href="#parameter-auth_realm" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Keycloak realm name to authenticate to for API access.</p>
</div></td>
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_realm"></div>
<p class="ansible-option-title"><strong>auth_realm</strong></p>
<a class="ansibleOptionLink" href="#parameter-auth_realm" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">string</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Keycloak realm name to authenticate to for API access.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_username"></div>
<div class="ansibleOptionAnchor" id="parameter-username"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-username"><span id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-auth-username"></span><strong>auth_username</strong></p>
<a class="ansibleOptionLink" href="#parameter-auth_username" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: username</span></p>
<p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Username to authenticate for API access with.</p>
</div></td>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-auth_username"></div>
<div class="ansibleOptionAnchor" id="parameter-username"></div>
<p class="ansible-option-title"><strong>auth_username</strong></p>
<a class="ansibleOptionLink" href="#parameter-auth_username" title="Permalink to this option"></a>
<p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: username</span></p>
<p class="ansible-option-type-line">
<span class="ansible-option-type">string</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Username to authenticate for API access with.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-client_id"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-client-id"><strong>client_id</strong></p>
<a class="ansibleOptionLink" href="#parameter-client_id" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>If the role is a client role, the client id under which it resides.</p>
<p>If this parameter is absent, the role is considered a realm role.</p>
</div></td>
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-client_id"></div>
<p class="ansible-option-title"><strong>client_id</strong></p>
<a class="ansibleOptionLink" href="#parameter-client_id" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">string</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>If the role is a client role, the client id under which it resides.</p>
<p>If this parameter is absent, the role is considered a realm role.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-connection_timeout"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-connection-timeout"><strong>connection_timeout</strong></p>
<a class="ansibleOptionLink" href="#parameter-connection_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
<p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 4.5.0</em></p>
</div></td>
<td><div class="ansible-option-cell"><p>Controls the HTTP connections timeout period (in seconds) to Keycloak API.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">10</span></code></p>
</div></td>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-connection_timeout"></div>
<p class="ansible-option-title"><strong>connection_timeout</strong></p>
<a class="ansibleOptionLink" href="#parameter-connection_timeout" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">integer</span>
</p>
<p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 4.5.0</em></p>
</div></td>
<td><div class="ansible-option-cell">
<p>Controls the HTTP connections timeout period (in seconds) to Keycloak API.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">10</code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-description"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-description"><strong>description</strong></p>
<a class="ansibleOptionLink" href="#parameter-description" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>The role description.</p>
</div></td>
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-description"></div>
<p class="ansible-option-title"><strong>description</strong></p>
<a class="ansibleOptionLink" href="#parameter-description" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">string</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>The role description.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-http_agent"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-http-agent"><strong>http_agent</strong></p>
<a class="ansibleOptionLink" href="#parameter-http_agent" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
<p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 5.4.0</em></p>
</div></td>
<td><div class="ansible-option-cell"><p>Configures the HTTP User-Agent header.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;Ansible&quot;</span></code></p>
</div></td>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-http_agent"></div>
<p class="ansible-option-title"><strong>http_agent</strong></p>
<a class="ansibleOptionLink" href="#parameter-http_agent" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">string</span>
</p>
<p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 5.4.0</em></p>
</div></td>
<td><div class="ansible-option-cell">
<p>Configures the HTTP User-Agent header.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">&#34;Ansible&#34;</code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-name"><strong>name</strong></p>
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Name of the role.</p>
<p>This parameter is required.</p>
</div></td>
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-name"></div>
<p class="ansible-option-title"><strong>name</strong></p>
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">string</span>
/ <span class="ansible-option-required">required</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Name of the role.</p>
<p>This parameter is required.</p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-realm"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-realm"><strong>realm</strong></p>
<a class="ansibleOptionLink" href="#parameter-realm" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>The Keycloak realm under which this role resides.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;master&quot;</span></code></p>
</div></td>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-realm"></div>
<p class="ansible-option-title"><strong>realm</strong></p>
<a class="ansibleOptionLink" href="#parameter-realm" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">string</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>The Keycloak realm under which this role resides.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">&#34;master&#34;</code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-state"><strong>state</strong></p>
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>State of the role.</p>
<p>On <code class="docutils literal notranslate"><span class="pre">present</span></code>, the role will be created if it does not yet exist, or updated with the parameters you provide.</p>
<p>On <code class="docutils literal notranslate"><span class="pre">absent</span></code>, the role will be removed if it exists.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">&quot;present&quot;</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;absent&quot;</span></code></p></li>
</ul>
</div></td>
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-state"></div>
<p class="ansible-option-title"><strong>state</strong></p>
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">string</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>State of the role.</p>
<p>On <code class='docutils literal notranslate'>present</code>, the role will be created if it does not yet exist, or updated with the parameters you provide.</p>
<p>On <code class='docutils literal notranslate'>absent</code>, the role will be removed if it exists.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
<li><p><code class="ansible-value literal notranslate ansible-option-default-bold"><strong>&#34;present&#34;</strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">&#34;absent&#34;</code></p></li>
</ul>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-token"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-token"><strong>token</strong></p>
<a class="ansibleOptionLink" href="#parameter-token" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
<p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 3.0.0</em></p>
</div></td>
<td><div class="ansible-option-cell"><p>Authentication token for Keycloak API.</p>
</div></td>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-token"></div>
<p class="ansible-option-title"><strong>token</strong></p>
<a class="ansibleOptionLink" href="#parameter-token" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">string</span>
</p>
<p><em class="ansible-option-versionadded">added in middleware_automation.keycloak 3.0.0</em></p>
</div></td>
<td><div class="ansible-option-cell">
<p>Authentication token for Keycloak API.</p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-validate_certs"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-parameter-validate-certs"><strong>validate_certs</strong></p>
<a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Verify TLS certificates (do not disable this in production).</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">true</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
</ul>
</div></td>
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-validate_certs"></div>
<p class="ansible-option-title"><strong>validate_certs</strong></p>
<a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">boolean</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Verify TLS certificates (do not disable this in production).</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">false</code></p></li>
<li><p><code class="ansible-value literal notranslate ansible-option-default-bold"><strong>true</strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
</ul>
</div></td>
</tr>
</tbody>
</table>
</section>
</table></section>
<section id="attributes">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Link to this heading"></a></h2>
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
@ -394,52 +494,76 @@ To check whether it is installed, run <code class="code docutils literal notrans
<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>
<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 v8)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>Description</p></th>
<tr class="row-odd">
<th class="head"><p>Key</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-end_state"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-return-end-state"><strong>end_state</strong></p>
<a class="ansibleOptionLink" href="#return-end_state" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Representation of role after module execution (sample is truncated).</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> on success</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{&quot;attributes&quot;:</span> <span class="pre">{},</span> <span class="pre">&quot;clientRole&quot;:</span> <span class="pre">true,</span> <span class="pre">&quot;composite&quot;:</span> <span class="pre">false,</span> <span class="pre">&quot;containerId&quot;:</span> <span class="pre">&quot;9f03eb61-a826-4771-a9fd-930e06d2d36a&quot;,</span> <span class="pre">&quot;description&quot;:</span> <span class="pre">&quot;My</span> <span class="pre">updated</span> <span class="pre">client</span> <span class="pre">test</span> <span class="pre">role&quot;,</span> <span class="pre">&quot;id&quot;:</span> <span class="pre">&quot;561703dd-0f38-45ff-9a5a-0c978f794547&quot;,</span> <span class="pre">&quot;name&quot;:</span> <span class="pre">&quot;myrole&quot;}</span></code></p>
</div></td>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-end_state"></div>
<p class="ansible-option-title"><strong>end_state</strong></p>
<a class="ansibleOptionLink" href="#return-end_state" title="Permalink to this return value"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">dictionary</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Representation of role after module execution (sample is truncated).</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> on success</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-value literal notranslate ansible-option-sample">{&#34;attributes&#34;: {}, &#34;clientRole&#34;: true, &#34;composite&#34;: false, &#34;containerId&#34;: &#34;9f03eb61-a826-4771-a9fd-930e06d2d36a&#34;, &#34;description&#34;: &#34;My updated client test role&#34;, &#34;id&#34;: &#34;561703dd-0f38-45ff-9a5a-0c978f794547&#34;, &#34;name&#34;: &#34;myrole&#34;}</code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-existing"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-return-existing"><strong>existing</strong></p>
<a class="ansibleOptionLink" href="#return-existing" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Representation of existing role.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{&quot;attributes&quot;:</span> <span class="pre">{},</span> <span class="pre">&quot;clientRole&quot;:</span> <span class="pre">true,</span> <span class="pre">&quot;composite&quot;:</span> <span class="pre">false,</span> <span class="pre">&quot;containerId&quot;:</span> <span class="pre">&quot;9f03eb61-a826-4771-a9fd-930e06d2d36a&quot;,</span> <span class="pre">&quot;description&quot;:</span> <span class="pre">&quot;My</span> <span class="pre">client</span> <span class="pre">test</span> <span class="pre">role&quot;,</span> <span class="pre">&quot;id&quot;:</span> <span class="pre">&quot;561703dd-0f38-45ff-9a5a-0c978f794547&quot;,</span> <span class="pre">&quot;name&quot;:</span> <span class="pre">&quot;myrole&quot;}</span></code></p>
</div></td>
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-existing"></div>
<p class="ansible-option-title"><strong>existing</strong></p>
<a class="ansibleOptionLink" href="#return-existing" title="Permalink to this return value"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">dictionary</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Representation of existing role.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-value literal notranslate ansible-option-sample">{&#34;attributes&#34;: {}, &#34;clientRole&#34;: true, &#34;composite&#34;: false, &#34;containerId&#34;: &#34;9f03eb61-a826-4771-a9fd-930e06d2d36a&#34;, &#34;description&#34;: &#34;My client test role&#34;, &#34;id&#34;: &#34;561703dd-0f38-45ff-9a5a-0c978f794547&#34;, &#34;name&#34;: &#34;myrole&#34;}</code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-msg"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-return-msg"><strong>msg</strong></p>
<a class="ansibleOptionLink" href="#return-msg" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Message as to what action was taken.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">&quot;Role</span> <span class="pre">myrole</span> <span class="pre">has</span> <span class="pre">been</span> <span class="pre">updated&quot;</span></code></p>
</div></td>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-msg"></div>
<p class="ansible-option-title"><strong>msg</strong></p>
<a class="ansibleOptionLink" href="#return-msg" title="Permalink to this return value"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">string</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Message as to what action was taken.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-value literal notranslate ansible-option-sample">&#34;Role myrole has been updated&#34;</code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-proposed"></div><p class="ansible-option-title" id="ansible-collections-middleware-automation-keycloak-keycloak-role-module-return-proposed"><strong>proposed</strong></p>
<a class="ansibleOptionLink" href="#return-proposed" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Representation of proposed role.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{&quot;description&quot;:</span> <span class="pre">&quot;My</span> <span class="pre">updated</span> <span class="pre">test</span> <span class="pre">description&quot;}</span></code></p>
</div></td>
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-proposed"></div>
<p class="ansible-option-title"><strong>proposed</strong></p>
<a class="ansibleOptionLink" href="#return-proposed" title="Permalink to this return value"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">dictionary</span>
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Representation of proposed role.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-value literal notranslate ansible-option-sample">{&#34;description&#34;: &#34;My updated test description&#34;}</code></p>
</div></td>
</tr>
</tbody>
</table>
<section id="authors">
</table><section id="authors">
<h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Laurent Paumier (&#64;laurpaum)</p></li>

File diff suppressed because it is too large Load diff

View file

@ -165,53 +165,61 @@
<td class="text-left"><p>The port used by the proxy when exposing the hostname</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">-1</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_http_port</span></code></p></td>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_path</span></code></p></td>
<td class="text-left"><p>This should be set if proxy uses a different context-path for Keycloak</p></td>
<td class="text-left"><p></p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_http_port</span></code></p></td>
<td class="text-left"><p>HTTP listening port</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">8080</span></code></p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_port</span></code></p></td>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_port</span></code></p></td>
<td class="text-left"><p>TLS HTTP listening port</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">8443</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_ajp_port</span></code></p></td>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_ajp_port</span></code></p></td>
<td class="text-left"><p>AJP port</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">8009</span></code></p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_jgroups_port</span></code></p></td>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_jgroups_port</span></code></p></td>
<td class="text-left"><p>jgroups cluster tcp port</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">7600</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_service_user</span></code></p></td>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_service_user</span></code></p></td>
<td class="text-left"><p>Posix account username</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak</span></code></p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_service_group</span></code></p></td>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_service_group</span></code></p></td>
<td class="text-left"><p>Posix account group</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_service_pidfile</span></code></p></td>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_service_pidfile</span></code></p></td>
<td class="text-left"><p>Pid file path for service</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">/run/keycloak.pid</span></code></p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_jvm_package</span></code></p></td>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_jvm_package</span></code></p></td>
<td class="text-left"><p>RHEL java package runtime</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">java-17-openjdk-headless</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_java_home</span></code></p></td>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_java_home</span></code></p></td>
<td class="text-left"><p>JAVA_HOME of installed JRE, leave empty for using specified keycloak_quarkus_jvm_package RPM path</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">None</span></code></p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_java_opts</span></code></p></td>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_java_opts</span></code></p></td>
<td class="text-left"><p>Additional JVM options</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">-Xms1024m</span> <span class="pre">-Xmx2048m</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_frontend_url</span></code></p></td>
<td class="text-left"><p>Service public URL</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">http://localhost:8080/auth</span></code></p></td>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_frontend_url</span></code></p></td>
<td class="text-left"><p>Set the base URL for frontend URLs, including scheme, host, port and path</p></td>
<td class="text-left"><p></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_admin_url</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></p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_http_relative_path</span></code></p></td>
<td class="text-left"><p>Service context path</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">auth</span></code></p></td>
<td class="text-left"><p>Set the path relative to / for serving resources. The path must start with a /</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_quarkus_http_enabled</span></code></p></td>
<td class="text-left"><p>Enable listener on HTTP port</p></td>

File diff suppressed because one or more lines are too long