Skip to content

Commit 07a93b2

Browse files
ind1goGitHub Enterprise
ind1go
authored and
GitHub Enterprise
committed
Merge pull request #105 from CICS/feature/catalog
Merge Feature/catalog into main
2 parents 7408253 + 468e27c commit 07a93b2

File tree

182 files changed

+33397
-461
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

182 files changed

+33397
-461
lines changed

‎.gitignore‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,12 @@ docs/build/
55
__pycache__
66
venv*
77
.venv
8+
core
89
tests/output
910
ibm-ibm_zos_cics-*.tar.gz
1011
tests/integration/inventory
11-
tests/integration/variables/cmci.yml
12+
tests/integration/inventory_zos.yml
13+
tests/integration/variables/cmci.yml
14+
tests/integration/variables/provisioning.yml
15+
tests/integration/variables/utilities.yml
16+
tests/integration/variables/zos.yml

‎CHANGELOG.rst‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,105 @@ Bugfixes
3131

3232
- Allows CPSM Scope and Context to contain the following special characters '$', '@', and '#'
3333

34+
v1.1.0-beta.5
35+
=============
36+
37+
Release Summary
38+
---------------
39+
40+
This release contains new modules for starting and stopping standalone CICS regions. The ``csd`` module now supports executing a ``CSDUP`` script against an existing ``CSD`` data set.
41+
42+
Major Changes
43+
-------------
44+
45+
- A new ``state`` option for the ``csd`` module that alllows a user to supply a script as either a data set or a z/OS Unix file containing ``CSDUP`` commands
46+
- Data set modules now support a ``space_secondary`` option to specify size of the secondary extent
47+
- Return values for all data set modules now use ``data_set_organization`` to indicate the organization of the data set. The ``vsam`` field has been removed from the return structure.
48+
49+
New Modules
50+
-----------
51+
52+
- ibm.ibm_zos_cics.start_cics - Start a CICS region
53+
- ibm.ibm_zos_cics.stop_cics - Stop a CICS Region
54+
55+
v1.1.0-beta.4
56+
=============
57+
58+
Release Summary
59+
---------------
60+
61+
This release delivers new modules for provisioning the CICS auxiliary temporary storage data set, the CICS system definition data set, the CICS transient data intrapartition data set, the CICS auxiliary trace data sets and the CICS transaction dump data sets. This release also contains fixes to the CICS local request queue data set module and the CICS local catalog data set module.
62+
63+
Bugfixes
64+
--------
65+
66+
- Additional ``state`` input parameter option ``warm`` added to ``local_request_queue`` module
67+
- Behaviour of ``local_catalog`` and ``local_request_queue`` module with ``state`` set to ``initial`` updated to match documentation
68+
69+
New Modules
70+
-----------
71+
72+
- ibm.ibm_zos_cics.auxiliary_temp - Create and remove the CICS auxiliary temporary storage data set
73+
- ibm.ibm_zos_cics.csd - Create, remove, and manage the CICS CSD
74+
- ibm.ibm_zos_cics.intrapartition - Create and remove the CICS transient data intrapartition data set
75+
- ibm.ibm_zos_cics.trace - Allocate auxiliary trace data sets
76+
- ibm.ibm_zos_cics.transaction_dump - Allocate transaction dump data sets
77+
78+
v1.1.0-beta.3
79+
=============
80+
81+
Release Summary
82+
---------------
83+
84+
This release introduces changes to the global and local catalog modules by adding support for the ``region_data_sets`` and ``cics_data_sets`` defaults groups. This changes the way you specifiy the data set location for these modules. A new ``local_request_queue`` module is also included to support provisioning a local request queue data set.
85+
86+
Breaking Changes / Porting Guide
87+
--------------------------------
88+
89+
- Introduction of ``region_data_sets`` and ``cics_data_sets`` defaults group
90+
91+
New Modules
92+
-----------
93+
94+
- ibm.ibm_zos_cics.local_request_queue - Create and remove the CICS local request queue
95+
96+
v1.1.0-beta.2
97+
=============
98+
99+
Release Summary
100+
---------------
101+
102+
This release improves the return values for the ``global_catalog`` module, fixes bugs related to its input parameters, and includes a new ``local_catalog`` module for provisioning a local catalog data set.
103+
104+
Minor Changes
105+
-------------
106+
107+
- Return values for ``global_catalog`` - changes the values returned to include ``start_state``, ``end_state``, and ``executions``.
108+
109+
Bugfixes
110+
--------
111+
112+
- Input parameters for ``global_catalog`` failed when lowercase. Now these parameters are not case sensitive.
113+
- The ``changed`` flag did not always correspond with actions taken during the ``global_catalog`` execution. Now this flag represents if changes were made.
114+
115+
New Modules
116+
-----------
117+
118+
- ibm.ibm_zos_cics.local_catalog - Create, remove, and manage the CICS local catalog
119+
120+
v1.1.0-beta.1
121+
=============
122+
123+
Release Summary
124+
---------------
125+
126+
This release contains a new Global Catalog module
127+
128+
New Modules
129+
-----------
130+
131+
- ibm.ibm_zos_cics.global_catalog - Create and initialize CICS global catalog.
132+
34133
v1.0.5
35134
======
36135

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# (c) Copyright IBM Corp. 2020,2021
1+
# (c) Copyright IBM Corp. 2020,2023
22
# Developer guide
33

44
### Licensing

‎README.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The **IBM® z/OS® CICS® collection**, also represented as **ibm\_zos\_cics**
44
in this document, is part of the broader initiative to bring Ansible Automation to IBM Z® through the offering
55
**Red Hat® Ansible Certified Content for IBM Z®**. The **IBM z/OS CICS collection** supports management of CICS
6-
resources and definitions via the CMCI REST API provided by CICS.
6+
resources and definitions through the CMCI REST API provided by CICS as well as provisioning of standalone CICS regions.
77

88
This CICS collection works in conjunction with other Ansible collections for IBM Z,
99
such as the [IBM z/OS core collection](https://github.com/ansible-collections/ibm_zos_core).
@@ -38,7 +38,11 @@ For guides and reference, please review the [documentation](https://ibm.github.i
3838
The IBM CICS collection includes
3939
[modules](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_cics/docs/source/modules.html),
4040
[sample playbooks](https://github.com/IBM/z_ansible_collections_samples),
41-
and ansible-doc to automate tasks in CICS.
41+
and ansible-doc to:
42+
43+
- Automate tasks in CICS.
44+
- Provision or deprovision CICS regions.
45+
- Start or stop a CICS region.
4246

4347
## Contributing
4448

‎changelogs/.plugin-cache.yaml‎

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ plugins:
1111
inventory: {}
1212
lookup: {}
1313
module:
14+
auxiliary_temp:
15+
description: Create and remove the CICS auxiliary temporary storage data set
16+
name: auxiliary_temp
17+
namespace: ''
18+
version_added: 1.1.0-beta.4
1419
cmci_action:
1520
description: Perform actions on CICS and CICSPlex SM resources
1621
name: cmci_action
@@ -36,9 +41,54 @@ plugins:
3641
name: cmci_update
3742
namespace: ''
3843
version_added: 1.0.0
44+
csd:
45+
description: Create, remove, and manage the CICS CSD
46+
name: csd
47+
namespace: ''
48+
version_added: 1.1.0-beta.4
49+
global_catalog:
50+
description: Create, remove, and manage the CICS global catalog
51+
name: global_catalog
52+
namespace: ''
53+
version_added: 1.1.0-beta.1
54+
intrapartition:
55+
description: Create and remove the CICS transient data intrapartition data set
56+
name: intrapartition
57+
namespace: ''
58+
version_added: 1.1.0-beta.4
59+
local_catalog:
60+
description: Create, remove, and manage the CICS local catalog
61+
name: local_catalog
62+
namespace: ''
63+
version_added: 1.1.0-beta.2
64+
local_request_queue:
65+
description: Create and remove the CICS local request queue
66+
name: local_request_queue
67+
namespace: ''
68+
version_added: 1.1.0-beta.3
69+
start_cics:
70+
description: Start a CICS region
71+
name: start_cics
72+
namespace: ''
73+
version_added: 1.1.0-beta.5
74+
stop_cics:
75+
description: Stop a CICS Region
76+
name: stop_cics
77+
namespace: ''
78+
version_added: 1.1.0-beta.5
79+
trace:
80+
description: Allocate auxiliary trace data sets
81+
name: trace
82+
namespace: ''
83+
version_added: 1.1.0-beta.4
84+
transaction_dump:
85+
description: Allocate transaction dump data sets
86+
name: transaction_dump
87+
namespace: ''
88+
version_added: 1.1.0-beta.4
3989
netconf: {}
4090
shell: {}
4191
strategy: {}
4292
test: {}
4393
vars: {}
44-
version: 2.0.0
94+
version: 1.1.0-beta.5

‎changelogs/changelog.yaml‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,3 +85,104 @@ releases:
8585
fragments:
8686
- 2.0.0.yml
8787
release_date: '2024-05-08'
88+
1.1.0-beta.1:
89+
changes:
90+
release_summary: This release contains a new Global Catalog module
91+
fragments:
92+
- beta.yml
93+
modules:
94+
- description: Create and initialize CICS global catalog.
95+
name: global_catalog
96+
namespace: ''
97+
release_date: '2023-06-14'
98+
1.1.0-beta.2:
99+
changes:
100+
bugfixes:
101+
- Input parameters for ``global_catalog`` failed when lowercase. Now these parameters
102+
are not case sensitive.
103+
- The ``changed`` flag did not always correspond with actions taken during the
104+
``global_catalog`` execution. Now this flag represents if changes were made.
105+
minor_changes:
106+
- Return values for ``global_catalog`` - changes the values returned to include
107+
``start_state``, ``end_state``, and ``executions``.
108+
release_summary: This release improves the return values for the ``global_catalog``
109+
module, fixes bugs related to its input parameters, and includes a new ``local_catalog``
110+
module for provisioning a local catalog data set.
111+
fragments:
112+
- beta.yml
113+
modules:
114+
- description: Create, remove, and manage the CICS local catalog
115+
name: local_catalog
116+
namespace: ''
117+
release_date: '2023-07-20'
118+
1.1.0-beta.3:
119+
changes:
120+
breaking_changes:
121+
- Introduction of ``region_data_sets`` and ``cics_data_sets`` defaults group
122+
release_summary: 'This release introduces changes to the global and local catalog
123+
modules by adding support for the ``region_data_sets`` and ``cics_data_sets``
124+
defaults groups. This changes the way you specifiy the data set location for
125+
these modules. A new ``local_request_queue`` module is also included to support
126+
provisioning a local request queue data set. '
127+
fragments:
128+
- beta.yml
129+
modules:
130+
- description: Create and remove the CICS local request queue
131+
name: local_request_queue
132+
namespace: ''
133+
release_date: '2023-11-21'
134+
1.1.0-beta.4:
135+
changes:
136+
bugfixes:
137+
- Additional ``state`` input parameter option ``warm`` added to ``local_request_queue``
138+
module
139+
- Behaviour of ``local_catalog`` and ``local_request_queue`` module with ``state``
140+
set to ``initial`` updated to match documentation
141+
release_summary: This release delivers new modules for provisioning the CICS
142+
auxiliary temporary storage data set, the CICS system definition data set,
143+
the CICS transient data intrapartition data set, the CICS auxiliary trace
144+
data sets and the CICS transaction dump data sets. This release also contains
145+
fixes to the CICS local request queue data set module and the CICS local catalog
146+
data set module.
147+
fragments:
148+
- beta.yml
149+
modules:
150+
- description: Create and remove the CICS auxiliary temporary storage data set
151+
name: auxiliary_temp
152+
namespace: ''
153+
- description: Create, remove, and manage the CICS CSD
154+
name: csd
155+
namespace: ''
156+
- description: Create and remove the CICS transient data intrapartition data set
157+
name: intrapartition
158+
namespace: ''
159+
- description: Allocate auxiliary trace data sets
160+
name: trace
161+
namespace: ''
162+
- description: Allocate transaction dump data sets
163+
name: transaction_dump
164+
namespace: ''
165+
release_date: '2024-02-05'
166+
1.1.0-beta.5:
167+
changes:
168+
major_changes:
169+
- A new ``state`` option for the ``csd`` module that alllows a user to supply
170+
a script as either a data set or a z/OS Unix file containing ``CSDUP`` commands
171+
- Data set modules now support a ``space_secondary`` option to specify size
172+
of the secondary extent
173+
- Return values for all data set modules now use ``data_set_organization`` to
174+
indicate the organization of the data set. The ``vsam`` field has been removed
175+
from the return structure.
176+
release_summary: This release contains new modules for starting and stopping
177+
standalone CICS regions. The ``csd`` module now supports executing a ``CSDUP``
178+
script against an existing ``CSD`` data set.
179+
fragments:
180+
- beta.yaml
181+
modules:
182+
- description: Start a CICS region
183+
name: start_cics
184+
namespace: ''
185+
- description: Stop a CICS Region
186+
name: stop_cics
187+
namespace: ''
188+
release_date: '2024-03-27'

‎doc-requirements.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# (c) Copyright IBM Corp. 2020,2023
1+
# (c) Copyright IBM Corp. 2020,2024
22
# Apache License, Version 2.0 (see https://opensource.org/licenses/Apache-2.0)
33
-r dev-requirements.txt
44

55
ansible-doc-extractor==0.1.11
66
Sphinx==6.2.1
7-
sphinx-rtd-theme==1.2.2
7+
sphinx-rtd-theme==1.2.2

‎docs/README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Docs generated under source/modules are automatically generated.
2+
Other .rst files have to be manually updated
3+
If you are running in a devcontainer, you can run 'update-docs.py' to generate updates to the modules .rst documents
4+
Otherwise, you will need to run 'pip install -r /workspace/collections/ansible_collections/ibm/ibm_zos_cics/doc-requirements.txt'
5+
Then run, 'apt-get updates' followed by 'apt-get install make' before you can run 'update-docs.py'

‎docs/ansible-doc-extractor-collections.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# (c) Copyright IBM Corp. 2020,2021
1+
# (c) Copyright IBM Corp. 2020,2024
22
# Apache License, Version 2.0 (see https://opensource.org/licenses/Apache-2.0)
33
from __future__ import absolute_import, division, print_function
44
__metaclass__ = type
@@ -7,7 +7,7 @@
77
import os
88

99
# This needs to be set before the imports get evaluated!
10-
os.environ['ANSIBLE_COLLECTIONS_PATHS'] = os.path.abspath('../../../..')
10+
os.environ['ANSIBLE_COLLECTIONS_PATH'] = os.path.abspath('../../../..')
1111

1212
from ansible_doc_extractor.cli import render_docs
1313

@@ -22,4 +22,4 @@
2222
)
2323
)
2424
)
25-
sys.exit(render_docs('source/modules', modules, open('templates/module.rst.j2')))
25+
sys.exit(render_docs('source/modules', modules, open('templates/module.rst.j2'), False))

‎docs/ansible_content.rst‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,28 @@
11
.. ...........................................................................
2-
.. © Copyright IBM Corporation 2020,2021 .
2+
.. © Copyright IBM Corporation 2020,2024 .
33
.. ...........................................................................
44
55
=========
66
z/OS CICS
77
=========
88

99
The **IBM® z/OS® CICS® collection**, also represented as
10-
ibm_zos_cics in this document, is part of the broader
10+
ibm_zos_cics in this document, is part of the broader
1111
initiative to bring Ansible® Automation to IBM Z® through the offering
1212
**Red Hat® Ansible Certified Content for IBM Z**.
1313

14-
The **IBM® z/OS® CICS® collection** supports automation tasks that can
15-
define, install, and perform actions on CICS definitions and resources such as
16-
creating a PROGRAM definition, installing and updating it, and deleting the
17-
definition.
14+
The **IBM® z/OS® CICS® collection** provides modules for automation tasks that
15+
perform operations on CICS and CICSPlex SM resources and definitions, for example,
16+
creating and installing a PROGRAM definition, then updating or deleting the definition.
17+
These modules interact with the `CMCI REST API`_ of the CICS® management client
18+
interface (CMCI) for system management.
1819

19-
The Ansible modules in this collection are written in Python and interact with
20-
the `CMCI REST API`_ of the CICS® management client interface (CMCI) for system
21-
management.
20+
The **IBM® z/OS® CICS® collection** also provides modules for provisioning and managing
21+
CICS TS data sets and utilities. You can use these Ansible modules to create automation
22+
tasks that provision or deprovision a CICS region and tasks for CICS startup and
23+
shutdown.
24+
25+
The Ansible modules in this collection are written in Python.
2226

2327
.. _CMCI REST API:
2428
https://www.ibm.com/docs/en/cics-ts/latest?topic=cmci-how-it-works-rest-api

0 commit comments

Comments
 (0)