Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create appendix for list of zowe's datasets #4147

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions docs/appendix/server-datasets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Server Datasets Reference

Zowe includes a number of files that are stored in the various data sets. See the following tables for the storage requirements and purposes.

## Runtime Datasets

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](../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).

Library DDNAME | Member Type | Target Volume | Type | Org | RECFM | LRECL | No. of 3390 Trks | No. of DIR Blks
---|---|---|---|---|---|---|---|---
SZWESAMP | Samples | ANY | U | PDSE | FB | 80 | 15 | 5
SZWEAUTH | Zowe APF Load Modules | ANY | U | PDSE | U | 0 | 15 | N/A
SZWEEXEC | CLIST copy utilities | ANY | U | PDSE | FB | 80 | 15 | 5
SZWELOAD | Executable utilities library | ANY | U | PDSE | U | 0 | 15 | N/A

The `SZWESAMP` data set contains the following members.

Member name | Type | Purpose
---|---|---
ZWECSRVS | JCL | Removes the VSAM data set for the Caching Service
ZWECSVSM | JCL | Creates the VSAM data set for the Caching Service
ZWEGENER | JCL | Generates JCL templates to configure Zowe
ZWEIACF | JCL | Defines security permits for ACF2
ZWEIACFZ | JCL | Creates the ACF2 Zowe resource class
ZWEIAPF | JCL | Set APF for the required datasets
ZWEIAPF2| JCL | Set APF for the required datasets
ZWEIKRA1 | JCL | Defines ACF2 key ring and certificates
ZWEIKRA2 | JCL | Defines ACF2 key ring and certificates
ZWEIKRA3 | JCL | Defines ACF2 key ring and certificates
ZWEIKRR1 | JCL | Defines RACF key ring and certificates
ZWEIKRR2 | JCL | Defines RACF key ring and certificates
ZWEIKRR3 | JCL | Defines RACF key ring and certificates
ZWEIKRT1 | JCL | Defines TSS key ring and certificates
ZWEIKRT2 | JCL | Defines TSS key ring and certificates
ZWEIKRT3 | JCL | Defines TSS key ring and certificates
ZWEIMVS | JCL | Creates datasets used by a Zowe instance
ZWEIMVS2 | JCL | Creates the load library (expected to be APF)
ZWEINSTL | JCL | Creates and copies basic installation datasets and members
ZWEIRAC | JCL | Defines security permits for RACF
ZWEIRACZ | JCL | Creates the RACF Zowe resource class
ZWEISTC | JCL | Adds `PROCLIB` members
ZWEITSS | JCL | Defines security permits for TSS
ZWEITSSZ | JCL | Creates the TSS Zowe resource class
ZWEKRING | JCL | Defines key ring and certificates
ZWENOKRA | JCL | Removes key ring and certificates for ACF2
ZWENOKRR | JCL | Removes key ring and certificates for RACF
ZWENOKRT | JCL | Removes key ring and certificates for TSS
ZWENOKYR | JCL | Removes key ring and certificates
ZWENOSEC | JCL | Defines security permits
ZWERMVS | JCL | Removes datasets used by a Zowe instance
ZWERMVS2 | JCL | Removes the APF load library
ZWERSTC | JCL | Removes `PROCLIB` members
ZWESASTC | JCL | Starts the Zowe Auxiliary server used by Cross memory server
ZWESECKG | JCL | Sample program which generates a secret key for the PKCS#11 token
ZWESECUR | JCL | Defines security permits for Zowe
ZWESIPRG | Commands | Console commands to APF authorize the cross memory server load library
ZWESIP00 | PARMLIB | Member for the cross memory server
ZWESISCH | PPT | Defines entries required by Cross memory server and its Auxiliary address spaces to run in Key(4)
ZWESISTC | JCL | Starts the Zowe Cross memory server
ZWESLSTC | JCL | Starts the Zowe

The `SZWEAUTH` data set is a load library containing the following members.

Member name | Purpose
---|---
ZWELNCH | The Zowe launcher that controls the startup, restart and shutdown of Zowe's address spaces
ZWESIS01 | Load module for the cross memory server
ZWESAUX | Load module for the cross memory server's auxiliary address space
ZWESISDL | ZIS Dynamic Plug-in

The `SZWEEXEC` data set contains few utilities used by Zowe.

The `SZWELOAD` data set contains config manager for REXX.

## Custom Datasets

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.

Library DDNAME | Member Type | zowe.yaml | Target Volume | Type | Org | RECFM | LRECL | No. of 3390 Trks | No. of DIR Blks
---|---|---|---|---|---|---|---|---|--
CUST.PARMLIB | PARM Library Members | zowe.setup.dataset.parmlib | ANY | U | PDSE | FB | 80 | 15 | 5
CUST.JCLLIB | JCL Members | zowe.setup.dataset.jcllib | ANY | U | PDSE | FB | 80 | 15 | 5
CUST.ZWESAPL | CLIST copy utilities | zowe.setup.dataset.authPluginLib | ANY | U | PDSE | U | 0 | 15 | N/A
10 changes: 5 additions & 5 deletions docs/user-guide/address-storage-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@

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.

## Installing with SMP/E
## Installing Zowe Server Rutntime

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

## Installing Zowe runtime from a convenience build
### Installing with SMP/E

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).
Additionally, when installing Zowe with SMP/E, review the [DASD storage requirements](../user-guide/install-zowe-smpe-overview.md#dasd-storage-requirements).

### Memory requirements for API Mediation Layer
## Memory requirements for API Mediation Layer

Zowe API ML components have following memory requirements:

Expand Down
10 changes: 2 additions & 8 deletions docs/user-guide/initialize-mvs-datasets.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Review this article to learn about how to intialize Zowe custom MVS data sets by

## Introduction

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.
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).

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).

Expand All @@ -25,13 +25,7 @@ zowe:
authPluginLib: IBMUSER.ZWE.CUST.ZWESAPL
```

Review the following table for storage requirements for the three data sets:

Library DDNAME | Member Type | zowe.yaml | Target Volume | Type | Org | RECFM | LRECL | No. of 3390 Trks | No. of DIR Blks
---|---|---|---|---|---|---|---|---|--
CUST.PARMLIB | PARM Library Members | zowe.setup.dataset.parmlib | ANY | U | PDSE | FB | 80 | 15 | 5
CUST.JCLLIB | JCL Members | zowe.setup.dataset.jcllib | ANY | U | PDSE | FB | 80 | 15 | 5
CUST.ZWESAPL | CLIST copy utilities | zowe.setup.dataset.authPluginLib | ANY | U | PDSE | U | 0 | 15 | N/A
Refer to the appendix for the [list of datasets](../appendix/server-datasets.md#custom-datasets) that will be created in this step.

## Procedure to initialize Zowe custom data sets

Expand Down
8 changes: 2 additions & 6 deletions docs/user-guide/install-zowe-smpe-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,11 +230,7 @@ The following figures describe the target and distribution libraries and file sy

**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.

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

**Zowe file system paths**

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

Zowe has no special considerations for the target system.

For details about installing Zowe SMP/E, see [Installing Zowe via SMP/E instructions](./install-zowe-smpe.md).
For details about installing Zowe SMP/E, see [Installing Zowe via SMP/E instructions](./install-zowe-smpe.md).
69 changes: 2 additions & 67 deletions docs/user-guide/install-zowe-zos-convenience-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,73 +148,8 @@ After you extract the Zowe convenience build, you can run the [`zwe install` com

### About the MVS data sets

Zowe includes a number of files that are stored in the various data sets. See the following table for the storage requirements.

Library DDNAME | Member Type | Target Volume | Type | Org | RECFM | LRECL | No. of 3390 Trks | No. of DIR Blks
---|---|---|---|---|---|---|---|---
SZWESAMP | Samples | ANY | U | PDSE | FB | 80 | 15 | 5
SZWEAUTH | Zowe APF Load Modules | ANY | U | PDSE | U | 0 | 15 | N/A
SZWEEXEC | CLIST copy utilities | ANY | U | PDSE | FB | 80 | 15 | 5
SZWELOAD | Executable utilities library | ANY | U | PDSE | U | 0 | 15 | N/A

The `SZWESAMP` data set contains the following members.

Member name | Type | Purpose
---|---|---
ZWECSRVS | JCL | Removes the VSAM data set for the Caching Service
ZWECSVSM | JCL | Creates the VSAM data set for the Caching Service
ZWEGENER | JCL | Generates JCL templates to configure Zowe
ZWEIACF | JCL | Defines security permits for ACF2
ZWEIACFZ | JCL | Creates the ACF2 Zowe resource class
ZWEIAPF | JCL | Set APF for the required datasets
ZWEIAPF2| JCL | Set APF for the required datasets
ZWEIKRA1 | JCL | Defines ACF2 key ring and certificates
ZWEIKRA2 | JCL | Defines ACF2 key ring and certificates
ZWEIKRA3 | JCL | Defines ACF2 key ring and certificates
ZWEIKRR1 | JCL | Defines RACF key ring and certificates
ZWEIKRR2 | JCL | Defines RACF key ring and certificates
ZWEIKRR3 | JCL | Defines RACF key ring and certificates
ZWEIKRT1 | JCL | Defines TSS key ring and certificates
ZWEIKRT2 | JCL | Defines TSS key ring and certificates
ZWEIKRT3 | JCL | Defines TSS key ring and certificates
ZWEIMVS | JCL | Creates datasets used by a Zowe instance
ZWEIMVS2 | JCL | Creates the load library (expected to be APF)
ZWEINSTL | JCL | Creates and copies basic installation datasets and members
ZWEIRAC | JCL | Defines security permits for RACF
ZWEIRACZ | JCL | Creates the RACF Zowe resource class
ZWEISTC | JCL | Adds `PROCLIB` members
ZWEITSS | JCL | Defines security permits for TSS
ZWEITSSZ | JCL | Creates the TSS Zowe resource class
ZWEKRING | JCL | Defines key ring and certificates
ZWENOKRA | JCL | Removes key ring and certificates for ACF2
ZWENOKRR | JCL | Removes key ring and certificates for RACF
ZWENOKRT | JCL | Removes key ring and certificates for TSS
ZWENOKYR | JCL | Removes key ring and certificates
ZWENOSEC | JCL | Defines security permits
ZWERMVS | JCL | Removes datasets used by a Zowe instance
ZWERMVS2 | JCL | Removes the APF load library
ZWERSTC | JCL | Removes `PROCLIB` members
ZWESASTC | JCL | Starts the Zowe Auxiliary server used by Cross memory server
ZWESECKG | JCL | Sample program which generates a secret key for the PKCS#11 token
ZWESECUR | JCL | Defines security permits for Zowe
ZWESIPRG | Commands | Console commands to APF authorize the cross memory server load library
ZWESIP00 | PARMLIB | Member for the cross memory server
ZWESISCH | PPT | Defines entries required by Cross memory server and its Auxiliary address spaces to run in Key(4)
ZWESISTC | JCL | Starts the Zowe Cross memory server
ZWESLSTC | JCL | Starts the Zowe

The `SZWEAUTH` data set is a load library containing the following members.

Member name | Purpose
---|---
ZWELNCH | The Zowe launcher that controls the startup, restart and shutdown of Zowe's address spaces
ZWESIS01 | Load module for the cross memory server
ZWESAUX | Load module for the cross memory server's auxiliary address space
ZWESISDL | ZIS Dynamic Plug-in

The `SZWEEXEC` data set contains few utilities used by Zowe.

The `SZWELOAD` data set contains config manager for REXX.
The list of datasets and members in a Zowe install can be seen in the [Server Datasets Appendix](../appendix/server-datasets.md)


### Procedure

Expand Down
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -978,6 +978,7 @@ module.exports = {
"contribute/contributing",
],
"reference": [
"appendix/server-datasets",
"appendix/server-component-manifest",
"appendix/zowe-api-reference",
{
Expand Down
83 changes: 83 additions & 0 deletions versioned_docs/version-v2.15.x/appendix/server-datasets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Server Datasets Reference

Zowe includes a number of files that are stored in the various data sets. See the following tables for the storage requirements and purposes.

## Runtime Datasets

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](../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).

Library DDNAME | Member Type | Target Volume | Type | Org | RECFM | LRECL | No. of 3390 Trks | No. of DIR Blks
---|---|---|---|---|---|---|---|---
SZWESAMP | Samples | ANY | U | PDSE | FB | 80 | 15 | 5
SZWEAUTH | Zowe APF Load Modules | ANY | U | PDSE | U | 0 | 15 | N/A
SZWEEXEC | CLIST copy utilities | ANY | U | PDSE | FB | 80 | 15 | 5
SZWELOAD | Executable utilities library | ANY | U | PDSE | U | 0 | 15 | N/A

The `SZWESAMP` data set contains the following members.

Member name | Type | Purpose
---|---|---
ZWECSRVS | JCL | Removes the VSAM data set for the Caching Service
ZWECSVSM | JCL | Creates the VSAM data set for the Caching Service
ZWEGENER | JCL | Generates JCL templates to configure Zowe
ZWEIACF | JCL | Defines security permits for ACF2
ZWEIACFZ | JCL | Creates the ACF2 Zowe resource class
ZWEIAPF | JCL | Set APF for the required datasets
ZWEIAPF2| JCL | Set APF for the required datasets
ZWEIKRA1 | JCL | Defines ACF2 key ring and certificates
ZWEIKRA2 | JCL | Defines ACF2 key ring and certificates
ZWEIKRA3 | JCL | Defines ACF2 key ring and certificates
ZWEIKRR1 | JCL | Defines RACF key ring and certificates
ZWEIKRR2 | JCL | Defines RACF key ring and certificates
ZWEIKRR3 | JCL | Defines RACF key ring and certificates
ZWEIKRT1 | JCL | Defines TSS key ring and certificates
ZWEIKRT2 | JCL | Defines TSS key ring and certificates
ZWEIKRT3 | JCL | Defines TSS key ring and certificates
ZWEIMVS | JCL | Creates datasets used by a Zowe instance
ZWEIMVS2 | JCL | Creates the load library (expected to be APF)
ZWEINSTL | JCL | Creates and copies basic installation datasets and members
ZWEIRAC | JCL | Defines security permits for RACF
ZWEIRACZ | JCL | Creates the RACF Zowe resource class
ZWEISTC | JCL | Adds `PROCLIB` members
ZWEITSS | JCL | Defines security permits for TSS
ZWEITSSZ | JCL | Creates the TSS Zowe resource class
ZWEKRING | JCL | Defines key ring and certificates
ZWENOKRA | JCL | Removes key ring and certificates for ACF2
ZWENOKRR | JCL | Removes key ring and certificates for RACF
ZWENOKRT | JCL | Removes key ring and certificates for TSS
ZWENOKYR | JCL | Removes key ring and certificates
ZWENOSEC | JCL | Defines security permits
ZWERMVS | JCL | Removes datasets used by a Zowe instance
ZWERMVS2 | JCL | Removes the APF load library
ZWERSTC | JCL | Removes `PROCLIB` members
ZWESASTC | JCL | Starts the Zowe Auxiliary server used by Cross memory server
ZWESECKG | JCL | Sample program which generates a secret key for the PKCS#11 token
ZWESECUR | JCL | Defines security permits for Zowe
ZWESIPRG | Commands | Console commands to APF authorize the cross memory server load library
ZWESIP00 | PARMLIB | Member for the cross memory server
ZWESISCH | PPT | Defines entries required by Cross memory server and its Auxiliary address spaces to run in Key(4)
ZWESISTC | JCL | Starts the Zowe Cross memory server
ZWESLSTC | JCL | Starts the Zowe

The `SZWEAUTH` data set is a load library containing the following members.

Member name | Purpose
---|---
ZWELNCH | The Zowe launcher that controls the startup, restart and shutdown of Zowe's address spaces
ZWESIS01 | Load module for the cross memory server
ZWESAUX | Load module for the cross memory server's auxiliary address space
ZWESISDL | ZIS Dynamic Plug-in

The `SZWEEXEC` data set contains few utilities used by Zowe.

The `SZWELOAD` data set contains config manager for REXX.

## Custom Datasets

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.

Library DDNAME | Member Type | zowe.yaml | Target Volume | Type | Org | RECFM | LRECL | No. of 3390 Trks | No. of DIR Blks
---|---|---|---|---|---|---|---|---|--
CUST.PARMLIB | PARM Library Members | zowe.setup.dataset.parmlib | ANY | U | PDSE | FB | 80 | 15 | 5
CUST.JCLLIB | JCL Members | zowe.setup.dataset.jcllib | ANY | U | PDSE | FB | 80 | 15 | 5
CUST.ZWESAPL | CLIST copy utilities | zowe.setup.dataset.authPluginLib | ANY | U | PDSE | U | 0 | 15 | N/A
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@

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.

## Installing with SMP/E
## Installing Zowe Server Rutntime

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

## Installing Zowe runtime from a convenience build
### Installing with SMP/E

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).
Additionally, when installing Zowe with SMP/E, review the [DASD storage requirements](../user-guide/install-zowe-smpe-overview.md#dasd-storage-requirements).

### Memory requirements for API Mediation Layer
## Memory requirements for API Mediation Layer

Zowe API ML components have following memory requirements:

Expand Down
Loading
Loading