Skip to content

Commit d375ee0

Browse files
authored
Hotfix/122/update readme (#5)
* update README.md to reflect collection * hot fix for zos_data_set existence checking and validation * update README.md version tag links to v.0.0.3 * Updates to README.md that include fixing a malformed link * Remove dependency list from modules Dependencies will be stated on the collections README.md
1 parent 49d892d commit d375ee0

File tree

5 files changed

+61
-54
lines changed

5 files changed

+61
-54
lines changed

README.md

Lines changed: 38 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,42 @@
1+
# IBM Z Core Collection
2+
3+
The IBM Z core collection, referred to as `ibm_zos_core`, is part of the broader offering __Red Hat® Ansible Certified Content for IBM Z__. `ibm_zos_core` supports tasks such as creating data sets, submitting jobs, querying jobs, and retrieving job output.
4+
15
# Red Hat Ansible Certified Content for IBM Z
2-
__Red Hat® Ansible Certified Content for IBM Z__ provides the ability to connect IBM Z® to clients' wider enterprise automation strategy through the Ansible Automation Platform ecosystem. The __Red Hat Ansible Certified Content for IBM Z core collection__ (`ibm_zos_core`) enables development and operations to automate on Z by providing Ansible support for tasks such as creating data sets, submitting jobs, querying jobs, and retrieving job output.
6+
__Red Hat® Ansible Certified Content for IBM Z__ provides the ability to connect IBM Z® to clients' wider enterprise
7+
automation strategy through the Ansible Automation Platform ecosystem. This enables development and operations automation on Z through a seamless, unified workflow orchestration with configuration management, provisioning, and
8+
application deployment in one easy-to-use platform.
39

4-
# Features
5-
The __Red Hat Ansible Certified Content for IBM Z core collection__ `ibm_zos_core` includes [connection plugins](https://github.com/ansible-collections/ibm_zos_core/tree/v0.0.2/plugins/connection/), [action plugins](https://github.com/ansible-collections/ibm_zos_core/tree/v0.0.2/plugins/action/), [modules](https://github.com/ansible-collections/ibm_zos_core/tree/v0.0.2/plugins/modules/), [sample playbooks](https://github.com/ansible-collections/ibm_zos_core/tree/v0.0.2/playbooks/), and ansible-doc to automate tasks on Z.
10+
Collections, as part of the broader offering __Red Hat® Ansible Certified Content for IBM Z__, will initially be made available
11+
on Galaxy and later made available as certified content and accessable through Automation Hub.
612

7-
These features enable a seamless, unified workflow orchestration with configuration management, provisioning, and application deployment in one easy-to-use platform.
13+
# Features
14+
The The IBM Z core collection includes [connection plugins](https://github.com/ansible-collections/ibm_zos_core/tree/v0.0.3/plugins/connection/), [action plugins](https://github.com/ansible-collections/ibm_zos_core/tree/v0.0.3/plugins/action/), [modules](https://github.com/ansible-collections/ibm_zos_core/tree/v0.0.3/plugins/modules/), [sample playbooks](https://github.com/ansible-collections/ibm_zos_core/tree/v0.0.3/playbooks/), and ansible-doc to automate tasks on Z.
815

916
# Plugins
1017

1118
## Action
12-
* [normal](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.2/docs/README-zos-rexx-connection-plugin.md): A fork of [Ansible _normal.py_ action plugin](https://github.com/ansible/ansible/blob/devel/lib/ansible/plugins/action/normal.py) that is modified to allow a conditional shebang line in REXX modules.
13-
* [zos_job_submit](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.2/docs/README-zos-job-submit.md): Used to submit a job from the controller and optionally monitor for completion.
19+
* [normal](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.3/docs/README-zos-rexx-connection-plugin.md): A fork of [Ansible _normal.py_ action plugin](https://github.com/ansible/ansible/blob/devel/lib/ansible/plugins/action/normal.py) that is modified to allow a conditional shebang line in REXX modules.
20+
* [zos_job_submit](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.3/docs/README-zos-job-submit.md): Used to submit a job from the controller and optionally monitor for job completion.
1421

1522
## Connection
16-
* [zos_ssh](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.2/docs/README-zos-rexx-connection-plugin.md): Enables the Ansible controller to communicate to a Z target machine by using ssh with the added support to transfer ASCII as EBCDIC when transferring REXX modules. The connection plugin was forked from the [Ansible _ssh.py_ connection plugin](https://github.com/ansible/ansible/blob/480b106d6535978ae6ecab68b40942ca4fa914a0/lib/ansible/plugins/connection/ssh.py).
23+
* [zos_ssh](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.3/docs/README-zos-rexx-connection-plugin.md): Enables the Ansible controller to communicate to a Z target machine by using ssh, with the added support to transfer ASCII as EBCDIC when transferring REXX modules. This connection plugin was forked from the [Ansible _ssh.py_ connection plugin](https://github.com/ansible/ansible/blob/480b106d6535978ae6ecab68b40942ca4fa914a0/lib/ansible/plugins/connection/ssh.py).
1724

1825
# Modules
19-
* [zos_data_set](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.2/docs/README-zos-data-set.md): Create, delete, and manage attributes for data sets.
20-
* [zos_job_query](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.2/docs/README-zos-job-query.md): Query Z for a list of jobs.
21-
* [zos_job_submit](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.2/docs/README-zos-job-submit.md): Submit a job and optionally monitor for completion.
22-
* [zos_job_output](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.2/docs/README-zos-job-output.md): Capture the job output for a submitted job.
26+
* [zos_data_set](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.3/docs/README-zos-data-set.md): Create, delete, and manage attributes for data sets.
27+
* [zos_job_query](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.3/docs/README-zos-job-query.md): Query Z for a list of jobs.
28+
* [zos_job_submit](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.3/docs/README-zos-job-submit.md): Submit a job and optionally monitor for its completion.
29+
* [zos_job_output](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.3/docs/README-zos-job-output.md): Capture the job output for a submitted job.
2330

2431
# Playbooks
25-
[Sample playbooks](https://github.com/ansible-collections/ibm_zos_core/tree/v0.0.2/playbooks/) are included that demonstrate how to use the collection content in the `ibm_zos_core` collection.
26-
See the [playbooks README](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.2/playbooks/README.md) for detailed instructions and configuration information.
32+
[Sample playbooks](https://github.com/ansible-collections/ibm_zos_core/tree/v0.0.3/playbooks/) are included that demonstrate how to use the collection content in the `ibm_zos_core` collection.
33+
See the [playbooks README](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.3/playbooks/README.md) for detailed instructions and configuration information.
2734

2835
# Requirements
2936

3037
A control node is any machine with Ansible installed. From the control node, you can run commands and playbooks from a laptop, desktop, or server machine. However, you cannot run them on a Windows machine.
3138

32-
A managed node is often referred as a target node or host and is the node that is managed by Ansible. Ansible does not need not be installed on a managed node, but SSH must be eanabled.
39+
A managed node is often referred to as a target node, or host, and is the node that is managed by Ansible. Ansible does not need not need to be installed on a managed node, but SSH must be eanabled.
3340

3441
The following nodes require specific versions of software:
3542

@@ -39,9 +46,9 @@ The following nodes require specific versions of software:
3946
* [OpenSSH](https://www.openssh.com/)
4047

4148
## Managed node (target)
42-
* [Python](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.2/docs/README-python-zos.md): 3.6 or later
49+
* [Python](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.3/docs/README-python-zos.md): 3.6 or later
4350
* [z/OS](https://www.ibm.com/support/knowledgecenter/SSLTBW_2.2.0/com.ibm.zos.v2r2/zos-v2r2-home.html): V02.02.00 or later
44-
* [IBM Z Open Automation Utilities](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.2/docs/README-ZOAU.md): 1.0.1 (PTF UI66957 or later)
51+
* [IBM Z Open Automation Utilities](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.3/docs/README-ZOAU.md): 1.0.1 (PTF UI66957 or later)
4552
* [OpenSSH](https://www.openssh.com/)
4653

4754
# Installation
@@ -83,10 +90,17 @@ Installed collection content:
8390

8491
You can use the `-p` option with `anasible-galaxy` to specify the installation path such as `ansible-galaxy collection install ibm.ibm_zos_core -p /home/ansible/collections`. For more information on installing collections with Ansible Galaxy, see [Installing collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#installing-collections-with-ansible-galaxy).
8592

86-
## Automation Hub and private Galaxy server
87-
You can use the [ansible-galaxy](https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html) command with option `install` to install a collection on your system (control node) hosted in Hub or a private Galaxy server.
93+
## Private Galaxy server
94+
95+
Configuring access to a private Galaxy server follows the same instructions that you would use to configure your client to point to
96+
Automation Hub. When hosting a private Galaxy server or pointing to Hub, available content is not always consistent with
97+
what is avaialable on the community Galaxy server.
98+
99+
You can use the [ansible-galaxy](https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html) command with
100+
option `install` to install a collection on your system (control node) hosted in Automation Hub or a private Galaxy server.
88101

89-
By default, the `ansible-galaxy` command uses https://galaxy.ansible.com as the Galaxy server when you install a collection. The `ansible-galaxy` client can be configured to point to _HUB_ or other servers, such as a privately running Galaxy server, by configuring the server list in the `ansible.cfg` file.
102+
By default, the `ansible-galaxy` command uses https://galaxy.ansible.com as the Galaxy server when you install a collection.
103+
The `ansible-galaxy` client can be configured to point to _HUB_ or other servers, such as a privately running Galaxy server, by configuring the server list in the `ansible.cfg` file.
90104

91105
Ansible searches for `ansible.cfg` in these locations in this order:
92106
* ANSIBLE_CONFIG (environment variable if set)
@@ -148,7 +162,7 @@ Created collection for ibm.ibm_zos_core at /Users/user/git/ibm/zos-ansible/ibm_z
148162
__Note__: If you build the collection with Ansible version 2.9 or earlier, you will see the following warning that you can ignore.
149163
`[WARNING]: Found unknown keys in collection galaxy.yml at '/Users/user/git/ibm/zos-ansible/ibm_zos_core/galaxy.yml': build_ignore`
150164

151-
You can use the `-p` option with `anasible-galaxy` to specify the installation path, for example, `ansible-galaxy collection install ibm-ibm_zos_core-0.0.2.tar.gz -p /home/ansible/collections`. For more information, see [Installing collections with Ansible Galaxy] (https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#installing-collections-with-ansible-galaxy).
165+
You can use the `-p` option with `anasible-galaxy` to specify the installation path, for example, `ansible-galaxy collection install ibm-ibm_zos_core-0.0.2.tar.gz -p /home/ansible/collections`. For more information, see [Installing collections with Ansible Galaxy](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#installing-collections-with-ansible-galaxy).
152166

153167
3. Install the locally built collection:
154168
```
@@ -188,7 +202,7 @@ In Ansible 2.9, the `collections` keyword was added and reduces the need to refe
188202
```
189203

190204
## ansible-doc
191-
Modules included in this collection provide additional documentation that is similar to a UNIX or UNIX-like operating system man page (manual page). This documentation an be accessed from the command line by using the `ansible-doc` command.
205+
Modules included in this collection provide additional documentation that is similar to a UNIX, or UNIX-like, operating system man page (manual page). This documentation can be accessed from the command line by using the `ansible-doc` command.
192206

193207
Here's how to use the Ansible-supplied command after you install the _Red Hat Ansible Certified Content for IBM Z core collection_:
194208
`ansible-doc ibm.ibm_zos_core.zos_data_set`
@@ -220,13 +234,13 @@ OPTIONS (= is mandatory):
220234
* [Getting started Ansible guide](https://docs.ansible.com/ansible/latest/user_guide/intro_getting_started.html).
221235

222236
# Contributing
223-
Currently we are not accepting community contributions. Periodically review this content on when and how contributions could be contributed.
237+
Currently we are not accepting community contributions. Though, you may periodically review this content to learn when and how contributions can be made in the future.
224238

225239
# Copyright
226240
© Copyright IBM Corporation 2020
227241

228242
# License
229-
Portions of this collection are licensed under [GNU General Public License, Version 3.0](https://opensource.org/licenses/GPL-3.0),
230-
and portions of this collection are licensed under [Apache License, Version 2.0](https://opensource.org/licenses/Apache-2.0).
243+
Some portions of this collection are licensed under [GNU General Public License, Version 3.0](https://opensource.org/licenses/GPL-3.0),
244+
and other portions of this collection are licensed under [Apache License, Version 2.0](https://opensource.org/licenses/Apache-2.0).
231245
See individual files for applicable licenses.
232246

docs/README-ZOAU.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ See [Installing and configuring ZOA Utilities](https://www.ibm.com/support/knowl
99
* See the [fix list](https://www.ibm.com/support/pages/fix-list-ibm-z-open-automation-utilities) for ZOAU.
1010
* The latest PTF when this document was authored is __UI66957__.
1111

12-
__Note__: [Python 3.6 for z/OS](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.2/docs/README-python-zos.md) is required by ZOAU.
12+
__Note__: [Python 3.6 for z/OS](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.3/docs/README-python-zos.md) is required by ZOAU.
1313

1414
# Copyright
1515
© Copyright IBM Corporation 2020

galaxy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ namespace: ibm
55
name: ibm_zos_core
66

77
# The collection version
8-
version: 0.0.2
8+
version: 0.0.3
99

1010
# Collection README file
1111
readme: README.md

playbooks/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ An [Ansible playbook](https://docs.ansible.com/ansible/latest/user_guide/playboo
33

44
Included in __Red Hat Ansible Certified Content for IBM Z core collection__ is a playbooks directory that will contain any number of sample playbooks that with little modification to the __inventory__, __ansible config__ and __group_vars__ can be run with the `ansible-playbook` command.
55

6-
You can find the playbook content that is included with the collection where the collection was installed, please refer back to the [installation documentation](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.2/README.md#installation). In the following examples, this documment will refer to the installation path as `~/.ansible/collections/ibm/ibm_zos_core`.
6+
You can find the playbook content that is included with the collection where the collection was installed, please refer back to the [installation documentation](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.3/README.md#installation). In the following examples, this documment will refer to the installation path as `~/.ansible/collections/ibm/ibm_zos_core`.
77

88
# Sample Playbook Configuration and Setup
99

1010
## Ansible Config
11-
Ansible config `ansible.cfg` can override nearly all `ansible-playbook` configurations. Also included in the [playbooks/](https://github.com/ansible-collections/ibm_zos_core/tree/v0.0.2/playbooks) directory is a sample `ansible.cfg` that with little modificaton can supplement `ansible-playbook`.
11+
Ansible config `ansible.cfg` can override nearly all `ansible-playbook` configurations. Also included in the [playbooks/](https://github.com/ansible-collections/ibm_zos_core/tree/v0.0.3/playbooks) directory is a sample `ansible.cfg` that with little modificaton can supplement `ansible-playbook`.
1212

1313
In the sample `ansible.cfg`, the only required configuration is:
1414
`pipelining = True`
@@ -18,7 +18,7 @@ For more information about available configurations for `ansible.cfg`, read the
1818
## Inventory
1919
Ansible works with multiple managed nodes (hosts) at the same time, using a list or group of lists know as an [inventory](https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html). Once the inventory is defined, you can use [patterns](https://docs.ansible.com/ansible/latest/user_guide/intro_patterns.html#intro-patterns) to select the hosts, or groups, you want Ansible to run against.
2020

21-
Included in the [playbooks/](https://github.com/ansible-collections/ibm_zos_core/tree/v0.0.2/playbooks) directory is a sample [inventory](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.2/playbooks/inventory) file that with little modification can be used to manage your nodes. This inventory file should be included when running the sample playbook.
21+
Included in the [playbooks/](https://github.com/ansible-collections/ibm_zos_core/tree/v0.0.3/playbooks) directory is a sample [inventory](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.3/playbooks/inventory) file that with little modification can be used to manage your nodes. This inventory file should be included when running the sample playbook.
2222

2323
```
2424
zsystem:
@@ -41,7 +41,7 @@ The value for property __ansible_python_interpreter__ is the target host python
4141
For more information on python configuration requirements on z/OS, refer to [Ansible FAQ: Running on z/OS](https://docs.ansible.com/ansible/latest/reference_appendices/faq.html).
4242

4343
## Group Vars
44-
Although you can store variables in the inventory file, storing separate host and group variables files may help you organize your variable values more easily. Included with the sample playbook is a sample variable file located in [./group_vars/all.yml](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.2/playbooks/group_vars/all.yml).
44+
Although you can store variables in the inventory file, storing separate host and group variables files may help you organize your variable values more easily. Included with the sample playbook is a sample variable file located in [./group_vars/all.yml](https://github.com/ansible-collections/ibm_zos_core/blob/v0.0.3/playbooks/group_vars/all.yml).
4545

4646
The value for property __BPXK_AUTOCVT__ must be configured to `ON`.
4747

0 commit comments

Comments
 (0)