Skip to content

Commit

Permalink
Update docs for main
Browse files Browse the repository at this point in the history
Signed-off-by: github-actions <[email protected]>
  • Loading branch information
guidograzioli committed Aug 24, 2023
1 parent 133c2d6 commit 7678169
Show file tree
Hide file tree
Showing 17 changed files with 177 additions and 137 deletions.
56 changes: 28 additions & 28 deletions main/CHANGELOG.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Expand Down Expand Up @@ -139,7 +139,7 @@
<div itemprop="articleBody">

<section id="middleware-automation-infinispan-release-notes">
<h1><a class="toc-backref" href="#id19" role="doc-backlink">middleware_automation.infinispan Release Notes</a><a class="headerlink" href="#middleware-automation-infinispan-release-notes" title="Permalink to this heading"></a></h1>
<h1><a class="toc-backref" href="#id19" role="doc-backlink">middleware_automation.infinispan Release Notes</a><a class="headerlink" href="#middleware-automation-infinispan-release-notes" title="Link to this heading"></a></h1>
<nav class="contents" id="topics">
<p class="topic-title">Topics</p>
<ul class="simple">
Expand Down Expand Up @@ -203,100 +203,100 @@ <h1><a class="toc-backref" href="#id19" role="doc-backlink">middleware_automatio
</nav>
<p>This changelog describes changes after version 0.1.9.</p>
<section id="v1-2-0-devel">
<h2><a class="toc-backref" href="#id20" role="doc-backlink">v1.2.0-devel</a><a class="headerlink" href="#v1-2-0-devel" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id20" role="doc-backlink">v1.2.0-devel</a><a class="headerlink" href="#v1-2-0-devel" title="Link to this heading"></a></h2>
<section id="major-changes">
<h3><a class="toc-backref" href="#id21" role="doc-backlink">Major Changes</a><a class="headerlink" href="#major-changes" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id21" role="doc-backlink">Major Changes</a><a class="headerlink" href="#major-changes" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Provide jgroups configuration <a class="reference external" href="https://github.com/ansible-middleware/infinispan/pull/31">#31</a></p></li>
</ul>
</section>
</section>
<section id="v1-1-4">
<h2><a class="toc-backref" href="#id22" role="doc-backlink">v1.1.4</a><a class="headerlink" href="#v1-1-4" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id22" role="doc-backlink">v1.1.4</a><a class="headerlink" href="#v1-1-4" title="Link to this heading"></a></h2>
<section id="minor-changes">
<h3><a class="toc-backref" href="#id23" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id23" 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 sqlserver to infinispan jdbc configurations <a class="reference external" href="https://github.com/ansible-middleware/infinispan/pull/25">#25</a></p></li>
<li><p>Provide systemd unit restart behavior configuration <a class="reference external" href="https://github.com/ansible-middleware/infinispan/pull/26">#26</a></p></li>
</ul>
</section>
</section>
<section id="v1-1-3">
<h2><a class="toc-backref" href="#id24" role="doc-backlink">v1.1.3</a><a class="headerlink" href="#v1-1-3" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id24" role="doc-backlink">v1.1.3</a><a class="headerlink" href="#v1-1-3" title="Link to this heading"></a></h2>
<section id="id4">
<h3><a class="toc-backref" href="#id25" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id4" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id25" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id4" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Switch redhat_csp_download with runtimes_common <a class="reference external" href="https://github.com/ansible-middleware/infinispan/pull/24">#24</a></p></li>
</ul>
</section>
</section>
<section id="v1-1-2">
<h2><a class="toc-backref" href="#id26" role="doc-backlink">v1.1.2</a><a class="headerlink" href="#v1-1-2" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id26" role="doc-backlink">v1.1.2</a><a class="headerlink" href="#v1-1-2" title="Link to this heading"></a></h2>
<section id="id6">
<h3><a class="toc-backref" href="#id27" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id6" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id27" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id6" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Update defaults to infinispan 14.0.3 - data grid 8.4.0 <a class="reference external" href="https://github.com/ansible-middleware/infinispan/pull/23">#23</a></p></li>
</ul>
</section>
</section>
<section id="v1-1-1">
<h2><a class="toc-backref" href="#id28" role="doc-backlink">v1.1.1</a><a class="headerlink" href="#v1-1-1" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id28" role="doc-backlink">v1.1.1</a><a class="headerlink" href="#v1-1-1" title="Link to this heading"></a></h2>
<section id="bugfixes">
<h3><a class="toc-backref" href="#id29" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id29" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Add requirements.yml dependencies to galaxy.yml <a class="reference external" href="https://github.com/ansible-middleware/infinispan/pull/21">#21</a></p></li>
</ul>
</section>
</section>
<section id="v1-1-0">
<h2><a class="toc-backref" href="#id30" role="doc-backlink">v1.1.0</a><a class="headerlink" href="#v1-1-0" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id30" role="doc-backlink">v1.1.0</a><a class="headerlink" href="#v1-1-0" title="Link to this heading"></a></h2>
<section id="breaking-changes-porting-guide">
<h3><a class="toc-backref" href="#id31" role="doc-backlink">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="#id31" 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>Rename roles and variables to have <code class="docutils literal notranslate"><span class="pre">infinispan_</span></code> prefix <a class="reference external" href="https://github.com/ansible-middleware/infinispan/pull/17">#17</a></p></li>
</ul>
</section>
</section>
<section id="v1-0-3">
<h2><a class="toc-backref" href="#id32" role="doc-backlink">v1.0.3</a><a class="headerlink" href="#v1-0-3" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id32" role="doc-backlink">v1.0.3</a><a class="headerlink" href="#v1-0-3" title="Link to this heading"></a></h2>
<section id="release-summary">
<h3><a class="toc-backref" href="#id33" role="doc-backlink">Release Summary</a><a class="headerlink" href="#release-summary" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id33" role="doc-backlink">Release Summary</a><a class="headerlink" href="#release-summary" title="Link to this heading"></a></h3>
<p>Patch release containing an important bugfix for downloaded archives filemodes.</p>
</section>
</section>
<section id="v1-0-2">
<h2><a class="toc-backref" href="#id34" role="doc-backlink">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id34" role="doc-backlink">v1.0.2</a><a class="headerlink" href="#v1-0-2" title="Link to this heading"></a></h2>
<section id="id10">
<h3><a class="toc-backref" href="#id35" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id10" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id35" role="doc-backlink">Major Changes</a><a class="headerlink" href="#id10" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Make playbook compatible with multiple installations on same host <a class="reference external" href="https://github.com/ansible-middleware/infinispan/pull/12">#12</a></p></li>
</ul>
</section>
<section id="id12">
<h3><a class="toc-backref" href="#id36" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id12" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id36" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id12" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Make <code class="docutils literal notranslate"><span class="pre">supervisor_password</span></code> a default with assert (was: role variable) <a class="reference external" href="https://github.com/ansible-middleware/infinispan/pull/14">#14</a></p></li>
<li><p>New <code class="docutils literal notranslate"><span class="pre">jdg_configure_firewalld</span></code> bool parameter controls firewall config <a class="reference external" href="https://github.com/ansible-middleware/infinispan/pull/13">#13</a></p></li>
</ul>
</section>
<section id="id15">
<h3><a class="toc-backref" href="#id37" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id15" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id37" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id15" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>JAVA_HOME should be set according to requested JVM package, or overridden via <code class="docutils literal notranslate"><span class="pre">jdg_java_home</span></code> <a class="reference external" href="https://github.com/ansible-middleware/infinispan/pull/15">#15</a></p></li>
</ul>
</section>
</section>
<section id="v1-0-1">
<h2><a class="toc-backref" href="#id38" role="doc-backlink">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" role="doc-backlink">v1.0.1</a><a class="headerlink" href="#v1-0-1" title="Link to this heading"></a></h2>
<section id="id17">
<h3><a class="toc-backref" href="#id39" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id17" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id39" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id17" title="Link to this heading"></a></h3>
<p>Patch release containing only cleanup and documentation changes.</p>
</section>
</section>
<section id="v1-0-0">
<h2><a class="toc-backref" href="#id40" role="doc-backlink">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id40" role="doc-backlink">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Link to this heading"></a></h2>
<section id="id18">
<h3><a class="toc-backref" href="#id41" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id18" title="Permalink to this heading"></a></h3>
<h3><a class="toc-backref" href="#id41" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id18" 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.infinispan</span></code> collection.</p>
</section>
</section>
Expand Down
30 changes: 15 additions & 15 deletions main/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Expand Down Expand Up @@ -111,7 +111,7 @@
<div itemprop="articleBody">

<section id="ansible-collection-middleware-automation-infinispan">
<h1>Ansible Collection - middleware_automation.infinispan<a class="headerlink" href="#ansible-collection-middleware-automation-infinispan" title="Permalink to this heading"></a></h1>
<h1>Ansible Collection - middleware_automation.infinispan<a class="headerlink" href="#ansible-collection-middleware-automation-infinispan" title="Link to this heading"></a></h1>
<!--start build_status -->
<p><a class="reference external" href="https://github.com/ansible-middleware/infinispan/actions/workflows/ci.yml"><img alt="Build Status" src="https://github.com/ansible-middleware/infinispan/workflows/CI/badge.svg?branch=main" /></a></p>
<blockquote>
Expand All @@ -124,16 +124,16 @@ <h1>Ansible Collection - middleware_automation.infinispan<a class="headerlink" h
<!--end upstream_downstream -->
<!--start requires_ansible-->
<section id="ansible-version-compatibility">
<h2>Ansible version compatibility<a class="headerlink" href="#ansible-version-compatibility" title="Permalink to this heading"></a></h2>
<h2>Ansible version compatibility<a class="headerlink" href="#ansible-version-compatibility" title="Link to this heading"></a></h2>
<p>This collection has been tested against following Ansible versions: <strong>&gt;=2.9.10</strong>.</p>
<p>Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions.</p>
<!--end requires_ansible-->
</section>
<section id="installation-and-usage">
<h2>Installation and Usage<a class="headerlink" href="#installation-and-usage" title="Permalink to this heading"></a></h2>
<h2>Installation and Usage<a class="headerlink" href="#installation-and-usage" title="Link to this heading"></a></h2>
<!--start galaxy_download -->
<section id="installing-the-collection-from-ansible-galaxy">
<h3>Installing the Collection from Ansible Galaxy<a class="headerlink" href="#installing-the-collection-from-ansible-galaxy" title="Permalink to this heading"></a></h3>
<h3>Installing the Collection from Ansible Galaxy<a class="headerlink" href="#installing-the-collection-from-ansible-galaxy" title="Link to this heading"></a></h3>
<p>Before using the collection, you need to install it with the Ansible Galaxy CLI:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>ansible-galaxy collection install middleware_automation.infinispan
</pre></div>
Expand All @@ -147,24 +147,24 @@ <h3>Installing the Collection from Ansible Galaxy<a class="headerlink" href="#in
</div>
</section>
<section id="build-and-install-locally">
<h3>Build and install locally<a class="headerlink" href="#build-and-install-locally" title="Permalink to this heading"></a></h3>
<h3>Build and install locally<a class="headerlink" href="#build-and-install-locally" title="Link to this heading"></a></h3>
<p>Clone the repository, checkout the tag you want to build, or pick the main branch for the development version; then:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>ansible-galaxy collection build .
ansible-galaxy collection install middleware_automation-amq-*.tar.gz
</pre></div>
</div>
</section>
<section id="dependencies">
<h3>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this heading"></a></h3>
<h3>Dependencies<a class="headerlink" href="#dependencies" title="Link to this heading"></a></h3>
<section id="ansible-collections">
<h4>Ansible collections:<a class="headerlink" href="#ansible-collections" title="Permalink to this heading"></a></h4>
<h4>Ansible collections:<a class="headerlink" href="#ansible-collections" title="Link to this heading"></a></h4>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/ansible-middleware/common">middleware_automation.common</a></p></li>
<li><p><a class="reference external" href="https://docs.ansible.com/ansible/latest/collections/ansible/posix/index.html">ansible.posix</a></p></li>
</ul>
</section>
<section id="python">
<h4>Python:<a class="headerlink" href="#python" title="Permalink to this heading"></a></h4>
<h4>Python:<a class="headerlink" href="#python" title="Link to this heading"></a></h4>
<p>The infinispan collection also depends on the following python packages to be present on the controller host:</p>
<ul class="simple">
<li><p>lxml</p></li>
Expand All @@ -177,7 +177,7 @@ <h4>Python:<a class="headerlink" href="#python" title="Permalink to this heading
</section>
</section>
<section id="included-roles">
<h3>Included roles<a class="headerlink" href="#included-roles" title="Permalink to this heading"></a></h3>
<h3>Included roles<a class="headerlink" href="#included-roles" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/ansible-middleware/infinispan/tree/main/roles/infinispan"><code class="docutils literal notranslate"><span class="pre">infinispan</span></code></a>: performs an installation of Infinispan or DataGrid nodes or cluster, with configuration of static caches.</p></li>
<li><p><a class="reference external" href="https://github.com/ansible-middleware/infinispan/tree/main/roles/infinispan_cache"><code class="docutils literal notranslate"><span class="pre">infinispan_cache</span></code></a>: creates Infinispan or DataGrid caches at runtime.</p></li>
Expand All @@ -187,7 +187,7 @@ <h3>Included roles<a class="headerlink" href="#included-roles" title="Permalink
</section>
</section>
<section id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this heading"></a></h2>
<h2>License<a class="headerlink" href="#license" title="Link to this heading"></a></h2>
<p>Apache License v2.0 or later</p>
<p>See <a class="reference internal" href="#LICENSE"><span class="xref myst">LICENSE</span></a> to view the full text.</p>
</section>
Expand Down
22 changes: 22 additions & 0 deletions main/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,10 @@ a.headerlink {
visibility: hidden;
}

a:visited {
color: #551A8B;
}

h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
Expand Down Expand Up @@ -670,6 +674,16 @@ dd {
margin-left: 30px;
}

.sig dd {
margin-top: 0px;
margin-bottom: 0px;
}

.sig dl {
margin-top: 0px;
margin-bottom: 0px;
}

dl > dd:last-child,
dl > dd:last-child > :last-child {
margin-bottom: 0;
Expand Down Expand Up @@ -738,6 +752,14 @@ abbr, acronym {
cursor: help;
}

.translated {
background-color: rgba(207, 255, 207, 0.2)
}

.untranslated {
background-color: rgba(255, 207, 207, 0.2)
}

/* -- code displays --------------------------------------------------------- */

pre {
Expand Down
Loading

0 comments on commit 7678169

Please sign in to comment.