Skip to content
Open
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
34be4f7
`server-datasets.md`: missing MVS members
Martin-Zeithaml Jul 10, 2025
b1c9fd9
Update server-datasets.md
Martin-Zeithaml Jul 10, 2025
b641630
Update initialize-zos-system.md
Martin-Zeithaml Jul 10, 2025
7785ec6
Merge branch 'master' into Martin-Zeithaml-patch-1
Martin-Zeithaml Jul 11, 2025
e217aac
Update server-datasets.md
Martin-Zeithaml Aug 6, 2025
a4474c7
apfauth needs SDSF
Martin-Zeithaml Aug 6, 2025
8f3f57c
Update zwe-init-subcommand-overview.md
Martin-Zeithaml Aug 6, 2025
ef8e779
VSAM update
Martin-Zeithaml Aug 6, 2025
740bd4d
Links to existing doc
Martin-Zeithaml Aug 6, 2025
c9ca479
Typo
Martin-Zeithaml Aug 6, 2025
b0c7f8f
Generate is not a config step
Martin-Zeithaml Aug 6, 2025
411bad5
Merge branch 'master' into Martin-Zeithaml-patch-1
Martin-Zeithaml Aug 13, 2025
74a0ced
Update server-datasets.md
Martin-Zeithaml Aug 13, 2025
2734812
minor adjustments
MarkAckert Aug 28, 2025
a7ed55a
Merge branch 'master' into Martin-Zeithaml-patch-1
MarkAckert Aug 28, 2025
4a4fa97
first draft of zowe-via-jcl and `zwe`, some minor edits
MarkAckert Aug 28, 2025
2c5bd72
fix broken links
MarkAckert Aug 29, 2025
25a053c
bunch of minor fixes
MarkAckert Aug 29, 2025
9fc92a2
update broken links to branch
MarkAckert Aug 29, 2025
3f47951
lychee cache wasn't saving?
MarkAckert Aug 29, 2025
f2860b8
Merge branch 'docs-staging' into Martin-Zeithaml-patch-1
MarkAckert Aug 29, 2025
3fe488c
use ref, not object
MarkAckert Aug 29, 2025
609a865
Update configuring-zowe-via-jcl.md
Martin-Zeithaml Sep 2, 2025
e28aa8a
couple more edits
MarkAckert Sep 3, 2025
efbfeef
more minor edits, notes in different places
MarkAckert Sep 3, 2025
01a2fbe
Merge branch 'docs-staging' into Martin-Zeithaml-patch-1
MarkAckert Sep 3, 2025
a5a9b28
broken links
MarkAckert Sep 3, 2025
7b83cb9
fix mistake
MarkAckert Sep 3, 2025
2750d95
Small updates to initialize-zos-system
MarkAckert Sep 4, 2025
fd3ee55
Merge branch 'docs-staging' into Martin-Zeithaml-patch-1
Martin-Zeithaml Sep 10, 2025
03d7dd3
Typo
Martin-Zeithaml Sep 10, 2025
0fd3e18
Typo
Martin-Zeithaml Sep 10, 2025
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
15 changes: 9 additions & 6 deletions docs/appendix/server-datasets.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ 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
ZWEIMVS | JCL | Creates PARMLIB dataset
ZWEIMVS1 | JCL | Creates plugin dataset (expected to be APF)
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
Expand All @@ -47,8 +48,9 @@ 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
ZWERMVS | JCL | Removes PARMLIB dataset
ZWERMVS1 | JCL | Removes plugin dataset
ZWERMVS2 | JCL | Removes 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
Expand Down Expand Up @@ -97,6 +99,7 @@ The following datasets are designed to be used by a single Zowe instance. These

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
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 | 60 | 5
CUST.ZWESALL | APF load modules | `zowe.setup.dataset.authLoadlib` | ANY | U | PDSE | U | 0 | 30 | N/A
CUST.ZWESAPL | APF plugins load modules | `zowe.setup.dataset.authPluginLib` | ANY | U | PDSE | U | 0 | 30 | N/A
22 changes: 5 additions & 17 deletions docs/user-guide/initialize-zos-system.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ Once you complete the installation of the Zowe runtime, begin configuration by i
:::

## About the `zwe init` command

The `zwe init` command is a combination of the following subcommands. Each subcommand defines a configuration.

Each subcommand defines a configuration.
The `zwe init` command is a combination of the following subcommands. Except the generate, each subcommand defines a configuration.
- **generate**
Generates ready to execute JCL samples from YAML configuration values.
- **mvs**
Copies the data sets provided with Zowe to custom data sets.
- **security**
Expand All @@ -31,22 +32,9 @@ We recommend you to run these sub commands one by one to clearly see the output
Enter `zwe init --help` to learn more about the command or see the [`zwe init` command reference](../appendix/zwe_server_command_reference/zwe/init/zwe-init-vsam.md) for detailed explanation, examples, and parameters.
:::

## zwe init arguments

The following `zwe init` arguments can assist you with the initization process:

- **--update-config**
This argument allows the init process to update your configuration file based on automatic detection and your `zowe.setup` settings. For example, if `java.home` and `node.home` are not defined, they can be updated based on the information that is collected on the system. `zowe.certificate` section can also be updated automatically based on your `zowe.setup.certificate` settings.
- **--allow-overwrite**
This argument allows you to rerun the `zwe init` command repeatedly regardless of whether some data sets are already created.
- **-v** or **--verbose**
This argument provides execution details of the `zwe` command. You can use it for troubleshooting purposes if the error message is not clear enough.
- **-vv** or **--trace**
This argument provides you more execution details than the `--verbose` mode for troubleshooting purposes.

## Zowe initilization command

The `zwe init` command runs the subcommands in sequence automatically. If you have the Zowe configuration file preparted and have security administrator privileges, or security and certificates setup was already completed on the system, you can run the following command:
The `zwe init` command runs the subcommands in sequence automatically. If you have the Zowe configuration file prepared and have security administrator privileges, or security and certificates setup was already completed on the system, you can run the following command:

```
zwe init --config /path/to/zowe.yaml
Expand Down
5 changes: 3 additions & 2 deletions docs/user-guide/systemrequirements-zos.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,9 @@ Be sure your z/OS system meets the following prerequisites:
| Task | Command utilizing SDSF | Alternatives |
|-----------|-------------------------------|-------------|
| [Certificate setup](configure-certificates.md) | `zwe init certificate` | z/OSMF workflow "ZWEKRING", or the JCL samples "ZWEKRING" and those that begin with "ZWEIKR" can be used to create keyrings. |
| [Starting Zowe](start-zowe-zos.md) | `zwe start` | Products that can issue the MVS START command upon Zowe's STC such as Sysview or EJES can be used instead. |
| [Stopping Zowe](start-zowe-zos.md) | `zwe stop` | Products that can issue the MVS STOP command upon Zowe's STC such as Sysview or EJES can be used instead. |
| [Authorize library](../appendix/zwe_server_command_reference/zwe/init/zwe-init-apfauth.md) | `zwe init apfauth` | Products that can issue the MVS `SETPROG APF` command or update `SYS1.PARMLIB(PROGxx)`. See examples in [`SZWESAMP(ZWESIPRG)`](https://github.com/zowe/zowe-install-packaging/blob/v3.x/staging/files/SZWESAMP/ZWESIPRG). |
| [Starting Zowe](start-zowe-zos.md) | `zwe start` | Products that can issue the MVS `START` command upon Zowe's STC such as Sysview or EJES can be used instead. |
| [Stopping Zowe](start-zowe-zos.md) | `zwe stop` | Products that can issue the MVS `STOP` command upon Zowe's STC such as Sysview or EJES can be used instead. |

Not having SDSF installed may result in the following error message:

Expand Down
80 changes: 18 additions & 62 deletions docs/user-guide/zwe-init-subcommand-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,7 @@ Use the `zwe init mvs` command to intialize Zowe custom MVS data sets.
:::info Required role: system programmer
:::

During the installation of Zowe, the following three data sets are created and populated with members copied across from the Zowe installation files:
* `SZWEAUTH`
* `SZWESAMP`
* `SZWEEXEC`
During the installation of Zowe, the following [runtime datasets](../appendix/server-datasets.md#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.

Expand All @@ -43,13 +40,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
Review the [storage requirements](../appendix/server-datasets.md#custom-datasets) for the datasets.

### Procedure to initialize Zowe custom data sets

Expand All @@ -68,37 +59,31 @@ The following output is an example of running `zwe init mvs`.
-------------------------------------------------------------------------------
>> Initialize Zowe custom data sets

Create data sets if they are not exist
Create data sets if they do not exist
Creating IBMUSER.ZWE.CUST.PARMLIB
Creating IBMUSER.ZWE.CUST.JCLLIB
Creating IBMUSER.ZWE.SZWEAUTH
Creating IBMUSER.ZWE.CUST.ZWESALL
Creating IBMUSER.ZWE.CUST.ZWESAPL

Copy IBMUSER.ZWE.SZWESAMP(ZWESIP00) to USER.ZWE.CUST.PARMLIB(ZWESIP00)
Copy components/zss/LOADLIB/ZWESIS01 to USER.ZWE.SZWEAUTH(ZWESIS01)
Copy components/zss/LOADLIB/ZWESAUX to USER.ZWE.SZWEAUTH(ZWESAUX)
Copy components/launcher/bin/zowe_launcher to USER.ZWE.SZWEAUTH(ZWELNCH)
Copy IBMUSER.ZWE.CUST.SZWESAMP(ZWESIP00) to IBMUSER.ZWE.CUST.PARMLIB(ZWESIP00)
Copy components/zss/LOADLIB/ZWESIS01 to IBMUSER.ZWE.CUST.ZWESALL(ZWESIS01)
Copy components/zss/LOADLIB/ZWESAUX to IBMUSER.ZWE.CUST.ZWESALL(ZWESAUX)
Copy components/zss/LOADLIB/ZWESISDL to IBMUSER.ZWE.CUST.ZWESALL(ZWESISDL)
Copy components/launcher/bin/zowe_launcher to IBMUSER.ZWE.CUST.ZWESALL(ZWELNCH)

>> Zowe custom data sets are initialized successfully.
#>
```

Successful execution of `zwe init mvs` has the following results:

* In the `zowe.yaml` file, three custom data sets are created that have matching values with the following libraries:
* In the `zowe.yaml` file, custom data sets are created that have matching values with the following libraries:
* `zowe.setup.dataset.parmlib`
* `zowe.setup.dataset.jcllib`
* `zowe.setup.dataset.authLoadlib`
* `zowe.setup.dataset.authPluginLib`.

* The member `ZWESIP00` is contained in `CUST.PARMLIB`. `JCLLIB` and `ZWESAPL` are empty.

* The PDS `SZWEAUTH` is created. If `SZWEAUTH` already exists, the following error is thrown:
```
Error ZWEL0158E: IBMUSER.ZWE.SZWEAUTH already exists
```
You can ignore this message, or you can use the `--allow-overwritten` option on the command. For example, `zwe init mvs -c zowe.yaml --allow-overwritten`.


## Initializing Zowe security configurations (`zwe init security`)

This subcommand creates the user IDs and security manager settings.
Expand Down Expand Up @@ -150,44 +135,14 @@ Zowe contains load modules that require access to make privileged z/OS security
The command `zwe init apfauth` reads the PDS names for the following load libraries from zowe.yaml and performs the APF authority commands.

* **zowe.setup.dataset.authLoadLib**
Specifies the user custom load library, containing the ZWELNCH, ZWESIS01 and ZWESAUX load modules. These are the Zowe launcher, the ZIS cross memory server and the auxiliary server.
Specifies the user custom load library containing the load modules.
* **zowe.setup.dataset.authPluginLib**
References the load library for ZIS plugins.

For more information about `zwe init apfauth` see:
* [Performing APF authorization of load libraries](./apf-authorize-load-library.md).
* [`zwe init apfauth`](../appendix/zwe_server_command_reference/zwe/init/zwe-init-apfauth.md) in the Reference section.

:::tip

To avoid having to run the `init apfauth` command, you can specify the flag `--security-dry-run` as in the following example.

**Example:**

```
zwe init apfauth --security-dry-run -c /path/to/zowe.yaml
-------------------------------------------------------------------------------
>> APF authorize load libraries

APF authorize IBMUSER.ZWE.SZWEAUTH
- Dry-run mode, security setup is NOT performed on the system.
Please apply this operator command manually:

SETPROG APF,ADD,DSNAME=IBMUSER.ZWE.SZWEAUTH,SMS

APF authorize IBMUSER.ZWE.CUST.ZWESAPL
- Dry-run mode, security setup is NOT performed on the system.
Please apply this operator command manually:

SETPROG APF,ADD,DSNAME=IBMUSER.ZWE.CUST.ZWESAPL,SMS


>> Zowe load libraries are APF authorized successfully.

```
For production environments, inform your security administrator to re-submit the `init apfauth` command with proper authorization.

:::

## Configuring Zowe to use TLS certificates (`zwe init certificate`)

Expand Down Expand Up @@ -241,16 +196,17 @@ The `zwe init stc` command uses the `CUST.JCL` LIB data sets as a staging area t
-------------------------------------------------------------------------------
>> Install Zowe main started task

Modify ZWESLSTC
Modify ZWESISTC
Modify ZWESASTC
Modify ZWESLSTC and save as IBMUSER.ZWE.CUST.JCLLIB(ZWESLSTC)
CONFIG path defined in ZWESLSTC is converted into absolute path and may contain SYSNAME.
Please manually verify if this path works for your environment, especially when you are working in Sysplex environment.
Modify ZWESISTC and save as IBMUSER.ZWE.CUST.JCLLIB(ZWESISTC)
Modify ZWESASTC and save as IBMUSER.ZWE.CUST.JCLLIB(ZWESASTC)

Copy IBMUSER.ZWE.CUST.JCLLIB(ZWESLSTC) to USER.PROCLIB(ZWESLSTC)
Copy IBMUSER.ZWE.CUST.JCLLIB(ZWESISTC) to USER.PROCLIB(ZWESISTC)
Copy IBMUSER.ZWE.CUST.JCLLIB(ZWESASTC) to USER.PROCLIB(ZWESASTC)

>> Zowe main started tasks are installed successfully.
#>
```

## (Deprecated) Creating VSAM caching service datasets (`zwe init vsam`)
Expand All @@ -262,7 +218,7 @@ Zowe can work in a high availability (HA) configuration where multiple instances
:::info Required roles: system programmer
:::

The command `zwe init vsam` uses the template JCL in `SZWESAMP(ZWECSVSM)` to copy the source template member from `zowe.setup.mvs.hlq.SZWESAMP(ZWECVCSM)` and creates a target JCL member in `zowe.setup.mvs.jcllib(ZWECVSCM)` with values extracted from the `zowe.yaml` file.
The command `zwe init vsam` uses the template JCL in `zowe.setup.dataset.prefix` + `.SZWESAMP(ZWECSVSM)`, processes it with values extracted from the `zowe.yaml` file and creates a target JCL member in `zowe.setup.dataset.prefix.jcllib` + `(ZWECVSCM)`.

For more information about `zwe init vsam`, see [Creating VSAM caching service datasets](./configure-caching-service-ha.md)

Expand Down
Loading