Skip to content

Commit

Permalink
Automated commit to update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@ddimatos
ddimatos committed May 16, 2024
1 parent 5977f0f commit d47edba
Show file tree
Hide file tree
Showing 5 changed files with 77 additions and 62 deletions.
40 changes: 28 additions & 12 deletions _sources/ibm_zos_cics/docs/source/release_notes.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,28 @@
.. ...............................................................................
.. © Copyright IBM Corporation 2020,2023 .
.. © Copyright IBM Corporation 2020,2024 .
.. Apache License, Version 2.0 (see https://opensource.org/licenses/Apache-2.0) .
.. ...............................................................................
========
Releases
========

Version 2.0.0
======

What's new
---------------

* **Removed support for Python 2.7.** Python 2.7 is no longer supported as the managed node runtime.


Version 1.0.6
=============
What's New
-------------------
* Bug fix that allows CICSPlex SM Scope and Context to contain special characters '$', '@', and '#'.


Version 1.0.5
=============
What's New
Expand Down Expand Up @@ -48,25 +64,25 @@ Initial release of the **IBM® z/OS® CICS® collection**, also referred to as *

This collection can manage CICS and CICSPlex® SM resources and definitions by calling the `CMCI REST API`_, which can be configured in a CICSplex or in a stand-alone region.

* Modules
**Modules**

* ``cmci_create`` - Create definitional CICS and CICSPlex SM resources in CICS regions, by initiating POST requests via the CMCI REST API.
* ``cmci_delete`` - Remove or discard definitional and installed CICS and CICSPlex SM resources from CICS regions, by initiating DELETE requests via the CMCI REST API.
* ``cmci_get`` - Retrieve information about installed and definitional CICS and CICSPlex SM resources from CICS regions, by initiating GET requests via the CMCI REST API.
* ``cmci_action`` - Install CICS and CICSPlex SM resources into CICS regions from definitions, by initiating PUT requests via the CMCI REST API.
* ``cmci_update`` - Make changes to CICS and CICSPlex SM resources in CICS regions, by initiating PUT requests via the CMCI REST API.
* ``cmci_create`` - Create definitional CICS and CICSPlex SM resources in CICS regions, by initiating POST requests via the CMCI REST API.
* ``cmci_delete`` - Remove or discard definitional and installed CICS and CICSPlex SM resources from CICS regions, by initiating DELETE requests via the CMCI REST API.
* ``cmci_get`` - Retrieve information about installed and definitional CICS and CICSPlex SM resources from CICS regions, by initiating GET requests via the CMCI REST API.
* ``cmci_action`` - Install CICS and CICSPlex SM resources into CICS regions from definitions, by initiating PUT requests via the CMCI REST API.
* ``cmci_update`` - Make changes to CICS and CICSPlex SM resources in CICS regions, by initiating PUT requests via the CMCI REST API.


* Documentation
**Documentation**

* Generic documentation is available at `the documentation site`_, covering guidance on installation, modules, and other reference.
* Generic documentation is available at `the documentation site`_, covering guidance on installation, modules, and other reference.

* Documentation related to playbook configuration is provided with sample playbooks at the `samples repository`_. Each playbook contains a README that explains what configurations must be made to run a sample playbook.
* Documentation related to playbook configuration is provided with sample playbooks at the `samples repository`_. Each playbook contains a README that explains what configurations must be made to run a sample playbook.


* Playbooks
**Playbooks**

* Sample playbooks are available at the `samples repository`_. Each playbook contains a README that explains what configurations must be made to run a sample playbook.
* Sample playbooks are available at the `samples repository`_. Each playbook contains a README that explains what configurations must be made to run a sample playbook.

.. _samples repository:
https://github.com/IBM/z_ansible_collections_samples/tree/main/zos_subsystems/cics
Expand Down
20 changes: 4 additions & 16 deletions _sources/ibm_zos_cics/docs/source/requirements_managed.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. ...........................................................................
.. © Copyright IBM Corporation 2020,2021 .
.. © Copyright IBM Corporation 2020,2024 .
.. ...........................................................................
Requirements of managed nodes
Expand All @@ -21,24 +21,15 @@ The requirements of the managed node are as follows:

* `requests`_
* `xmltodict`_
* `typing`_ (For Python versions < 3.5)

If you delegate the tasks to run on your localhost, the Python module dependencies
need to be installed on your localhost instead.

You can install them from CLI:
You can install them from the CLI by using the following command:

* If your Python version is no less than 3.5:
.. code-block:: sh
.. code-block:: sh
pip install requests xmltodict
* If your Python version < 3.5:

.. code-block:: sh
pip install requests xmltodict typing
pip install requests xmltodict
You can also install them using the playbook. For example, this `CICS
Expand All @@ -49,9 +40,6 @@ The requirements of the managed node are as follows:

.. _xmltodict:
https://pypi.org/project/xmltodict/

.. _typing:
https://pypi.org/project/typing/

.. _CICS sample playbook:
https://github.com/IBM/z_ansible_collections_samples/tree/main/zos_subsystems/cics/cmci/reporting
Expand Down
65 changes: 43 additions & 22 deletions ibm_zos_cics/docs/source/release_notes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,20 +100,28 @@
<li class="toctree-l1 current"><a class="reference internal" href="../../../release/release.html">Releases</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../../ibm_zos_core/docs/source/release_notes.html">z/OS core</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">z/OS CICS</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#version-2-0-0">Version 2.0.0</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#what-s-new">What’s new</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#version-1-0-6">Version 1.0.6</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#id1">What’s New</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#version-1-0-5">Version 1.0.5</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#what-s-new">What’s New</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id2">What’s New</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#version-1-0-4">Version 1.0.4</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#id1">What’s New</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id3">What’s New</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#version-1-0-3">Version 1.0.3</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#id2">What’s New</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id4">What’s New</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#version-1-0-1">Version 1.0.1</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#id3">What’s New</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id5">What’s New</a></li>
<li class="toctree-l4"><a class="reference internal" href="#availability">Availability</a></li>
<li class="toctree-l4"><a class="reference internal" href="#reference">Reference</a></li>
</ul>
Expand Down Expand Up @@ -206,19 +214,37 @@

<div class="section" id="releases">
<h1>Releases<a class="headerlink" href="#releases" title="Permalink to this headline"></a></h1>
<div class="section" id="version-2-0-0">
<h2>Version 2.0.0<a class="headerlink" href="#version-2-0-0" title="Permalink to this headline"></a></h2>
<div class="section" id="what-s-new">
<h3>What’s new<a class="headerlink" href="#what-s-new" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p><strong>Removed support for Python 2.7.</strong> Python 2.7 is no longer supported as the managed node runtime.</p></li>
</ul>
</div>
</div>
<div class="section" id="version-1-0-6">
<h2>Version 1.0.6<a class="headerlink" href="#version-1-0-6" title="Permalink to this headline"></a></h2>
<div class="section" id="id1">
<h3>What’s New<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Bug fix that allows CICSPlex SM Scope and Context to contain special characters ‘$’, ‘&#64;’, and ‘#’.</p></li>
</ul>
</div>
</div>
<div class="section" id="version-1-0-5">
<h2>Version 1.0.5<a class="headerlink" href="#version-1-0-5" title="Permalink to this headline"></a></h2>
<div class="section" id="what-s-new">
<h3>What’s New<a class="headerlink" href="#what-s-new" title="Permalink to this headline"></a></h3>
<div class="section" id="id2">
<h3>What’s New<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Bug fix that includes the <code class="docutils literal notranslate"><span class="pre">requirements.txt</span></code> file in the built collection.</p></li>
</ul>
</div>
</div>
<div class="section" id="version-1-0-4">
<h2>Version 1.0.4<a class="headerlink" href="#version-1-0-4" title="Permalink to this headline"></a></h2>
<div class="section" id="id1">
<h3>What’s New<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<div class="section" id="id3">
<h3>What’s New<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Provide variables for all modules in one go using Ansible’s <a class="reference external" href="https://docs.ansible.com/ansible/2.8/user_guide/playbooks_module_defaults.html#module-defaults-groups">group module defaults</a> support. The group name for the CMCI modules is <code class="docutils literal notranslate"><span class="pre">cmci_group</span></code>.</p></li>
<li><p>Prevent <code class="docutils literal notranslate"><span class="pre">cmci_get</span></code> from failing if no records are found via the <code class="docutils literal notranslate"><span class="pre">fail_on_nodata</span></code> option. The default value is true if not specified.</p></li>
Expand All @@ -227,8 +253,8 @@ <h3>What’s New<a class="headerlink" href="#id1" title="Permalink to this headl
</div>
<div class="section" id="version-1-0-3">
<h2>Version 1.0.3<a class="headerlink" href="#version-1-0-3" title="Permalink to this headline"></a></h2>
<div class="section" id="id2">
<h3>What’s New<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<div class="section" id="id4">
<h3>What’s New<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Updated timeout support on requests to be configurable via the <code class="docutils literal notranslate"><span class="pre">timeout</span></code> option. The default value is 30 seconds if not specified</p></li>
<li><p>Improve sanitisation and validation of parameters.</p></li>
Expand All @@ -238,32 +264,27 @@ <h3>What’s New<a class="headerlink" href="#id2" title="Permalink to this headl
</div>
<div class="section" id="version-1-0-1">
<h2>Version 1.0.1<a class="headerlink" href="#version-1-0-1" title="Permalink to this headline"></a></h2>
<div class="section" id="id3">
<h3>What’s New<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<div class="section" id="id5">
<h3>What’s New<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3>
<p>Initial release of the <strong>IBM® z/OS® CICS® collection</strong>, also referred to as <strong>ibm_zos_cics</strong>, which is part of the broader offering <strong>Red Hat® Ansible® Certified Content for IBM Z®</strong>.</p>
<p>This collection can manage CICS and CICSPlex® SM resources and definitions by calling the <a class="reference external" href="https://www.ibm.com/docs/en/cics-ts/latest?topic=cmci-how-it-works-rest-api">CMCI REST API</a>, which can be configured in a CICSplex or in a stand-alone region.</p>
<p><strong>Modules</strong></p>
<ul class="simple">
<li><p>Modules</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">cmci_create</span></code> - Create definitional CICS and CICSPlex SM resources in CICS regions, by initiating POST requests via the CMCI REST API.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">cmci_delete</span></code> - Remove or discard definitional and installed CICS and CICSPlex SM resources from CICS regions, by initiating DELETE requests via the CMCI REST API.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">cmci_get</span></code> - Retrieve information about installed and definitional CICS and CICSPlex SM resources from CICS regions, by initiating GET requests via the CMCI REST API.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">cmci_action</span></code> - Install CICS and CICSPlex SM resources into CICS regions from definitions, by initiating PUT requests via the CMCI REST API.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">cmci_update</span></code> - Make changes to CICS and CICSPlex SM resources in CICS regions, by initiating PUT requests via the CMCI REST API.</p></li>
</ul>
</li>
<li><p>Documentation</p>
<ul>
<p><strong>Documentation</strong></p>
<ul class="simple">
<li><p>Generic documentation is available at <a class="reference external" href="https://ibm.github.io/z_ansible_collections_doc/ibm_zos_cics/docs/ansible_content.html">the documentation site</a>, covering guidance on installation, modules, and other reference.</p></li>
<li><p>Documentation related to playbook configuration is provided with sample playbooks at the <a class="reference external" href="https://github.com/IBM/z_ansible_collections_samples/tree/main/zos_subsystems/cics">samples repository</a>. Each playbook contains a README that explains what configurations must be made to run a sample playbook.</p></li>
</ul>
</li>
<li><p>Playbooks</p>
<ul>
<p><strong>Playbooks</strong></p>
<ul class="simple">
<li><p>Sample playbooks are available at the <a class="reference external" href="https://github.com/IBM/z_ansible_collections_samples/tree/main/zos_subsystems/cics">samples repository</a>. Each playbook contains a README that explains what configurations must be made to run a sample playbook.</p></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="availability">
<h3>Availability<a class="headerlink" href="#availability" title="Permalink to this headline"></a></h3>
Expand Down
12 changes: 1 addition & 11 deletions ibm_zos_cics/docs/source/requirements_managed.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -205,23 +205,13 @@ <h1>Requirements of managed nodes<a class="headerlink" href="#requirements-of-ma
<ul class="simple">
<li><p><a class="reference external" href="https://pypi.org/project/requests/">requests</a></p></li>
<li><p><a class="reference external" href="https://pypi.org/project/xmltodict/">xmltodict</a></p></li>
<li><p><a class="reference external" href="https://pypi.org/project/typing/">typing</a> (For Python versions &lt; 3.5)</p></li>
</ul>
<p>If you delegate the tasks to run on your localhost, the Python module dependencies
need to be installed on your localhost instead.</p>
<p>You can install them from CLI:</p>
<ul>
<li><p>If your Python version is no less than 3.5:</p>
<p>You can install them from the CLI by using the following command:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip install requests xmltodict
</pre></div>
</div>
</li>
<li><p>If your Python version &lt; 3.5:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip install requests xmltodict typing
</pre></div>
</div>
</li>
</ul>
<p>You can also install them using the playbook. For example, this <a class="reference external" href="https://github.com/IBM/z_ansible_collections_samples/tree/main/zos_subsystems/cics/cmci/reporting">CICS
sample playbook</a> shows how you can ensure the pre-requisites are installed before the module is executed.</p>
</li>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit d47edba

Please sign in to comment.