Skip to content

Commit

Permalink
Merge pull request #17 from ansible-collections/release-v1.0.0-beta2
Browse files Browse the repository at this point in the history
Release v1.0.0 beta2
  • Loading branch information
itsBryantP authored May 23, 2020
2 parents e111e87 + 2bbbdfa commit 207607c
Show file tree
Hide file tree
Showing 32 changed files with 1,865 additions and 338 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ IBM z/OS IMS collection
The **IBM z/OS IMS collection**, also represented as **ibm\_zos\_ims**
in this document, is part of the broader offering **Red Hat® Ansible
Certified Content for IBM Z**. The IBM z/OS IMS collection supports tasks
such as generating IMS Database Descriptors (DBD) and Program
Specification Blocks (PSB) and running IMS type-1 & type-2 commands.
such as generating IMS Database Descriptors (DBD), Program
Specification Blocks (PSB), Application Control Blocks (ACB), and
running IMS type-1 & type-2 commands.

The **IBM z/OS IMS collection** works closely with offerings such as the
[IBM z/OS core collection](https://github.com/ansible-collections/ibm_zos_core)
Expand All @@ -32,6 +33,7 @@ Features
========

The IBM IMS collection includes
[action plugins](https://github.com/ansible-collections/ibm_zos_ims/tree/master/plugins/action/)
[modules](https://github.com/ansible-collections/ibm_zos_ims/tree/master/plugins/modules/),
[sample playbooks](https://github.com/ansible-collections/ibm_zos_ims/tree/master/playbooks/),
and ansible-doc to automate tasks on IMS.
Expand Down
11 changes: 7 additions & 4 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ IBM z/OS IMS collection
The **IBM z/OS IMS collection**, also represented as **ibm\_zos\_ims**
in this document, is part of the broader offering **Red Hat® Ansible
Certified Content for IBM Z**. The IBM z/OS IMS collection supports tasks
such as generating IMS Database Descriptors (DBD) and Program
Specification Blocks (PSB) and running IMS type-1 & type-2 commands.
such as generating IMS Database Descriptors (DBD), Program Specification
Blocks (PSB), Application Control Blocks (ACB), and running IMS type-1
& type-2 commands.

The **IBM z/OS IMS collection** works closely with offerings such as the
`IBM z/OS core collection`_ to deliver a solution that will enable you to
Expand All @@ -35,10 +36,12 @@ community supported.
Features
========

The IBM z/OS IMS collection includes `modules`_, `sample playbooks`_, and
ansible-doc to automate tasks on z/OS.
The IBM z/OS IMS collection includes `action plugins`_, `modules`_,
`sample playbooks`_, and ansible-doc to automate tasks on z/OS.


.. _action plugins:
https://github.com/ansible-collections/ibm_zos_ims/tree/master/plugins/action/
.. _modules:
https://github.com/ansible-collections/ibm_zos_ims/tree/master/plugins/modules/
.. _sample playbooks:
Expand Down
42 changes: 26 additions & 16 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,29 +20,38 @@ from the Ansible community.

Galaxy provides prepackaged units of work known as collections. You can use the
`ansible-galaxy`_ command with the option ``install`` to install a collection on
your system (control node) hosted in Galaxy. If you have installed a prior
version, you must overwrite an existing collection with the ``--force`` option.
your system (control node) hosted in Galaxy.

Here are a few examples of installing the **IBM z/OS IMS collection**:
By default, the `ansible-galaxy`_ command installs the latest available
collection, but you can add a version identifier to install a specific version.
Before installing a collection from Galaxy, review all the available versions.
Periodically, new releases containing enhancements and features you might be
interested in become available.

The ansible-galaxy command ignores any pre-release versions unless
the ``==`` range identifier is set to that pre-release version.
A pre-release version is denoted by appending a hyphen and a series of
dot separated identifiers immediately following the patch version. The
**IBM z/OS IMS collection** releases collections with the pre-release
naming convention such as **1.0.0-beta2** that would require a range identifier.

Here is an example an example of installing a pre-release collection:

.. code-block:: sh
$ ansible-galaxy collection install ibm.ibm_zos_ims
$ ansible-galaxy collection install -f ibm.ibm_zos_ims
$ ansible-galaxy collection install --force ibm.ibm_zos_ims
$ ansible-galaxy collection install ibm.ibm_zos_ims:==1.0.0-beta2
By default, the `ansible-galaxy`_ command installs the latest available
collection, but you can add a version identifier to install a specific version.
Before installing a collection from Galaxy, review all the available versions.
Periodically, new releases containing enhancements and features that you might
be interested in become available.
Here's an example command for installing the **IBM z/OS IMS collection** for
a specific version.
If you have installed a prior version, you must overwrite an existing
collection with the ``--force`` option.

Here are a few examples of installing the **IBM z/OS IMS collection**:

.. code-block:: sh
$ ansible-galaxy collection install ibm.ibm_zos_ims::1.0.0
$ ansible-galaxy collection install ibm.ibm_zos_ims
$ ansible-galaxy collection install -f ibm.ibm_zos_ims
$ ansible-galaxy collection install --force ibm.ibm_zos_ims
The collection installation progress will be output to the console. Note the
location of the installation so that you can review other content included with
Expand All @@ -69,6 +78,7 @@ After installation, the collection content will resemble this hierarchy: :
│ ├── docs/
│ ├── playbooks/
│ ├── plugins/
│ ├── action/
│ ├── module_utils/
│ ├── modules/
Expand Down Expand Up @@ -117,7 +127,7 @@ To configure a Galaxy server list in the ansible.cfg file:
* Create a new section for each server name.
* Set the url option for each server name.

To configure the server for Automation Hub, you must also:
For Automation Hub, you additionally need to:

* Set the auth_url option for each server name.
* Set the API token for each server name. For more information on API tokens,
Expand All @@ -126,7 +136,7 @@ To configure the server for Automation Hub, you must also:
.. _Get API token from the version dropdown to copy your API token:
https://cloud.redhat.com/ansible/automation-hub/token/

The following example shows a configuration for Automation Hub, a privately
The following example shows a configuration for Automation Hub, a private
running Galaxy server, and Galaxy:

.. code-block:: yaml
Expand Down
Loading

0 comments on commit 207607c

Please sign in to comment.