Skip to content

Commit c8992a7

Browse files
[Release] Merge staging-v1.10.0 into main (#1547)
* Updated Galaxy yaml * Updated meta * Fixed pyflakes errors * Added entry to .ansible-lint * Added zos_script example * Added opercmd documentation to zos_copy * Created summary fragment * Add new docs * Updated docs rst * added changelog * Added known issues into release notes * Updated notes * Added zos_copy msg * Modified known issues * Update support matrix with new dates and links Signed-off-by: ddimatos <[email protected]> * Updated README with formatting that galaxy will tollerate Signed-off-by: ddimatos <[email protected]> * Updated README with reduced content Signed-off-by: ddimatos <[email protected]> * Updated README to minimize content Signed-off-by: ddimatos <[email protected]> * Update README line breks so links render correctly Signed-off-by: ddimatos <[email protected]> * corrected date in changelog * Added corrections to release notes * Modified zos_operator docs --------- Signed-off-by: ddimatos <[email protected]> Co-authored-by: ddimatos <[email protected]>
1 parent 99d886a commit c8992a7

17 files changed

+188
-238
lines changed

.ansible-lint

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ exclude_paths:
2020
- changelogs/
2121
- collections/
2222
- docs/
23+
- importer_result.json
2324
- scripts/
2425
- test_config.yml
2526
- tests/*.ini

CHANGELOG.rst

Lines changed: 3 additions & 174 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 56 additions & 49 deletions
Large diffs are not rendered by default.

changelogs/changelog.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,20 @@ releases:
7878
name: zos_tso_command
7979
namespace: ''
8080
release_date: '2022-06-07'
81+
1.10.0:
82+
changes:
83+
release_summary: 'Release Date: ''2024-06-11''
84+
85+
This changelog describes all changes made to the modules and plugins included
86+
87+
in this collection. The release date is the date the changelog is created.
88+
89+
For additional details such as required dependencies and availability review
90+
91+
the collections `release notes <https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html>`__'
92+
fragments:
93+
- v1.10.0_summary.yml
94+
release_date: '2024-06-11'
8195
1.10.0-beta.1:
8296
changes:
8397
breaking_changes:
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
release_summary: |
2+
Release Date: '2024-06-11'
3+
This changelog describes all changes made to the modules and plugins included
4+
in this collection. The release date is the date the changelog is created.
5+
For additional details such as required dependencies and availability review
6+
the collections `release notes <https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html>`__

docs/source/modules/zos_copy.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -815,6 +815,10 @@ Notes
815815

816816
Beginning in version 1.8.x, zos_copy will no longer attempt to correct a copy of a data type member into a PDSE that contains program objects. You can control this behavior using module option ``executable`` that will signify an executable is being copied into a PDSE with other executables. Mixing data type members with program objects will result in a (FSUM8976,./zos_copy.html) error.
817817

818+
It is the playbook author or user's responsibility to ensure they have appropriate authority to the RACF FACILITY resource class. A user is described as the remote user, configured either for the playbook or playbook tasks, who can also obtain escalated privileges to execute as root or another user.
819+
820+
To use this module, you must define the RACF FACILITY class profile and allow READ access to RACF FACILITY profile MVS.MCSOPER.ZOAU. If your system uses a different security product, consult that product's documentation to configure the required security classes.
821+
818822

819823

820824
See Also

docs/source/modules/zos_operator.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ cmd
3333

3434
For example, change the command "...,P='DSN3EPX,-DBC1,S'" to "...,P=''DSN3EPX,-DBC1,S'' ".
3535

36+
If the command contains any special characters ($, &, etc), they must be escaped using double backslashes like \\\\\\$.
37+
38+
For example, to display job by job name the command would be ``cmd:"\\$dj''HELLO''"``
39+
3640
| **required**: True
3741
| **type**: str
3842

docs/source/modules/zos_script.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,12 @@ Examples
275275
cmd: ./scripts/PROGRAM
276276
removes: /u/user/pgm_input.txt
277277

278+
- name: Run a shell script on the remote system
279+
zos_script:
280+
cmd: ./scripts/program.sh
281+
executable: /bin/sh
282+
remote_src: true
283+
278284

279285

280286

docs/source/release_notes.rst

Lines changed: 65 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
Releases
77
========
88

9-
Version 1.10.0-beta.1
10-
=====================
9+
Version 1.10.0
10+
==============
1111

1212
Major Changes
1313
-------------
@@ -95,6 +95,7 @@ It is intended to assist in updating your playbooks so this collection will cont
9595
Availability
9696
------------
9797

98+
* `Automation Hub`_
9899
* `Galaxy`_
99100
* `GitHub`_
100101

@@ -104,6 +105,68 @@ Requirements
104105
The IBM z/OS core collection has several dependencies, please review the `z/OS core support matrix`_ to understand both the
105106
controller and z/OS managed node dependencies.
106107

108+
Known Issues
109+
------------
110+
- ``zos_job_submit`` - when setting 'location' to 'local' and not specifying the from and to encoding, the modules defaults are not read leaving the file in its original encoding; explicitly set the encodings instead of relying on the default.
111+
- ``zos_job_submit`` - when submitting JCL, the response value returned for **byte_count** is incorrect.
112+
- ``zos_data_set`` - When data set creation fails, exception can throw a bad import error instead of data set creation error.
113+
- ``zos_copy`` - To use this module, you must define the RACF FACILITY class profile and allow READ access to RACF FACILITY profile MVS.MCSOPER.ZOAU. If your system uses a different security product, consult that product's documentation to configure the required security classes.
114+
- ``zos_job_submit``, ``zos_job_output``, ``zos_operator_action_query`` - encounters JSON decoding (DecodeError, TypeError, KeyError) errors when interacting with results that contain non-printable UTF-8 characters in the response. This will be addressed in **ZOAU version 1.3.2** and later.
115+
116+
- Some options to work around this known issue are:
117+
118+
- Specify that the ASA assembler option be enabled to instruct the assembler to use ANSI control characters instead of machine code control characters.
119+
- Ignore module errors by using **ignore_errors:true** for a specific playbook task.
120+
- If the error is resulting from a batch job, add **ignore_errors:true** to the task and capture the output into a registered variable to extract the
121+
job ID with a regular expression. Then use ``zos_job_output`` to display the DD without the non-printable character such as the DD **JESMSGLG**.
122+
- If the error is the result of a batch job, set option **return_output** to false so that no DDs are read which could contain the non-printable UTF-8 characters.
123+
124+
- In the past, choices could be defined in either lower or upper case. Now, only the case that is identified in the docs can be set, this is so that the collection can continue to maintain certified status.
125+
- Use of special characters (#, @, $, \- ) in different options like data set names and commands is not fully supported, some modules support them but is the user responsibility to escape them. Read each module documentation for further details.
126+
127+
128+
Version 1.9.1
129+
=============
130+
131+
Bugfixes
132+
--------
133+
134+
- ``zos_find`` - Option size failed if a PDS/E matched the pattern, now filtering on utilized size for a PDS/E is supported.
135+
- ``zos_mvs_raw`` - Option **tmp_hlq** when creating temporary data sets was previously ignored, now the option honors the High Level Qualifier for temporary data sets created during the module execution.
136+
137+
Availability
138+
------------
139+
140+
* `Automation Hub`_
141+
* `Galaxy`_
142+
* `GitHub`_
143+
144+
Requirements
145+
------------
146+
147+
The IBM z/OS core collection has several dependencies, please review the `z/OS core support matrix`_ to understand both the
148+
controller and z/OS managed node dependencies.
149+
150+
Known Issues
151+
------------
152+
153+
- ``zos_job_submit`` - when setting 'location' to 'local' and not specifying the from and to encoding, the modules defaults are not read leaving the file in its original encoding; explicitly set the encodings instead of relying on the default.
154+
- ``zos_job_submit`` - when submitting JCL, the response value returned for **byte_count** is incorrect.
155+
156+
- ``zos_job_submit``, ``zos_job_output``, ``zos_operator_action_query`` - encounters UTF-8 decoding errors when interacting with results that contain non-printable UTF-8 characters in the response. This has been addressed in this release and corrected with **ZOAU version 1.2.5.6** or later.
157+
158+
- If the appropriate level of ZOAU can not be installed, some options are to:
159+
160+
- Specify that the ASA assembler option be enabled to instruct the assembler to use ANSI control characters instead of machine code control characters.
161+
- Ignore module errors by using **ignore_errors:true** for a specific playbook task.
162+
- If the error is resulting from a batch job, add **ignore_errors:true** to the task and capture the output into a registered variable to extract the
163+
job ID with a regular expression. Then use ``zos_job_output`` to display the DD without the non-printable character such as the DD **JESMSGLG**.
164+
- If the error is the result of a batch job, set option **return_output** to false so that no DDs are read which could contain the non-printable UTF-8 characters.
165+
166+
- ``zos_data_set`` - An undocumented option **size** was defined in module **zos_data_set**, this has been removed to satisfy collection certification, use the intended and documented **space_primary** option.
167+
168+
- In the past, choices could be defined in either lower or upper case. Now, only the case that is identified in the docs can be set, this is so that the collection can continue to maintain certified status.
169+
107170
Version 1.9.0
108171
=============
109172

docs/source/resources/releases_maintenance.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,22 @@ currently supported.
2323
For example, if a collection releases with a minimum version of ``ansible-core`` 2.14.0 (Ansible 7.0) and later this
2424
enters into EOL, then a newer supported version of ``ansible-core`` (Ansible) must be selected. When choosing a newer
2525
``ansible-core`` (Ansible) version, review the `ansible-core support matrix`_ to select the appropriate dependencies.
26-
This is important to note, different releases of ``ansible-core`` can require newer controller and managed node
26+
This is important to note, different releases of ``ansible-core`` can require newer control node and managed node
2727
dependencies such as is the case with Python.
2828

29-
If the controller is Ansible Automation Platform (AAP), review the `Red Hat Ansible Automation Platform Life Cycle`_
29+
If the control node is Ansible Automation Platform (AAP), review the `Red Hat Ansible Automation Platform Life Cycle`_
3030
to select a supported AAP version.
3131

3232
For IBM product lifecycle information, you can search for products using a product name, version or ID. For example,
33-
to view IBM's **Open Enterprise SDK for Python** lifecycle, search on product ID `5655-PYT`_, and for **Z Open Automation Utilities**,
34-
search on product ID `5698-PA1`_.
33+
to view IBM's `Open Enterprise SDK for Python lifecycle`_, search on product ID `5655-PYT`_, and for
34+
`Z Open Automation Utilities lifecycle`_, search on product ID `5698-PA1`_.
3535

3636
Support Matrix
3737
==============
3838
+---------+----------------------------+---------------------------------------------------+---------------+---------------+
3939
| Version | Controller | Managed Node | GA | End of Life |
4040
+=========+============================+===================================================+===============+===============+
41-
| 1.10.x |- `ansible-core`_ >=2.15.x |- `z/OS`_ V2R4 - V2Rx | In preview | TBD |
41+
| 1.10.x |- `ansible-core`_ >=2.15.x |- `z/OS`_ V2R4 - V2Rx | 21 June 2024 | 21 June 2026 |
4242
| |- `Ansible`_ >=8.0.x |- `z/OS shell`_ | | |
4343
| |- `AAP`_ >=2.4 |- IBM `Open Enterprise SDK for Python`_ | | |
4444
| | |- IBM `Z Open Automation Utilities`_ >=1.3.0 | | |
@@ -88,8 +88,12 @@ Support Matrix
8888
https://www.ibm.com/support/knowledgecenter/en/SSLTBW_2.4.0/com.ibm.zos.v2r4.bpxa400/part1.htm
8989
.. _z/OS:
9090
https://www.ibm.com/docs/en/zos
91+
.. _Open Enterprise SDK for Python lifecycle:
92+
https://www.ibm.com/support/pages/lifecycle/search?q=5655-PYT
9193
.. _5655-PYT:
9294
https://www.ibm.com/support/pages/lifecycle/search?q=5655-PYT
95+
.. _Z Open Automation Utilities lifecycle:
96+
https://www.ibm.com/support/pages/lifecycle/search?q=5698-PA1
9397
.. _5698-PA1:
9498
https://www.ibm.com/support/pages/lifecycle/search?q=5698-PA1
9599
.. _ansible-core:

0 commit comments

Comments
 (0)