Skip to content

Commit 473140e

Browse files
ddimatosAbhirami HddgandhiCherabhiseulsale
authored
Release v1.3.1 (#166)
* Update README.md * Create life-cycle_ims.rst * Update release_notes.rst * Empty-Commit * Revert "Update README.md" This reverts commit ecd0d46. * Merge pull request #145 from seulsale/new-readme-template-clean Updates README.md with new template from Red Hat. * Update README.md * Readme updated changes made * Documentation changes Life cycle and release notes * Update release_notes.rst * revised helpers for testcases Signed-off-by: Dipti <[email protected]> * revised the version of the IMS collection release Signed-off-by: Dipti <[email protected]> * Update conftest and helper class to work with zdt environment * install oyaml dependency * fix pyyaml installation error * set ssh key location * disable strict host key check * update reslib location to new hlq * Update zos_dataset required parameter * had to fix test cases for warnings Signed-off-by: Dipti <[email protected]> * had to fix test cases for warnings Signed-off-by: Dipti <[email protected]> * had to change the volume since its zDT system Signed-off-by: Dipti <[email protected]> * had to change the volume since its zDT system Signed-off-by: Dipti <[email protected]> * had to change the volume since its zDT system Signed-off-by: Dipti <[email protected]> * add section for this release to changelogs Signed-off-by: Dipti <[email protected]> * updated ansible version Signed-off-by: Dipti <[email protected]> * testing the table * minor changes and table modifiy * suggested changes by dememtri * Update release_notes.rst * updated collection version Signed-off-by: Dipti <[email protected]> * modified doc format Signed-off-by: Dipti <[email protected]> * modified doc to be consistent Signed-off-by: Dipti <[email protected]> * modified requirements Signed-off-by: Dipti <[email protected]> * added content to Testing section Signed-off-by: Dipti <[email protected]> * added content to Support section Signed-off-by: Dipti <[email protected]> * added content to Release section Signed-off-by: Dipti <[email protected]> * modified core version Signed-off-by: Dipti <[email protected]> * ignore the old ignore sanity files in galaxy Signed-off-by: Dipti <[email protected]> * new ignore files added Signed-off-by: Dipti <[email protected]> * new ignore files added Signed-off-by: Dipti <[email protected]> * linting fixed Signed-off-by: Dipti <[email protected]> * Incorporated latest changes * updated link * Update CHANGELOG.rst * Update CHANGELOG.rst * new changes * unsused imports removed Signed-off-by: Dipti <[email protected]> * unsused variables removed Signed-off-by: Dipti <[email protected]> * fixed linting Signed-off-by: Dipti <[email protected]> * added new author Signed-off-by: Dipti <[email protected]> * added .ansible-lint file Signed-off-by: Dipti <[email protected]> * added build ignore Signed-off-by: Dipti <[email protected]> * latest * updated life_cycle.rst Signed-off-by: Dipti <[email protected]> * updated life_cycle.rst Signed-off-by: Dipti <[email protected]> * updated life_cycle.rst Signed-off-by: Dipti <[email protected]> * updated life_cycle.rst Signed-off-by: Dipti <[email protected]> * updated life_cycle.rst Signed-off-by: Dipti <[email protected]> * updated life_cycle.rst Signed-off-by: Dipti <[email protected]> * updated life_cycle.rst Signed-off-by: Dipti <[email protected]> * Update docs/source/life-cycle.rst Co-authored-by: Demetri <[email protected]> * Spelling and url correction Signed-off-by: ddimatos <[email protected]> * Update README with minor changes to sentences Signed-off-by: ddimatos <[email protected]> * Update the typo IMD to IMS Signed-off-by: ddimatos <[email protected]> * Various updates, see commit Signed-off-by: ddimatos <[email protected]> * Fixed zos level and cleaned up doc Signed-off-by: ddimatos <[email protected]> * Corrected a link Signed-off-by: ddimatos <[email protected]> --------- Signed-off-by: Dipti <[email protected]> Signed-off-by: ddimatos <[email protected]> Co-authored-by: Abhirami H <[email protected]> Co-authored-by: Dipti <[email protected]> Co-authored-by: Dipti <[email protected]> Co-authored-by: Abhirami H <[email protected]> Co-authored-by: Sergio Saucedo <[email protected]>
1 parent f620990 commit 473140e

40 files changed

+2005
-495
lines changed

.ansible.lint

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
################################################################################
2+
# Copyright (c) IBM Corporation 2024, 2025
3+
################################################################################
4+
# For additonal doc, see https://ansible.readthedocs.io/projects/lint/configuring/
5+
exclude_paths:
6+
- .tar.gz
7+
- __pycache__/
8+
- .ansible-lint
9+
- .cache/
10+
- .DS_Store
11+
- .git/
12+
- .github/
13+
- .gitignore
14+
- .python-version
15+
- .pytest_cache/
16+
- .vscode/
17+
- Jenkinsfile
18+
- ac
19+
- ansible.cfg
20+
- changelogs/
21+
- collections/
22+
- docs/
23+
- importer_result.json
24+
- scripts/
25+
- test_config.yml
26+
- tests/*.ini
27+
- tests/*.py
28+
- tests/.pytest_cache
29+
- tests/__pycache__
30+
- tests/functional
31+
- tests/helpers
32+
- tests/requirements.txt
33+
- tests/unit
34+
- tests/sanity/ignore-2.9.txt
35+
- tests/sanity/ignore-2.10.txt
36+
- tests/sanity/ignore-2.11.txt
37+
- tests/sanity/ignore-2.12.txt
38+
- tests/sanity/ignore-2.13.txt
39+
- tests/sanity/ignore-2.14.txt
40+
- venv*
41+
- ansible_collections/
42+
- tests/ims-collection-sample.yaml
43+
- ./*.log
44+
parseable: true
45+
quiet: false
46+
use_default_rules: true
47+
verbosity: 1
48+
# Offline mode disables installation of requirements.yml and schema refreshing often
49+
# found in project_root/collections/requirements.yml.
50+
offline: true

CHANGELOG.rst

Lines changed: 47 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,49 @@ ibm.ibm_zos_ims Release Notes
44

55
.. contents:: Topics
66

7+
v1.3.1
8+
======
9+
10+
Release Summary
11+
---------------
12+
13+
Release Date: '2023-03-31'
14+
This changelog describes all changes made to the modules and plugins included in this collection.
15+
For additional details such as required dependencies and availability review
16+
the collections `release notes <https://ibm.github.io/z_ansible_collections_doc/ibm_zos_ims/docs/source/release_notes.html>`__
17+
18+
Major Changes
19+
-------------
20+
- Compatibility to the latest dependencies versions
21+
22+
- Support for z/OS core v1.10 or later.
23+
- Support for Python v3.11 or later.
24+
- Support for ZOAU v1.3.0 or later.
25+
- Support for Ansible 2.15 or later.
26+
27+
v1.3.0
28+
======
29+
30+
Release Summary
31+
---------------
32+
33+
Release Date: '2023-03-31'
34+
This changelog describes all changes made to the modules and plugins included in this collection.
35+
For additional details such as required dependencies and availability review
36+
the collections `release notes <https://ibm.github.io/z_ansible_collections_doc/ibm_zos_ims/docs/source/release_notes.html>`__
37+
38+
39+
Major Changes
40+
-------------
41+
- Added new module 'ims_ddl'
42+
- Added new member dfsdf_member in the ims_catalog_populate and ims_catalog_purge modules.
43+
- The DFSDFxxx member is in the IMS.PROCLIB data set where the CATALOG section is defined.
44+
- Documentation update, minor updates to compression parameter in the ims_acbgen module where PRECOMP,POSTCOMP, in any combination, cause the required in-place compression.
45+
- The choices are not mutually exclusive -- PRECOMP or POSTCOMP or PRECOMP,POSTCOMP can be used.
46+
- Improved test and ansible-sanity coverage.
47+
- Subset of the test cases were updated to support for Ansible 2.15.
48+
- Additional support for test cases in ims_catalog_populate and ims_catalog_purge modules to support dfsdf_member parameter.
49+
- This update also has updated prerequisites for Ansible 2.14 or newer and ZOAU 1.2.2 or newer but prior to version 1.3.
750

851
v1.2.0
952
======
@@ -12,10 +55,9 @@ Release Summary
1255
---------------
1356

1457
Release Date: '2023-03-31'
15-
This changelog describes all changes made to the modules and plugins included
16-
in this collection.
58+
This changelog describes all changes made to the modules and plugins included in this collection.
1759
For additional details such as required dependencies and availability review
18-
the collections `release notes <https://github.com/ansible-collections/ibm_zos_ims/blob/dev/docs/source/release_notes.rst>`__
60+
the collections `release notes <https://ibm.github.io/z_ansible_collections_doc/ibm_zos_ims/docs/source/release_notes.html>`__
1961

2062

2163
Major Changes
@@ -27,6 +69,7 @@ Major Changes
2769
- Fixed sanity test error for ims_dbdgen and ims_psbgen modules after the member_list argument type was updated to 'raw' from 'list' since the element type can either be str or key:value pair
2870
- Improved JSON keys for ims_command_utils to replace whitespaces with underscores to help make the output more parsable
2971

72+
.. _Release notes for v1.2.0
3073
v1.1.0
3174
======
3275

@@ -64,4 +107,4 @@ New Modules
64107
- ibm.ibm_zos_ims.ims_acb_gen - Generate IMS ACB
65108
- ibm.ibm_zos_ims.ims_command - Submit IMS Commands
66109
- ibm.ibm_zos_ims.ims_dbd_gen - Generate IMS DBD
67-
- ibm.ibm_zos_ims.ims_psb_gen - Generate IMS PSB
110+
- ibm.ibm_zos_ims.ims_psb_gen - Generate IMS PSB

README.md

Lines changed: 76 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ System programmers can automate IMS system management tasks while database admin
1010

1111
## Requirements
1212

13-
This collection has been tested against the following Ansible versions: >=2.14.0,<2.17.3.
13+
This collection is tested against the following Ansible versions: 2.15.0 or later
1414

1515
The collection requires the following on the managed node:
1616
- IBM z/OS IMS
1717
- IBM Open Enterprise SDK for Python
1818
- IBM Z Open Automation Utilities (ZOAU)
1919

20-
The control node requires the IBM z/OS core collection to be installed before installing the IMS collection. Please refer to the [IBM z/OS collections support matrix](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/resources/releases_maintenance.html#support-matrix) for specific version requirements.
20+
The control node requires the IBM z/OS core collection to be installed before installing the IMS collection. Refer to the [IBM z/OS Core collection requirements](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/collection-requirements.html) for specific version requirements.
2121

2222
## Installation
2323

@@ -29,7 +29,7 @@ ansible-galaxy collection install ibm.ibm_zos_ims
2929

3030
You can also include it in a requirements.yml file and install it with `ansible-galaxy collection install -r requirements.yml`, using the format:
3131

32-
```yaml
32+
```sh
3333
collections:
3434
- name: ibm.ibm_zos_ims
3535
```
@@ -40,10 +40,50 @@ Note that if you install the collection from Ansible Galaxy, it will not be upgr
4040
ansible-galaxy collection install ibm.ibm_zos_ims --upgrade
4141
```
4242

43-
You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version 1.2.0:
43+
You can also install a specific version of the collection, for example, if you need to install a different version. Use the following syntax to install version 1.0.0:
44+
45+
```sh
46+
ansible-galaxy collection install ibm.ibm_zos_ims:1.1.0
47+
```
48+
49+
You can also install a beta version of the collection. A beta version is only available on Galaxy and is only supported by the community until it is promoted to General Availability (GA). Use the following syntax to install a beta version:
50+
51+
```sh
52+
ansible-galaxy collection install ibm.ibm_zos_ims:1.1.0-beta.1
53+
```
54+
55+
<br/>As part of the installation, the collection [requirements](#Requirements) must be made available to Ansible through the use of environment variables. The preferred configuration is to place the environment variables in `group_vars` and `host_vars`, you can find examples of this configuration under any [playbook project](https://github.com/IBM/z_ansible_collections_samples).
56+
57+
<br/>If you are testing a configuration, it can be helpful to set the environment variables in a playbook, for an example to review, refer [Discussions](https://github.com/ansible-collections/ibm_zos_core/discussions/657).
58+
59+
<br/>To learn more about the ZOAU Python wheel installation method, review the [documentation](https://www.ibm.com/docs/en/zoau/1.3.x?topic=installing-zoau#python-wheel-installation-method).
60+
61+
<br/>If the wheel is installed using the `--target` option, it will install the package into the specified target directory. The environment variable `PYTHONPATH` will have to be configured to where the packages is installed, e.g; `PYTHONPATH: /usr/zoau/wheels`. Using `--target` is recommended, else the wheel will be installed in Python's home directory which may not have write permissions or persist
62+
after an update.
63+
64+
<br/>If the wheel is installed using the `--user` option, it will install the package into the user directory. The environment variable `PYTHONPATH` will have to be configured to where the packages is installed, e.g; `PYTHONPATH: /u/user`.
65+
66+
<br/>Environment variables:
4467

4568
```sh
46-
ansible-galaxy collection install ibm.ibm_zos_ims:1.2.0
69+
PYZ: "path_to_python_installation_on_zos_target"
70+
ZOAU: "path_to_zoau_installation_on_zos_target"
71+
ZOAU_PYTHON_LIBRARY_PATH: "path_to_zoau_wheel_installation_directory"
72+
73+
ansible_python_interpreter: "{{ PYZ }}/bin/python3"
74+
75+
environment_vars:
76+
_BPXK_AUTOCVT: "ON"
77+
ZOAU_HOME: "{{ ZOAU }}"
78+
PYTHONPATH: "{{ ZOAU_PYTHONPATH }}"
79+
LIBPATH: "{{ ZOAU }}/lib:{{ PYZ }}/lib:/lib:/usr/lib:."
80+
PATH: "{{ ZOAU }}/bin:{{ PYZ }}/bin:/bin:/var/bin"
81+
_CEE_RUNOPTS: "FILETAG(AUTOCVT,AUTOTAG) POSIX(ON)"
82+
_TAG_REDIR_ERR: "txt"
83+
_TAG_REDIR_IN: "txt"
84+
_TAG_REDIR_OUT: "txt"
85+
LANG: "C"
86+
PYTHONSTDINENCODING: "cp1047"
4787
```
4888

4989
## Use Cases
@@ -100,36 +140,55 @@ ansible-galaxy collection install ibm.ibm_zos_ims:1.2.0
100140

101141
## Testing
102142

143+
All releases will meet the following test criteria.
144+
145+
* 100% success for [Functional](https://github.com/ansible-collections/ibm_zos_ims/tree/dev/tests/functional) tests.
146+
* 100% success for [Unit](https://github.com/ansible-collections/ibm_zos_ims/tree/dev/tests/units) tests.
147+
* 100% success for [Sanity](https://docs.ansible.com/ansible/latest/dev_guide/testing/sanity/index.html#all-sanity-tests) tests as part of [ansible-test](https://docs.ansible.com/ansible/latest/dev_guide/testing.html#run-sanity-tests).
148+
* 100% success for [ansible-lint](https://ansible.readthedocs.io/projects/lint/) allowing only false.
149+
103150
This release of the collection was tested with the following dependencies.
104151

105-
- ansible-core v2.17.x
152+
- ansible-core v2.15.x
106153
- Python 3.13.x
107154
- IBM Open Enterprise SDK for Python 3.11.x
108-
- IBM Z Open Automation Utilities (ZOAU) 1.2.x
109-
- z/OS V2R5
155+
- IBM Z Open Automation Utilities (ZOAU) 1.3.x
156+
- z/OS V2R5 or later
110157

111158
## Contributing
112159

113-
We are not currently accepting community contributions. However, we encourage you to open git issues for bugs, comments or feature requests.
160+
This community is not currently accepting contributions. However, we encourage you to open git issues for bugs, comments or feature requests.
114161

115162
Review this content periodically to learn when and how to make contributions in the future. For the latest information on open issues, see: [git issues](https://github.com/ansible-collections/ibm_zos_ims/issues).
116163

164+
## Communication
165+
166+
If you would like to communicate with this community, you can do so through the following options.
167+
168+
* GitHub [discussions](https://github.com/ansible-collections/ibm_zos_ims/discussions).
169+
* GitHub [issues](https://github.com/ansible-collections/ibm_zos_ims/issues/new/choose).
170+
* [Ansible Forum](https://forum.ansible.com/), please use the `zos` tag to ensure proper awareness.
171+
* Discord [System Z Enthusiasts](https://discord.gg/sze) room `ansible`.
172+
* Matrix general usage questions [room](https://matrix.to/#/#users:ansible.com).
173+
117174
## Support
118175

119-
As Red Hat Ansible Certified Content, this collection is entitled to support through Ansible Automation Platform (AAP). After creating a Red Hat support case, if it is determined the issue belongs to IBM, Red Hat will instruct you to create an IBM support case and share the case number with Red Hat so that a collaboration can begin between Red Hat and IBM.
176+
As Red Hat Ansible [Certified Content](https://catalog.redhat.com/software/search?target_platforms=Red%20Hat%20Ansible%20Automation%20Platform), this collection is entitled to [support](https://access.redhat.com/support/) through [Ansible Automation Platform](https://www.redhat.com/en/technologies/management/ansible) (AAP). After creating a Red Hat support case, if it is determined the issue belongs to IBM, Red Hat will instruct you to create an [IBM support case](https://www.ibm.com/mysupport/s/createrecord/NewCase) and share the case number with Red Hat so that a collaboration can begin between Red Hat and IBM.
177+
178+
<br/>If a support case cannot be opened with Red Hat and the collection has been obtained either from [Galaxy](https://galaxy.ansible.com/ui/) or [GitHub](https://github.com/ansible-collections/ibm_zos_core), there is community support available at no charge. Community support is limited to the collection; community support does not include any of the Ansible Automation Platform components, [IBM Z Open Automation Utilities](https://www.ibm.com/docs/en/zoau), [IBM Open Enterprise SDK for Python](https://www.ibm.com/products/open-enterprise-python-zos) or [ansible-ims](https://github.com/ansible/ansible).
179+
180+
<br/>The current supported versions of this collection can be found listed under the [release section](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_ims/docs/source/release_notes.html).
120181

121182
## Release Notes and Roadmap
122183

123-
Release notes and changelogs are maintained in the [documentation](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_ims/docs/source/release_notes.html).
184+
For the collection's cumulative, refer [release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_ims/docs/source/release_notes.html) are an easy way to review changes. The collection [Life Cycle](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_ims/docs/source/life-cycle_ims.html) also referred to as the Roadmap contains changelog details, support dates and the current level of support
185+
for each collection. For a complete guide to support, review the **Ansible for IBM Z** [Collection Life Cycles](https://ibm.github.io/z_ansible_collections_doc/collections_content/collection-life-cycles.html#life-cycles).
124186

125187
## Related Information
126188

127-
For guides and reference information, please visit:
128-
- [IBM z/OS collections documentation](https://ibm.github.io/z_ansible_collections_doc/index.html)
129-
- [Ansible sample playbooks using the z/OS IMS collection](https://github.com/IBM/z_ansible_collections_samples/tree/main/zos_subsystems/ims)
189+
Example playbooks and use cases can be be found in the [Ansible sample playbooks using the z/OS IMS collection](https://github.com/IBM/z_ansible_collections_samples/tree/main/zos_subsystems/ims). For supplemental content on getting started with Ansible, architecture and use cases, refer to [IBM z/OS collections documentation](https://ibm.github.io/z_ansible_collections_doc/index.html).
130190

131191
## License Information
132192

133-
© Copyright IBM Corporation 2025
134-
135-
This collection is licensed under [Apache License, Version 2.0](https://opensource.org/licenses/Apache-2.0).
193+
Some portions of this collection are licensed under [GNU General Public License, Version 3.0](https://opensource.org/licenses/GPL-3.0), and other portions of this collection are licensed under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
194+
See individual files for applicable licenses.

changelogs/changelog.yaml

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ releases:
101101
\n"
102102
fragments:
103103
- v1.3.0_summary.yml
104-
release_date: '2024-04-10'
104+
release_date: '2024-04-10'
105105
1.3.0-beta.1:
106106
changes:
107107
major_changes:
@@ -120,5 +120,13 @@ releases:
120120
fragments:
121121
- v1.3.0-beta1_summary.yml
122122
release_date: '2023-12-15'
123-
124-
123+
1.3.1:
124+
changes:
125+
release_summary: "Release Date: '2025-08-08'\nThis changelog describes all changes
126+
made to the modules and plugins included\nin this collection.\nFor additional
127+
details such as required dependencies and availability review\nthe collections
128+
`release notes <https://github.com/ansible-collections/ibm_zos_ims/blob/dev/docs/source/release_notes.rst>`__
129+
\n"
130+
fragments:
131+
- v1.3.1_summary.yml
132+
release_date: '2023-08-08'

docs/source/life-cycle.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
.. ...........................................................................
2+
.. © Copyright IBM Corporation 2025 .
3+
.. File needs to be contributed by a collection, likely the ref's won't work
4+
.. since the source will be in another, so need to create an external link.
5+
.. ...........................................................................
6+
7+
==========
8+
Life cycle
9+
==========
10+
11+
The IBM z/OS® IMS (``ibm_zos_ims``) collection is developed and released on a flexible release cycle. Occasionally, the cycle may be extended to properly implement and test larger
12+
changes before a new release is made available.
13+
14+
Product life cycle
15+
==================
16+
17+
Review this matrix for the status of the IBM z/OS IMS collection version,
18+
its critical dates, and which type of support it's currently eligible for.
19+
20+
+--------------+----------------+-----------------------+------------------+-------------------+-------------------------+
21+
| Version | Status | Changelogs | GA Date | EOL Date | Life Cycle Phase |
22+
+==============+================+=======================+==================+===================+=========================+
23+
| 1.3.x | Released | `1.3.x changelogs`_ | 10 April 2024 | 10 April 2026 | `Full support`_ |
24+
+--------------+----------------+-----------------------+------------------+-------------------+-------------------------+
25+
26+
.. .............................................................................
27+
.. Global Links
28+
.. .............................................................................
29+
.. _1.3.x changelogs:
30+
https://github.com/ansible-collections/ibm_zos_ims/blob/v1.3.1/CHANGELOG.rst
31+
.. _Full support:
32+
../../../collections_content/collection-life-cycles.html#life-cycle-phase

0 commit comments

Comments
 (0)