Skip to content

Commit c13d74e

Browse files
authored
Merge pull request #4147 from zowe/dataset-appendix
Create appendix for list of zowe's datasets
2 parents 7d5214a + 78bf903 commit c13d74e

36 files changed

+585
-395
lines changed

docs/appendix/server-datasets.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Server Datasets Reference
2+
3+
Zowe includes a number of files that are stored in the various data sets. See the following tables for the storage requirements and purposes.
4+
5+
## Runtime Datasets
6+
7+
The following datasets comprise the runtime, read-only dataset content that can be used by multiple Zowe instances of the same version. These are either delivered by an [SMP/E install](../user-guide/install-zowe-smpe.md), or by running `zwe install` when using [the z/OS convenience build of the Zowe servers](../user-guide/install-zowe-zos-convenience-build.md).
8+
9+
Library DDNAME | Member Type | Target Volume | Type | Org | RECFM | LRECL | No. of 3390 Trks | No. of DIR Blks
10+
---|---|---|---|---|---|---|---|---
11+
SZWESAMP | Samples | ANY | U | PDSE | FB | 80 | 15 | 5
12+
SZWEAUTH | Zowe APF Load Modules | ANY | U | PDSE | U | 0 | 15 | N/A
13+
SZWEEXEC | CLIST copy utilities | ANY | U | PDSE | FB | 80 | 15 | 5
14+
SZWELOAD | Executable utilities library | ANY | U | PDSE | U | 0 | 15 | N/A
15+
16+
The `SZWESAMP` data set contains the following members.
17+
18+
Member name | Type | Purpose
19+
---|---|---
20+
ZWECSRVS | JCL | Removes the VSAM data set for the Caching Service
21+
ZWECSVSM | JCL | Creates the VSAM data set for the Caching Service
22+
ZWEGENER | JCL | Generates JCL templates to configure Zowe
23+
ZWEIACF | JCL | Defines security permits for ACF2
24+
ZWEIACFZ | JCL | Creates the ACF2 Zowe resource class
25+
ZWEIAPF | JCL | Set APF for the required datasets
26+
ZWEIAPF2| JCL | Set APF for the required datasets
27+
ZWEIKRA1 | JCL | Defines ACF2 key ring and certificates
28+
ZWEIKRA2 | JCL | Defines ACF2 key ring and certificates
29+
ZWEIKRA3 | JCL | Defines ACF2 key ring and certificates
30+
ZWEIKRR1 | JCL | Defines RACF key ring and certificates
31+
ZWEIKRR2 | JCL | Defines RACF key ring and certificates
32+
ZWEIKRR3 | JCL | Defines RACF key ring and certificates
33+
ZWEIKRT1 | JCL | Defines TSS key ring and certificates
34+
ZWEIKRT2 | JCL | Defines TSS key ring and certificates
35+
ZWEIKRT3 | JCL | Defines TSS key ring and certificates
36+
ZWEIMVS | JCL | Creates datasets used by a Zowe instance
37+
ZWEIMVS2 | JCL | Creates the load library (expected to be APF)
38+
ZWEINSTL | JCL | Creates and copies basic installation datasets and members
39+
ZWEIRAC | JCL | Defines security permits for RACF
40+
ZWEIRACZ | JCL | Creates the RACF Zowe resource class
41+
ZWEISTC | JCL | Adds `PROCLIB` members
42+
ZWEITSS | JCL | Defines security permits for TSS
43+
ZWEITSSZ | JCL | Creates the TSS Zowe resource class
44+
ZWEKRING | JCL | Defines key ring and certificates
45+
ZWENOKRA | JCL | Removes key ring and certificates for ACF2
46+
ZWENOKRR | JCL | Removes key ring and certificates for RACF
47+
ZWENOKRT | JCL | Removes key ring and certificates for TSS
48+
ZWENOKYR | JCL | Removes key ring and certificates
49+
ZWENOSEC | JCL | Defines security permits
50+
ZWERMVS | JCL | Removes datasets used by a Zowe instance
51+
ZWERMVS2 | JCL | Removes the APF load library
52+
ZWERSTC | JCL | Removes `PROCLIB` members
53+
ZWESASTC | JCL | Starts the Zowe Auxiliary server used by Cross memory server
54+
ZWESECKG | JCL | Sample program which generates a secret key for the PKCS#11 token
55+
ZWESECUR | JCL | Defines security permits for Zowe
56+
ZWESIPRG | Commands | Console commands to APF authorize the cross memory server load library
57+
ZWESIP00 | PARMLIB | Member for the cross memory server
58+
ZWESISCH | PPT | Defines entries required by Cross memory server and its Auxiliary address spaces to run in Key(4)
59+
ZWESISTC | JCL | Starts the Zowe Cross memory server
60+
ZWESLSTC | JCL | Starts the Zowe
61+
62+
The `SZWEAUTH` data set is a load library containing the following members.
63+
64+
Member name | Purpose
65+
---|---
66+
ZWELNCH | The Zowe launcher that controls the startup, restart and shutdown of Zowe's address spaces
67+
ZWESIS01 | Load module for the cross memory server
68+
ZWESAUX | Load module for the cross memory server's auxiliary address space
69+
ZWESISDL | ZIS Dynamic Plug-in
70+
71+
The `SZWEEXEC` data set contains few utilities used by Zowe.
72+
73+
The `SZWELOAD` data set contains config manager for REXX.
74+
75+
## Custom Datasets
76+
77+
The following datasets are designed to be used by a single Zowe instance. These are created during post-install setup, and include temporary content as well as datasets used for extensions of Zowe.
78+
79+
Library DDNAME | Member Type | zowe.yaml | Target Volume | Type | Org | RECFM | LRECL | No. of 3390 Trks | No. of DIR Blks
80+
---|---|---|---|---|---|---|---|---|--
81+
CUST.PARMLIB | PARM Library Members | zowe.setup.dataset.parmlib | ANY | U | PDSE | FB | 80 | 15 | 5
82+
CUST.JCLLIB | JCL Members | zowe.setup.dataset.jcllib | ANY | U | PDSE | FB | 80 | 15 | 5
83+
CUST.ZWESAPL | CLIST copy utilities | zowe.setup.dataset.authPluginLib | ANY | U | PDSE | U | 0 | 15 | N/A

docs/user-guide/address-storage-requirements.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55

66
Ensure that you have sufficient storage depending on the installation method. Review the storage requirements according to your installation method as presented in this article.
77

8-
## Installing with SMP/E
8+
## Installing Zowe Server Rutntime
99

10-
Before installing Zowe SMP/E, review the [DASD storage requirements](../user-guide/install-zowe-smpe-overview.md#dasd-storage-requirements).
10+
Before installing Zowe, review the reference for [Zowe's server datasets](../appendix/server-datasets.md)
1111

12-
## Installing Zowe runtime from a convenience build
12+
### Installing with SMP/E
1313

14-
Before installing Zowe runtime from a convenience build, see the [storage requirements associated with MVS datasets](../user-guide/install-zowe-zos-convenience-build.md#about-the-mvs-data-sets).
14+
Additionally, when installing Zowe with SMP/E, review the [DASD storage requirements](../user-guide/install-zowe-smpe-overview.md#dasd-storage-requirements).
1515

16-
### Memory requirements for API Mediation Layer
16+
## Memory requirements for API Mediation Layer
1717

1818
Zowe API ML components have following memory requirements:
1919

docs/user-guide/initialize-mvs-datasets.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Review this article to learn about how to intialize Zowe custom MVS data sets by
88

99
## Introduction
1010

11-
During the installation of Zowe, three data sets `SZWEAUTH`, `SZWESAMP` and `SZWEEXEC` are created and populated with members copied across from the Zowe installation files. The contents of these data sets represent the original files that were provided as part of the Zowe installation and are not meant to be modified.
11+
During the installation of Zowe, runtime datasets are created. The contents of these data sets represent the original files that were provided as part of the Zowe installation and are not meant to be modified. [The list of these datasets can be reviewed in the dataset appendix](../appendix/server-datasets.md).
1212

1313
For modification and execution, it is necessary to create custom data sets by using the `zwe init mvs` command. For detailed information about this command, see the [`zwe init mvs` command reference](../appendix/zwe_server_command_reference/zwe/init/zwe-init-mvs).
1414

@@ -25,13 +25,7 @@ zowe:
2525
authPluginLib: IBMUSER.ZWE.CUST.ZWESAPL
2626
```
2727

28-
Review the following table for storage requirements for the three data sets:
29-
30-
Library DDNAME | Member Type | zowe.yaml | Target Volume | Type | Org | RECFM | LRECL | No. of 3390 Trks | No. of DIR Blks
31-
---|---|---|---|---|---|---|---|---|--
32-
CUST.PARMLIB | PARM Library Members | zowe.setup.dataset.parmlib | ANY | U | PDSE | FB | 80 | 15 | 5
33-
CUST.JCLLIB | JCL Members | zowe.setup.dataset.jcllib | ANY | U | PDSE | FB | 80 | 15 | 5
34-
CUST.ZWESAPL | CLIST copy utilities | zowe.setup.dataset.authPluginLib | ANY | U | PDSE | U | 0 | 15 | N/A
28+
Refer to the appendix for the [list of datasets](../appendix/server-datasets.md#custom-datasets) that will be created in this step.
3529

3630
## Procedure to initialize Zowe custom data sets
3731

docs/user-guide/install-zowe-smpe-overview.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -230,11 +230,7 @@ The following figures describe the target and distribution libraries and file sy
230230

231231
**Note:** These target libraries are not required for the initial FMID install of Zowe SMP/E but will be required for subsequent SYSMODS so are included here for future reference.
232232

233-
Library DDNAME | Member Type | Target Volume | Type | Org | RECFM | LRECL | No. of 3390 Trks | No. of DIR Blks
234-
---|---|---|---|---|---|---|---|---
235-
SZWEAUTH | APF Load Modules | ANY | U | PDSE | U | 0 | 15 | N/A
236-
SZWESAMP | Samples | ANY | U | PDSE | FB | 80 | 15 | 5
237-
SZWELOAD | Load Modules | ANY | U | PDSE | U | 0 | 30 | N/A
233+
Review the list of Zowe's runtime datasets in the [Server Dataset Appendix](../appendix/server-datasets.md#runtime-datasets).
238234

239235
**Zowe file system paths**
240236

@@ -277,4 +273,4 @@ To see which FMIDs will be deleted, examine the `++VER` statement in the SMPMCS
277273

278274
Zowe has no special considerations for the target system.
279275

280-
For details about installing Zowe SMP/E, see [Installing Zowe via SMP/E instructions](./install-zowe-smpe.md).
276+
For details about installing Zowe SMP/E, see [Installing Zowe via SMP/E instructions](./install-zowe-smpe.md).

docs/user-guide/install-zowe-zos-convenience-build.md

Lines changed: 2 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -148,73 +148,8 @@ After you extract the Zowe convenience build, you can run the [`zwe install` com
148148
149149
### About the MVS data sets
150150
151-
Zowe includes a number of files that are stored in the various data sets. See the following table for the storage requirements.
152-
153-
Library DDNAME | Member Type | Target Volume | Type | Org | RECFM | LRECL | No. of 3390 Trks | No. of DIR Blks
154-
---|---|---|---|---|---|---|---|---
155-
SZWESAMP | Samples | ANY | U | PDSE | FB | 80 | 15 | 5
156-
SZWEAUTH | Zowe APF Load Modules | ANY | U | PDSE | U | 0 | 15 | N/A
157-
SZWEEXEC | CLIST copy utilities | ANY | U | PDSE | FB | 80 | 15 | 5
158-
SZWELOAD | Executable utilities library | ANY | U | PDSE | U | 0 | 15 | N/A
159-
160-
The `SZWESAMP` data set contains the following members.
161-
162-
Member name | Type | Purpose
163-
---|---|---
164-
ZWECSRVS | JCL | Removes the VSAM data set for the Caching Service
165-
ZWECSVSM | JCL | Creates the VSAM data set for the Caching Service
166-
ZWEGENER | JCL | Generates JCL templates to configure Zowe
167-
ZWEIACF | JCL | Defines security permits for ACF2
168-
ZWEIACFZ | JCL | Creates the ACF2 Zowe resource class
169-
ZWEIAPF | JCL | Set APF for the required datasets
170-
ZWEIAPF2| JCL | Set APF for the required datasets
171-
ZWEIKRA1 | JCL | Defines ACF2 key ring and certificates
172-
ZWEIKRA2 | JCL | Defines ACF2 key ring and certificates
173-
ZWEIKRA3 | JCL | Defines ACF2 key ring and certificates
174-
ZWEIKRR1 | JCL | Defines RACF key ring and certificates
175-
ZWEIKRR2 | JCL | Defines RACF key ring and certificates
176-
ZWEIKRR3 | JCL | Defines RACF key ring and certificates
177-
ZWEIKRT1 | JCL | Defines TSS key ring and certificates
178-
ZWEIKRT2 | JCL | Defines TSS key ring and certificates
179-
ZWEIKRT3 | JCL | Defines TSS key ring and certificates
180-
ZWEIMVS | JCL | Creates datasets used by a Zowe instance
181-
ZWEIMVS2 | JCL | Creates the load library (expected to be APF)
182-
ZWEINSTL | JCL | Creates and copies basic installation datasets and members
183-
ZWEIRAC | JCL | Defines security permits for RACF
184-
ZWEIRACZ | JCL | Creates the RACF Zowe resource class
185-
ZWEISTC | JCL | Adds `PROCLIB` members
186-
ZWEITSS | JCL | Defines security permits for TSS
187-
ZWEITSSZ | JCL | Creates the TSS Zowe resource class
188-
ZWEKRING | JCL | Defines key ring and certificates
189-
ZWENOKRA | JCL | Removes key ring and certificates for ACF2
190-
ZWENOKRR | JCL | Removes key ring and certificates for RACF
191-
ZWENOKRT | JCL | Removes key ring and certificates for TSS
192-
ZWENOKYR | JCL | Removes key ring and certificates
193-
ZWENOSEC | JCL | Defines security permits
194-
ZWERMVS | JCL | Removes datasets used by a Zowe instance
195-
ZWERMVS2 | JCL | Removes the APF load library
196-
ZWERSTC | JCL | Removes `PROCLIB` members
197-
ZWESASTC | JCL | Starts the Zowe Auxiliary server used by Cross memory server
198-
ZWESECKG | JCL | Sample program which generates a secret key for the PKCS#11 token
199-
ZWESECUR | JCL | Defines security permits for Zowe
200-
ZWESIPRG | Commands | Console commands to APF authorize the cross memory server load library
201-
ZWESIP00 | PARMLIB | Member for the cross memory server
202-
ZWESISCH | PPT | Defines entries required by Cross memory server and its Auxiliary address spaces to run in Key(4)
203-
ZWESISTC | JCL | Starts the Zowe Cross memory server
204-
ZWESLSTC | JCL | Starts the Zowe
205-
206-
The `SZWEAUTH` data set is a load library containing the following members.
207-
208-
Member name | Purpose
209-
---|---
210-
ZWELNCH | The Zowe launcher that controls the startup, restart and shutdown of Zowe's address spaces
211-
ZWESIS01 | Load module for the cross memory server
212-
ZWESAUX | Load module for the cross memory server's auxiliary address space
213-
ZWESISDL | ZIS Dynamic Plug-in
214-
215-
The `SZWEEXEC` data set contains few utilities used by Zowe.
216-
217-
The `SZWELOAD` data set contains config manager for REXX.
151+
The list of datasets and members in a Zowe install can be seen in the [Server Datasets Appendix](../appendix/server-datasets.md)
152+
218153
219154
### Procedure
220155

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -979,6 +979,7 @@ module.exports = {
979979
"contribute/contributing",
980980
],
981981
"reference": [
982+
"appendix/server-datasets",
982983
"appendix/server-component-manifest",
983984
"appendix/zowe-api-reference",
984985
{
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Server Datasets Reference
2+
3+
Zowe includes a number of files that are stored in the various data sets. See the following tables for the storage requirements and purposes.
4+
5+
## Runtime Datasets
6+
7+
The following datasets comprise the runtime, read-only dataset content that can be used by multiple Zowe instances of the same version. These are either delivered by an [SMP/E install](../user-guide/install-zowe-smpe.md), or by running `zwe install` when using [the z/OS convenience build of the Zowe servers](../user-guide/install-zowe-zos-convenience-build.md).
8+
9+
Library DDNAME | Member Type | Target Volume | Type | Org | RECFM | LRECL | No. of 3390 Trks | No. of DIR Blks
10+
---|---|---|---|---|---|---|---|---
11+
SZWESAMP | Samples | ANY | U | PDSE | FB | 80 | 15 | 5
12+
SZWEAUTH | Zowe APF Load Modules | ANY | U | PDSE | U | 0 | 15 | N/A
13+
SZWEEXEC | CLIST copy utilities | ANY | U | PDSE | FB | 80 | 15 | 5
14+
SZWELOAD | Executable utilities library | ANY | U | PDSE | U | 0 | 15 | N/A
15+
16+
The `SZWESAMP` data set contains the following members.
17+
18+
Member name | Type | Purpose
19+
---|---|---
20+
ZWECSRVS | JCL | Removes the VSAM data set for the Caching Service
21+
ZWECSVSM | JCL | Creates the VSAM data set for the Caching Service
22+
ZWEGENER | JCL | Generates JCL templates to configure Zowe
23+
ZWEIACF | JCL | Defines security permits for ACF2
24+
ZWEIACFZ | JCL | Creates the ACF2 Zowe resource class
25+
ZWEIAPF | JCL | Set APF for the required datasets
26+
ZWEIAPF2| JCL | Set APF for the required datasets
27+
ZWEIKRA1 | JCL | Defines ACF2 key ring and certificates
28+
ZWEIKRA2 | JCL | Defines ACF2 key ring and certificates
29+
ZWEIKRA3 | JCL | Defines ACF2 key ring and certificates
30+
ZWEIKRR1 | JCL | Defines RACF key ring and certificates
31+
ZWEIKRR2 | JCL | Defines RACF key ring and certificates
32+
ZWEIKRR3 | JCL | Defines RACF key ring and certificates
33+
ZWEIKRT1 | JCL | Defines TSS key ring and certificates
34+
ZWEIKRT2 | JCL | Defines TSS key ring and certificates
35+
ZWEIKRT3 | JCL | Defines TSS key ring and certificates
36+
ZWEIMVS | JCL | Creates datasets used by a Zowe instance
37+
ZWEIMVS2 | JCL | Creates the load library (expected to be APF)
38+
ZWEINSTL | JCL | Creates and copies basic installation datasets and members
39+
ZWEIRAC | JCL | Defines security permits for RACF
40+
ZWEIRACZ | JCL | Creates the RACF Zowe resource class
41+
ZWEISTC | JCL | Adds `PROCLIB` members
42+
ZWEITSS | JCL | Defines security permits for TSS
43+
ZWEITSSZ | JCL | Creates the TSS Zowe resource class
44+
ZWEKRING | JCL | Defines key ring and certificates
45+
ZWENOKRA | JCL | Removes key ring and certificates for ACF2
46+
ZWENOKRR | JCL | Removes key ring and certificates for RACF
47+
ZWENOKRT | JCL | Removes key ring and certificates for TSS
48+
ZWENOKYR | JCL | Removes key ring and certificates
49+
ZWENOSEC | JCL | Defines security permits
50+
ZWERMVS | JCL | Removes datasets used by a Zowe instance
51+
ZWERMVS2 | JCL | Removes the APF load library
52+
ZWERSTC | JCL | Removes `PROCLIB` members
53+
ZWESASTC | JCL | Starts the Zowe Auxiliary server used by Cross memory server
54+
ZWESECKG | JCL | Sample program which generates a secret key for the PKCS#11 token
55+
ZWESECUR | JCL | Defines security permits for Zowe
56+
ZWESIPRG | Commands | Console commands to APF authorize the cross memory server load library
57+
ZWESIP00 | PARMLIB | Member for the cross memory server
58+
ZWESISCH | PPT | Defines entries required by Cross memory server and its Auxiliary address spaces to run in Key(4)
59+
ZWESISTC | JCL | Starts the Zowe Cross memory server
60+
ZWESLSTC | JCL | Starts the Zowe
61+
62+
The `SZWEAUTH` data set is a load library containing the following members.
63+
64+
Member name | Purpose
65+
---|---
66+
ZWELNCH | The Zowe launcher that controls the startup, restart and shutdown of Zowe's address spaces
67+
ZWESIS01 | Load module for the cross memory server
68+
ZWESAUX | Load module for the cross memory server's auxiliary address space
69+
ZWESISDL | ZIS Dynamic Plug-in
70+
71+
The `SZWEEXEC` data set contains few utilities used by Zowe.
72+
73+
The `SZWELOAD` data set contains config manager for REXX.
74+
75+
## Custom Datasets
76+
77+
The following datasets are designed to be used by a single Zowe instance. These are created during post-install setup, and include temporary content as well as datasets used for extensions of Zowe.
78+
79+
Library DDNAME | Member Type | zowe.yaml | Target Volume | Type | Org | RECFM | LRECL | No. of 3390 Trks | No. of DIR Blks
80+
---|---|---|---|---|---|---|---|---|--
81+
CUST.PARMLIB | PARM Library Members | zowe.setup.dataset.parmlib | ANY | U | PDSE | FB | 80 | 15 | 5
82+
CUST.JCLLIB | JCL Members | zowe.setup.dataset.jcllib | ANY | U | PDSE | FB | 80 | 15 | 5
83+
CUST.ZWESAPL | CLIST copy utilities | zowe.setup.dataset.authPluginLib | ANY | U | PDSE | U | 0 | 15 | N/A

versioned_docs/version-v2.15.x/user-guide/address-storage-requirements.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55

66
Ensure that you have sufficient storage depending on the installation method. Review the storage requirements according to your installation method as presented in this article.
77

8-
## Installing with SMP/E
8+
## Installing Zowe Server Rutntime
99

10-
Before installing Zowe SMP/E, review the [DASD storage requirements](../user-guide/install-zowe-smpe/#dasd-storage-requirements).
10+
Before installing Zowe, review the reference for [Zowe's server datasets](../appendix/server-datasets.md)
1111

12-
## Installing Zowe runtime from a convenience build
12+
### Installing with SMP/E
1313

14-
Before installing Zowe runtime from a convenience build, see the [storage requirements associated with MVS datasets](../user-guide/install-zowe-zos-convenience-build/#step-5-install-the-mvs-data-sets).
14+
Additionally, when installing Zowe with SMP/E, review the [DASD storage requirements](../user-guide/install-zowe-smpe-overview.md#dasd-storage-requirements).
1515

16-
### Memory requirements for API Mediation Layer
16+
## Memory requirements for API Mediation Layer
1717

1818
Zowe API ML components have following memory requirements:
1919

0 commit comments

Comments
 (0)