Skip to content

Commit

Permalink
Update docs for main
Browse files Browse the repository at this point in the history 
Signed-off-by: ansible-middleware-core <[email protected]>
  • Loading branch information
@ansible-middleware-core
ansible-middleware-core committed Aug 30, 2024
1 parent 1b63d11 commit 89850b6
Show file tree
Hide file tree
Showing 19 changed files with 229 additions and 273 deletions.
91 changes: 1 addition & 90 deletions index.html
View file
Original file line number Diff line number Diff line change
@@ -1,90 +1 @@
<!doctype html>
<html>
<head>
<title>Infinispan Ansible Collection documentation index</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="stylesheet" href="https://ansible-middleware.github.io/infinispan/main/_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="https://ansible-middleware.github.io/infinispan/main/_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="https://ansible-middleware.github.io/infinispan/main/_static/ansible-basic-sphinx-ext.css" type="text/css" />
<script data-url_root="./" id="documentation_options" src="https://ansible-middleware.github.io/infinispan/main/_static/documentation_options.js"></script>
<script src="https://ansible-middleware.github.io/infinispan/main/_static/jquery.js"></script>
<script src="https://ansible-middleware.github.io/infinispan/main/_static/underscore.js"></script>
<script src="https://ansible-middleware.github.io/infinispan/main/_static/doctools.js"></script>
<script src="https://ansible-middleware.github.io/infinispan/main/_static/js/theme.js"></script>
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home"> Infinispan Ansible Collection</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Middleware Automation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="https://ansible-middleware.github.io/infinispan/">Infinispan / Red Hat Data Grid</a></li>
<li class="toctree-l1"><a class="reference internal" href="https://ansible-middleware.github.io/keycloak/">Keycloak / Red Hat Single Sign-On</a></li>
<li class="toctree-l1"><a class="reference internal" href="https://ansible-middleware.github.io/wildfly/">Wildfly / Red Hat JBoss EAP</a></li>
<li class="toctree-l1"><a class="reference internal" href="https://ansible-middleware.github.io/jws/">Tomcat / Red Hat JWS</a></li>
<li class="toctree-l1"><a class="reference internal" href="https://ansible-middleware.github.io/amq/">ActiveMQ / Red Hat AMQ Broker</a></li>
<li class="toctree-l1"><a class="reference internal" href="https://ansible-middleware.github.io/amq_streams/">Kafka / Red Hat AMQ Streams</a></li>
<li class="toctree-l1"><a class="reference internal" href="https://ansible-middleware.github.io/redhat-csp-download/">Red Hat CSP Download</a></li>
<li class="toctree-l1"><a class="reference internal" href="https://ansible-middleware.github.io/ansible_collections_jcliff/">JCliff</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home"></a> &raquo;</li>
<li>Welcome to Infinispan Collection documentation</li>
<li class="wy-breadcrumbs-aside"></li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="welcome-to-infinispan-collection-documentation">
<h1>Welcome to Infinispan Collection documentation<a class="headerlink" href="#welcome-to-infinispan-collection-documentation" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Pick collection version:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="main/">main</a></li>
<li class="toctree-l1"><a class="reference internal" href="latest/">latest</a></li>
<li class="toctree-l1"><a class="reference internal" href="1.2.0/">1.2.0</a></li>
<li class="toctree-l1"><a class="reference internal" href="1.1.4/">1.1.4</a></li>
<li class="toctree-l1"><a class="reference internal" href="1.1.3/">1.1.3</a></li>
<li class="toctree-l1"><a class="reference internal" href="1.1.2/">1.1.2</a></li>
<li class="toctree-l1"><a class="reference internal" href="1.1.1/">1.1.1</a></li>
<li class="toctree-l1"><a class="reference internal" href="1.1.0/">1.1.0</a></li>
<li class="toctree-l1"><a class="reference internal" href="1.0.3/">1.0.3</a></li>
<li class="toctree-l1"><a class="reference internal" href="1.0.2/">1.0.2</a></li>
<li class="toctree-l1"><a class="reference internal" href="1.0.1/">1.0.1</a></li>
<li class="toctree-l1"><a class="reference internal" href="1.0.0/">1.0.0</a></li>
<li class="toctree-l1"><a class="reference internal" href="0.1.9/">0.1.9</a></li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023, Red Hat, Inc.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
</body>
</html>
<!DOCTYPE html><html><head><meta http-equiv="refresh" content="0; url=./main/" /></head></html>
26 changes: 12 additions & 14 deletions main/CHANGELOG.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Collection Versioning Strategy" href="releasing.html" />
<link rel="next" title="Developing" href="developing.html" />
<link rel="prev" title="infinispan_cache" href="roles/infinispan_cache.html" />
</head>

<body class="wy-body-for-nav">
Expand All @@ -45,19 +46,9 @@
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="README.html">Ansible Collection - middleware_automation.infinispan</a></li>
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="developing.html">Contributor’s Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="releasing.html">Collection Versioning Strategy</a></li>
<li class="toctree-l1"><a class="reference internal" href="releasing.html#release-automation">Release automation</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">General</span></p>
<ul class="current">
<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-2-devel">v1.3.2-devel</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#minor-changes">Minor Changes</a></li>
Expand Down Expand Up @@ -120,6 +111,13 @@
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="developing.html">Developing</a></li>
<li class="toctree-l1"><a class="reference internal" href="developing.html#contributor-s-guidelines">Contributor’s Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="releasing.html">Releasing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Middleware collections</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/infinispan/">Infinispan / Red Hat Data Grid</a></li>
Expand All @@ -128,7 +126,6 @@
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/jws/">Tomcat / Red Hat JWS</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/amq/">ActiveMQ / Red Hat AMQ</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/amq_streams/">Kafka / Red Hat AMQ Streams</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/redhat-csp-download/">Red Hat CSP Download</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/ansible_collections_jcliff/">JCliff</a></li>
</ul>

Expand Down Expand Up @@ -396,7 +393,8 @@ <h3><a class="toc-backref" href="#id67" role="doc-backlink">Release Summary</a><
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="releasing.html" class="btn btn-neutral float-left" title="Collection Versioning Strategy" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="roles/infinispan_cache.html" class="btn btn-neutral float-left" title="infinispan_cache" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="developing.html" class="btn btn-neutral float-right" title="Developing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
37 changes: 29 additions & 8 deletions main/README.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,23 +58,25 @@
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#included-roles">Included roles</a></li>
<li class="toctree-l3"><a class="reference internal" href="#install-playbook">Install playbook</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#controller-node-install-zipfile-path">Controller node install zipfile path</a></li>
<li class="toctree-l4"><a class="reference internal" href="#offline-from-controller-node">Offline from controller node</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="CHANGELOG.html">Changelog</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="developing.html">Developing</a></li>
<li class="toctree-l1"><a class="reference internal" href="developing.html#contributor-s-guidelines">Contributor’s Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="developing.html">Contributor’s Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="releasing.html">Collection Versioning Strategy</a></li>
<li class="toctree-l1"><a class="reference internal" href="releasing.html#release-automation">Release automation</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">General</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="CHANGELOG.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="releasing.html">Releasing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Middleware collections</span></p>
<ul>
Expand All @@ -84,7 +86,6 @@
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/jws/">Tomcat / Red Hat JWS</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/amq/">ActiveMQ / Red Hat AMQ</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/amq_streams/">Kafka / Red Hat AMQ Streams</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/redhat-csp-download/">Red Hat CSP Download</a></li>
<li class="toctree-l1"><a class="reference external" href="https://ansible-middleware.github.io/ansible_collections_jcliff/">JCliff</a></li>
</ul>

Expand Down Expand Up @@ -186,10 +187,30 @@ <h3>Included roles<a class="headerlink" href="#included-roles" title="Link to th
<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>
</ul>
<!--end roles_paths -->
</section>
<section id="install-playbook">
<h3>Install playbook<a class="headerlink" href="#install-playbook" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/ansible-middleware/amq/blob/main/playbooks/infinispan.yml"><code class="docutils literal notranslate"><span class="pre">playbooks/infinispan.yml</span></code></a> deploys based on the collections defaults.</p></li>
</ul>
<section id="controller-node-install-zipfile-path">
<h4>Controller node install zipfile path<a class="headerlink" href="#controller-node-install-zipfile-path" title="Link to this heading"></a></h4>
<p>By default the collection will download the desired version of the install zipfile to the ansible controller node, then it will distribute to target nodes.</p>
</section>
<section id="offline-from-controller-node">
<h4>Offline from controller node<a class="headerlink" href="#offline-from-controller-node" title="Link to this heading"></a></h4>
<p>Making the install zipfile archive available to the playbook working directory, and setting <code class="docutils literal notranslate"><span class="pre">infinispan_offline_install</span></code> to <code class="docutils literal notranslate"><span class="pre">true</span></code>, allows to skip
the download tasks. The local path for the archive does match the downloaded archive path, so that it is also used as a cache when multiple hosts are provisioned in a cluster.</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">infinispan_offline_install</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
</pre></div>
</div>
<!--start rhn_credentials -->
<!--end rhn_credentials -->
<!--start support -->
<!--end support -->
</section>
</section>
</section>
<section id="license">
<h2>License<a class="headerlink" href="#license" title="Link to this heading"></a></h2>
<p>Apache License v2.0 or later</p>
Expand Down
24 changes: 24 additions & 0 deletions main/_sources/README.md.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,37 @@ A requirement file is provided to install:

pip install -r requirements.txt


<!--start roles_paths -->
### Included roles

* [`infinispan`](https://github.com/ansible-middleware/infinispan/tree/main/roles/infinispan): performs an installation of Infinispan or DataGrid nodes or cluster, with configuration of static caches.
* [`infinispan_cache`](https://github.com/ansible-middleware/infinispan/tree/main/roles/infinispan_cache): creates Infinispan or DataGrid caches at runtime.
<!--end roles_paths -->

### Install playbook

* [`playbooks/infinispan.yml`](https://github.com/ansible-middleware/amq/blob/main/playbooks/infinispan.yml) deploys based on the collections defaults.


#### Controller node install zipfile path

By default the collection will download the desired version of the install zipfile to the ansible controller node, then it will distribute to target nodes.


#### Offline from controller node

Making the install zipfile archive available to the playbook working directory, and setting `infinispan_offline_install` to `true`, allows to skip
the download tasks. The local path for the archive does match the downloaded archive path, so that it is also used as a cache when multiple hosts are provisioned in a cluster.

```yaml
infinispan_offline_install: true
```

<!--start rhn_credentials -->
<!--end rhn_credentials -->


<!--start support -->
<!--end support -->

Expand Down
36 changes: 36 additions & 0 deletions main/_sources/developing.md.txt
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,39 @@
## Developing


### Build and install locally

Clone the repository, checkout the tag you want to build, or pick the main branch for the development version; then:

ansible-galaxy collection build .
ansible-galaxy collection install middleware_automation-infinispan-*.tar.gz


### Development environment

Make sure your development machine has avilable:

* python 3.11+
* virtualenv
* docker (or podman)

In order to run setup the development environment and run the molecule tests locally, after cloning the repository:

```
# create new virtualenv using python 3
virtualenv $PATH_TO_DEV_VIRTUALENV
# activate the virtual env
source $PATH_TO_DEV_VIRTUALENV/bin/activate
# install ansible and tools onto the virtualenv
pip install yamllint 'molecule>=6.0' 'molecule-plugins[docker]' 'ansible-core>=2.15' ansible-lint
# install collection dependencies
ansible-galaxy collection install -r requirements.yml
# install python dependencies
pip install -r requirements.txt molecule/requirements.txt
# execute the tests (replace --all with -s subdirectory to run a single test)
molecule test --all
```


## Contributor's Guidelines

Expand Down
9 changes: 4 additions & 5 deletions main/_sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,20 @@ Welcome to Infinispan Collection documentation
README
plugins/index
roles/index
Changelog <CHANGELOG>

.. toctree::
:maxdepth: 2
:caption: Developer documentation

testing
developing
releasing
Developing <developing>
Testing <testing>
Releasing <releasing>

.. toctree::
:maxdepth: 2
:caption: General

Changelog <CHANGELOG>

.. toctree::
:maxdepth: 2
Expand All @@ -35,5 +35,4 @@ Welcome to Infinispan Collection documentation
Tomcat / Red Hat JWS <https://ansible-middleware.github.io/jws/>
ActiveMQ / Red Hat AMQ <https://ansible-middleware.github.io/amq/>
Kafka / Red Hat AMQ Streams <https://ansible-middleware.github.io/amq_streams/>
Red Hat CSP Download <https://ansible-middleware.github.io/redhat-csp-download/>
JCliff <https://ansible-middleware.github.io/ansible_collections_jcliff/>
2 changes: 1 addition & 1 deletion main/_sources/releasing.md.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,6 @@ A correction to the README would be considered a bug fix and the PATCH increment
Only the PATCH version should be increased for a release that contains changes limited to revised documentation.


# Release automation
## Release automation

New releases are triggered by annotated git tags named after semantic versioning. The automation publishes the built artifacts to ansible-galaxy and github releases page.
Loading

0 comments on commit 89850b6

Please sign in to comment.