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 committed May 16, 2024
1 parent d47edba commit b3b3353
Show file tree
Hide file tree
Showing 83 changed files with 5,657 additions and 1,138 deletions.
15 changes: 7 additions & 8 deletions _sources/ibm_zos_sysauto/docs/ansible_content.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,22 @@ The **IBM Z System Automation collection**, also represented as `ibm_zos_sysauto
is  part of the broader initiative to bring Ansible Automation to IBM Z® through the offering
**Red Hat® Ansible Certified Content for IBM Z®**.

The **IBM Z System Automation collection** supports operational tasks using the IBM Z System Automation Operations API
The **IBM Z System Automation collection** supports operational tasks using the IBM Z System Automation Operations API
such as creating and deleting `dynamic resources`_ from a template defined in the current active policy of an `IBM Z System Automation`_ environment.

The Ansible roles in this collection are written in Ansible and interact with the `Operations REST server component`_ of IBM Z System Automation.

.. _ibm_zos_sysauto:
https://galaxy.ansible.com/ibm/ibm_zos_sysauto
.. _IBM Z System Automation:
.. _dynamic resources:
https://www.ibm.com/docs/en/z-system-automation/4.3.0?topic=concepts-dynamic-resources
.. _IBM Z System Automation:
https://www.ibm.com/products/z-system-automation
.. _Operations REST server component:
https://www.ibm.com/support/knowledgecenter/de/SSWRCJ_4.2.0/com.ibm.safos.doc_4.2/Integrating.html
.. _dynamic resources:
https://www.ibm.com/support/knowledgecenter/de/SSWRCJ_4.2.0/com.ibm.safos.doc_4.2/UserGuide/Dynamic_Resources.html


https://www.ibm.com/docs/en/z-system-automation/4.3.0?topic=program-system-automation-operations-rest-serverr

.. toctree::
:maxdepth: 1
:caption: Collection Content

source/roles
source/roles
37 changes: 26 additions & 11 deletions _sources/ibm_zos_sysauto/docs/source/release_notes.rst.txt
Original file line number Diff line number Diff line change
@@ -1,19 +1,34 @@
.. ...........................................................................
.. © Copyright IBM Corporation 2020, 2022 .
.. © Copyright IBM Corporation 2020, 2023 .
.. ...........................................................................
======================
Releases
======================

Version 1.1.0
====================

What's New
----------

* Added new parameters to create USS resources from templates.

Availability
------------

* `Automation Hub`_
* `Galaxy`_
* `GitHub`_

Version 1.0.1
====================

What's New
----------

* Update collection to meet new requirements.

Availability
------------

Expand All @@ -35,12 +50,12 @@ What's New

* Beginning this release, the sample playbooks previously included with the
collection will be made available on the `playbook repository`_.

* Playbooks

* Add default values for credentials in sample playbooks.
* Provide inventory sample in YAML format.

Availability
------------

Expand All @@ -60,7 +75,7 @@ Notes
* Update not required
* Fixed one more broken link in the docs.
* Minor updates to the documentation.

Availability
------------

Expand All @@ -75,7 +90,7 @@ Notes

* Update not required
* Minor updates to the documentation.

Availability
------------

Expand All @@ -90,7 +105,7 @@ Notes

* Update not required
* Fixed broken links in the documentation.

Availability
------------

Expand All @@ -103,21 +118,21 @@ Version 0.0.1
Notes
-----

* Initial beta release of IBM Z System Automation collection, referred to as ibm_zos_sysauto
* Initial beta release of IBM Z System Automation collection, referred to as ibm_zos_sysauto
which is part of the broader offering Red Hat® Ansible Certified Content for IBM Z.

Availability
------------

* `Galaxy`_
* `GitHub`_


.. _GitHub:
https://github.com/ansible-collections/ibm_zos_sysauto

.. _Galaxy:
https://galaxy.ansible.com/ibm/ibm_zos_sysauto

.. _Automation Hub:
https://www.ansible.com/products/automation-hub
https://www.ansible.com/products/automation-hub
5 changes: 2 additions & 3 deletions _sources/ibm_zos_sysauto/docs/source/roles.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ use certain roles in your playbook.
:glob:

roles/*

.. _IBM Z System Automation:
https://www.ibm.com/support/knowledgecenter/SSWRCJ_4.2.0/com.ibm.safos.doc_4.2/kc_welcome-444.html

https://www.ibm.com/products/z-system-automation
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Parameters
----------



sa_service_hostname
Specifies the IBM Z System Automation Operations REST server host name.

Expand All @@ -36,7 +36,7 @@ sa_service_hostname
| **type**: str


sa_service_port
Specifies the port to which the IBM Z Automation Operations REST service is bound.

Expand All @@ -45,7 +45,7 @@ sa_service_port
| **type**: str


sa_service_protocol
Specifies the protocol that is configured for the IBM Z Automation Operations REST server.

Expand All @@ -55,7 +55,7 @@ sa_service_protocol
| **default**: HTTPS


sa_rest_api_timeout
Specifies the socket level timeout for the REST API call in seconds.

Expand All @@ -65,7 +65,7 @@ sa_rest_api_timeout
| **default**: 30


username
Specifies the NetView user.

Expand All @@ -74,7 +74,7 @@ username
| **type**: str


password
Specifies the password for above user.

Expand All @@ -83,7 +83,7 @@ password
| **type**: str


templateName
Specifies the name of the template that will be used to create the dynamic resource.

Expand All @@ -92,7 +92,7 @@ templateName
| **type**: str


subsystem
Specifies the subsystem name of the new resource.

Expand All @@ -103,7 +103,7 @@ subsystem
| **type**: str


system
Specifies the system where the resource will be created.

Expand All @@ -114,7 +114,7 @@ system
| **type**: str


job
Specifies the job name of the new resource.

Expand All @@ -125,7 +125,7 @@ job
| **type**: str


procedure
Specifies the procedure name used by the new resource.

Expand All @@ -136,7 +136,7 @@ procedure
| **type**: str


comment
Specifies a comment to be associated with the creation of the new resource.

Expand All @@ -147,7 +147,7 @@ comment
| **type**: str


group
Specifies the automation name of the application group (APG) that will host the new resource.

Expand All @@ -158,7 +158,7 @@ group
| **type**: str


sdesc
Specifies a short description of the new resource.

Expand All @@ -168,6 +168,24 @@ sdesc
| **required**: False
| **type**: str
path
Specifies the fulll qualified ZFS path to find the application to be started by this new resource.

The maximum length for this value is 159.


| **required**: False
| **type**: str
filter:
Specifies an additional filter criteria to uniquely identify the USS process represented by this new resource.

The maximum length for this value is 159.


| **required**: False
| **type**: str



Expand All @@ -176,7 +194,7 @@ Examples

.. code-block:: yaml+jinja


- name: create and resume a dynamic resource in SA
hosts: sampleHost
gather_facts: no
Expand Down
31 changes: 9 additions & 22 deletions _sources/requirements/requirements.rst.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. ...........................................................................
.. © Copyright IBM Corporation 2020, 2021 .
.. © Copyright IBM Corporation 2020, 2024 .
.. ...........................................................................
============
Expand All @@ -18,18 +18,12 @@ you can run commands and playbooks from a laptop, desktop, or server. However,
Windows® is not a supported controller for Ansible collections managing a z/OS
node.

All IBM z/OS collections are either `Ansible Automation Platform Certified Content`_
(AAP) or undergoing certification. Thus, the supported versions of Ansible align
with the `AAP Life Cycle`_ which currently is Ansible versions 2.9 - 2.15. For
support, the controller must use the supported version of Ansible and when applicable
the collections dependencies. Review the `Ansible Automation Platform Certified Content`_
to determine which versions of Ansible a collection is supporting.
All IBM z/OS collections are either `Ansible Automation Platform Certified Content`_ (AAP) or undergoing certification. Thus, the supported versions of Ansible align with the `AAP Life Cycle`_. For support, the controller must use the supported version of Ansible and when applicable the collections dependencies.

IBM z/OS collections minimally require these versions of software, for additional
supported versions review `Ansible Automation Platform Certified Content`_.
The minimum software requirements for IBM z/OS collections are:

* `Ansible version`_: 2.9
* `Python`_: 2.7 or later
* `ansible-core`_: 2.15 (AAP 2.4) or later
* `IBM Open Enterprise SDK for Python`_: 3.11 or later
* `OpenSSH`_

* Modules which can have Ansible tasks delegated to a localhost need not
Expand All @@ -38,19 +32,12 @@ supported versions review `Ansible Automation Platform Certified Content`_.
to review which collections leverage a REST endpoint.

Each offering in the **Red Hat® Ansible Certified Content for IBM Z** offering
can vary in terms of the requirements for the control node. Select one of the
following offerings to learn more about the specific dependencies and
required/supported software versions.
can vary in terms of the requirements for the control node. When you install any of them, review the specific dependencies and required/supported software versions, if any.

.. toctree::
:maxdepth: 1

z/OS z/OSMF <../ibm_zosmf/docs/source/requirements_control>

.. _Ansible version:
.. _ansible-core:
https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html
.. _Python:
https://www.python.org/downloads
.. _IBM Open Enterprise SDK for Python:
https://www.ibm.com/products/open-enterprise-python-zos
.. _OpenSSH:
https://www.openssh.com/
.. _Ansible Automation Platform Certified Content:
Expand Down
1 change: 1 addition & 0 deletions _sources/zhmc-ansible-modules/CHANGELOG.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: docs/sources/release_notes.rst
2 changes: 1 addition & 1 deletion _sources/zhmc-ansible-modules/docs/ansible_content.rst.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. Copyright 2017-2020 IBM Corp. All Rights Reserved.
.. Copyright 2017,2020 IBM Corp. All Rights Reserved.
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. Copyright 2017-2021 IBM Corp. All Rights Reserved.
.. Copyright 2017,2021 IBM Corp. All Rights Reserved.
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
Expand Down
Loading

0 comments on commit b3b3353

Please sign in to comment.