ansible-collections/middleware_automation.keycloak
1
0
Fork 0
mirror of https://github.com/ansible-middleware/keycloak.git synced 2025-04-14 23:00:28 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Update docs for main

Browse source
This commit is contained in:
github-actions 2022-08-03 07:17:02 +00:00
parent 66f68914dc
commit fd8cbbb3c8
6 changed files with 71 additions and 105 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

122
main/CHANGELOG.html
View file

@ -58,7 +58,7 @@
</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="#id5">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id3">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-5">v1.0.5</a><ul>
@ -68,23 +68,23 @@
<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="#major-changes">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id10">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id12">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id8">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id10">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="#id14">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id17">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id12">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id15">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="#id19">Major Changes</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="#id17">Major Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id19">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="#id23">Release Summary</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id21">Release Summary</a></li>
</ul>
</li>
</ul>
@ -116,52 +116,52 @@
<div itemprop="articleBody">
<section id="middleware-automation-keycloak-release-notes">
<h1><a class="toc-backref" href="#id24">middleware_automation.keycloak Release Notes</a><a class="headerlink" href="#middleware-automation-keycloak-release-notes" title="Permalink to this heading"></a></h1>
<h1><a class="toc-backref" href="#id22">middleware_automation.keycloak Release Notes</a><a class="headerlink" href="#middleware-automation-keycloak-release-notes" title="Permalink to this heading"></a></h1>
<div class="contents topic" id="topics">
<p class="topic-title">Topics</p>
<ul class="simple">
<li><p><a class="reference internal" href="#middleware-automation-keycloak-release-notes" id="id24">middleware_automation.keycloak Release Notes</a></p>
<li><p><a class="reference internal" href="#middleware-automation-keycloak-release-notes" id="id22">middleware_automation.keycloak Release Notes</a></p>
<ul>
<li><p><a class="reference internal" href="#v1-0-7" id="id25">v1.0.7</a></p>
<li><p><a class="reference internal" href="#v1-0-7" id="id23">v1.0.7</a></p>
<ul>
<li><p><a class="reference internal" href="#breaking-changes-porting-guide" id="id26">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#bugfixes" id="id27">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#breaking-changes-porting-guide" id="id24">Breaking Changes / Porting Guide</a></p></li>
<li><p><a class="reference internal" href="#bugfixes" id="id25">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-6" id="id28">v1.0.6</a></p>
<li><p><a class="reference internal" href="#v1-0-6" id="id26">v1.0.6</a></p>
<ul>
<li><p><a class="reference internal" href="#id5" id="id29">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id3" id="id27">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-5" id="id30">v1.0.5</a></p>
<li><p><a class="reference internal" href="#v1-0-5" id="id28">v1.0.5</a></p>
<ul>
<li><p><a class="reference internal" href="#minor-changes" id="id31">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#minor-changes" id="id29">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-4" id="id32">v1.0.4</a></p></li>
<li><p><a class="reference internal" href="#v1-0-3" id="id33">v1.0.3</a></p>
<li><p><a class="reference internal" href="#v1-0-4" id="id30">v1.0.4</a></p></li>
<li><p><a class="reference internal" href="#v1-0-3" id="id31">v1.0.3</a></p>
<ul>
<li><p><a class="reference internal" href="#major-changes" id="id34">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id10" id="id35">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id12" id="id36">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#major-changes" id="id32">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id8" id="id33">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id10" id="id34">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-2" id="id37">v1.0.2</a></p>
<li><p><a class="reference internal" href="#v1-0-2" id="id35">v1.0.2</a></p>
<ul>
<li><p><a class="reference internal" href="#id14" id="id38">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id17" id="id39">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id12" id="id36">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id15" id="id37">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-1" id="id40">v1.0.1</a></p>
<li><p><a class="reference internal" href="#v1-0-1" id="id38">v1.0.1</a></p>
<ul>
<li><p><a class="reference internal" href="#release-summary" id="id41">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id19" id="id42">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id21" id="id43">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#release-summary" id="id39">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id17" id="id40">Major Changes</a></p></li>
<li><p><a class="reference internal" href="#id19" id="id41">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-0" id="id44">v1.0.0</a></p>
<li><p><a class="reference internal" href="#v1-0-0" id="id42">v1.0.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id23" id="id45">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id21" id="id43">Release Summary</a></p></li>
</ul>
</li>
</ul>
@ -170,26 +170,24 @@
</div>
<p>This changelog describes changes after version 0.2.6.</p>
<section id="v1-0-7">
<h2><a class="toc-backref" href="#id25">v1.0.7</a><a class="headerlink" href="#v1-0-7" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id23">v1.0.7</a><a class="headerlink" href="#v1-0-7" title="Permalink to this heading"></a></h2>
<section id="breaking-changes-porting-guide">
<h3><a class="toc-backref" href="#id26">Breaking Changes / Porting Guide</a><a class="headerlink" href="#breaking-changes-porting-guide" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id24">Breaking Changes / Porting Guide</a><a class="headerlink" href="#breaking-changes-porting-guide" title="Permalink 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>
<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="bugfixes">
<h3><a class="toc-backref" href="#id27">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id25">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Permalink 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>
<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="#id28">v1.0.6</a><a class="headerlink" href="#v1-0-6" title="Permalink to this heading"></a></h2>
<section id="id5">
<h3><a class="toc-backref" href="#id29">Bugfixes</a><a class="headerlink" href="#id5" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id26">v1.0.6</a><a class="headerlink" href="#v1-0-6" title="Permalink to this heading"></a></h2>
<section id="id3">
<h3><a class="toc-backref" href="#id27">Bugfixes</a><a class="headerlink" href="#id3" title="Permalink 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>
@ -197,77 +195,77 @@
</section>
</section>
<section id="v1-0-5">
<h2><a class="toc-backref" href="#id30">v1.0.5</a><a class="headerlink" href="#v1-0-5" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id28">v1.0.5</a><a class="headerlink" href="#v1-0-5" title="Permalink to this heading"></a></h2>
<section id="minor-changes">
<h3><a class="toc-backref" href="#id31">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id29">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Permalink 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="#id32">v1.0.4</a><a class="headerlink" href="#v1-0-4" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id30">v1.0.4</a><a class="headerlink" href="#v1-0-4" title="Permalink to this heading"></a></h2>
</section>
<section id="v1-0-3">
<h2><a class="toc-backref" href="#id33">v1.0.3</a><a class="headerlink" href="#v1-0-3" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id31">v1.0.3</a><a class="headerlink" href="#v1-0-3" title="Permalink to this heading"></a></h2>
<section id="major-changes">
<h3><a class="toc-backref" href="#id34">Major Changes</a><a class="headerlink" href="#major-changes" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id32">Major Changes</a><a class="headerlink" href="#major-changes" title="Permalink 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="id10">
<h3><a class="toc-backref" href="#id35">Minor Changes</a><a class="headerlink" href="#id10" title="Permalink to this heading"></a></h3>
<section id="id8">
<h3><a class="toc-backref" href="#id33">Minor Changes</a><a class="headerlink" href="#id8" title="Permalink 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="id12">
<h3><a class="toc-backref" href="#id36">Bugfixes</a><a class="headerlink" href="#id12" title="Permalink to this heading"></a></h3>
<section id="id10">
<h3><a class="toc-backref" href="#id34">Bugfixes</a><a class="headerlink" href="#id10" title="Permalink 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="#id37">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Permalink to this heading"></a></h2>
<section id="id14">
<h3><a class="toc-backref" href="#id38">Minor Changes</a><a class="headerlink" href="#id14" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id35">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Permalink to this heading"></a></h2>
<section id="id12">
<h3><a class="toc-backref" href="#id36">Minor Changes</a><a class="headerlink" href="#id12" title="Permalink 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="id17">
<h3><a class="toc-backref" href="#id39">Bugfixes</a><a class="headerlink" href="#id17" title="Permalink to this heading"></a></h3>
<section id="id15">
<h3><a class="toc-backref" href="#id37">Bugfixes</a><a class="headerlink" href="#id15" title="Permalink 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="#id40">v1.0.1</a><a class="headerlink" href="#v1-0-1" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id38">v1.0.1</a><a class="headerlink" href="#v1-0-1" title="Permalink to this heading"></a></h2>
<section id="release-summary">
<h3><a class="toc-backref" href="#id41">Release Summary</a><a class="headerlink" href="#release-summary" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id39">Release Summary</a><a class="headerlink" href="#release-summary" title="Permalink to this heading"></a></h3>
<p>Minor enhancements, bug and documentation fixes.</p>
</section>
<section id="id19">
<h3><a class="toc-backref" href="#id42">Major Changes</a><a class="headerlink" href="#id19" title="Permalink to this heading"></a></h3>
<section id="id17">
<h3><a class="toc-backref" href="#id40">Major Changes</a><a class="headerlink" href="#id17" title="Permalink 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="id21">
<h3><a class="toc-backref" href="#id43">Minor Changes</a><a class="headerlink" href="#id21" title="Permalink to this heading"></a></h3>
<section id="id19">
<h3><a class="toc-backref" href="#id41">Minor Changes</a><a class="headerlink" href="#id19" title="Permalink 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="#id44">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Permalink to this heading"></a></h2>
<section id="id23">
<h3><a class="toc-backref" href="#id45">Release Summary</a><a class="headerlink" href="#id23" title="Permalink to this heading"></a></h3>
<h2><a class="toc-backref" href="#id42">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Permalink to this heading"></a></h2>
<section id="id21">
<h3><a class="toc-backref" href="#id43">Release Summary</a><a class="headerlink" href="#id21" title="Permalink 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>

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

@ -12,13 +12,11 @@ v1.0.7
Breaking Changes / Porting Guide
--------------------------------
- keycloak_quarkus: use absolute path for certificate files `#39 <https://github.com/ansible-middleware/keycloak/pull/39>`_
- keycloak_quarkus: use absolute path for certificate files `#39 <https://github.com/ansible-middleware/keycloak/pull/39>`_
Bugfixes
--------
- keycloak_quarkus: use become for tasks that will otherwise fail `#38 <https://github.com/ansible-middleware/keycloak/pull/38>`_
- keycloak_quarkus: use become for tasks that will otherwise fail `#38 <https://github.com/ansible-middleware/keycloak/pull/38>`_
v1.0.6

31
main/_static/basic.css
View file

@ -608,8 +608,6 @@ ol.simple p,
ul.simple p {
margin-bottom: 0;
}
/* Docutils 0.17 and older (footnotes & citations) */
dl.footnote > dt,
dl.citation > dt {
float: left;
@ -627,33 +625,6 @@ dl.citation > dd:after {
clear: both;
}
/* Docutils 0.18+ (footnotes & citations) */
aside.footnote > span,
div.citation > span {
float: left;
}
aside.footnote > span:last-of-type,
div.citation > span:last-of-type {
padding-right: 0.5em;
}
aside.footnote > p {
margin-left: 2em;
}
div.citation > p {
margin-left: 4em;
}
aside.footnote > p:last-of-type,
div.citation > p:last-of-type {
margin-bottom: 0em;
}
aside.footnote > p:last-of-type:after,
div.citation > p:last-of-type:after {
content: "";
clear: both;
}
/* Footnotes & citations ends */
dl.field-list {
display: grid;
grid-template-columns: fit-content(30%) auto;
@ -665,11 +636,11 @@ dl.field-list > dt {
padding-left: 0.5em;
padding-right: 5px;
}
dl.field-list > dt:after {
content: ":";
}
dl.field-list > dd {
padding-left: 0.5em;
margin-top: 0em;

2
main/_static/documentation_options.js
View file

@ -10,5 +10,5 @@ var DOCUMENTATION_OPTIONS = {
SOURCELINK_SUFFIX: '.txt',
NAVIGATION_WITH_KEYS: false,
SHOW_SEARCH_SUMMARY: true,
ENABLE_SEARCH_SHORTCUTS: false,
ENABLE_SEARCH_SHORTCUTS: true,
};

17
main/_static/searchtools.js
View file

@ -88,7 +88,7 @@ const _displayItem = (item, highlightTerms, searchTerms) => {
linkEl.href = linkUrl + "?" + params.toString() + anchor;
linkEl.innerHTML = title;
if (descr)
listItem.appendChild(document.createElement("span")).innerText =
listItem.appendChild(document.createElement("span")).innerHTML =
" (" + descr + ")";
else if (showSearchSummary)
fetch(requestUrl)
@ -155,10 +155,8 @@ const Search = {
_pulse_status: -1,
htmlToText: (htmlString) => {
const htmlElement = document
.createRange()
.createContextualFragment(htmlString);
_removeChildren(htmlElement.querySelectorAll(".headerlink"));
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() });
const docContent = htmlElement.querySelector('[role="main"]');
if (docContent !== undefined) return docContent.textContent;
console.warn(
@ -504,11 +502,12 @@ const Search = {
* latter for highlighting it.
*/
makeSearchSummary: (htmlText, keywords, highlightWords) => {
const text = Search.htmlToText(htmlText).toLowerCase();
const text = Search.htmlToText(htmlText);
if (text === "") return null;
const textLower = text.toLowerCase();
const actualStartPosition = [...keywords]
.map((k) => text.indexOf(k.toLowerCase()))
.map((k) => textLower.indexOf(k.toLowerCase()))
.filter((i) => i > -1)
.slice(-1)[0];
const startWithContext = Math.max(actualStartPosition - 120, 0);
@ -516,9 +515,9 @@ const Search = {
const top = startWithContext === 0 ? "" : "...";
const tail = startWithContext + 240 < text.length ? "..." : "";
let summary = document.createElement("div");
let summary = document.createElement("p");
summary.classList.add("context");
summary.innerText = top + text.substr(startWithContext, 240).trim() + tail;
summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
highlightWords.forEach((highlightWord) =>
_highlightText(summary, highlightWord, "highlighted")

2
main/searchindex.js
View file

File diff suppressed because one or more lines are too long