From 388f7d2688324ec3c763814aad8e324839111c92 Mon Sep 17 00:00:00 2001 From: Martin Zeithaml <66114686+Martin-Zeithaml@users.noreply.github.com> Date: Fri, 15 Nov 2024 15:27:11 +0100 Subject: [PATCH 1/8] Update install-zowe-zos-convenience-build.md Signed-off-by: Martin Zeithaml <66114686+Martin-Zeithaml@users.noreply.github.com> --- docs/user-guide/install-zowe-zos-convenience-build.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/user-guide/install-zowe-zos-convenience-build.md b/docs/user-guide/install-zowe-zos-convenience-build.md index 39bff3240d..6479e4a4ca 100644 --- a/docs/user-guide/install-zowe-zos-convenience-build.md +++ b/docs/user-guide/install-zowe-zos-convenience-build.md @@ -140,6 +140,7 @@ Library DDNAME | Member Type | Target Volume | Type | Org | RECFM | LRECL | No. 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. @@ -167,6 +168,8 @@ ZWESAUX | Load module for the cross memory server's auxiliary address space The `SZWEEXEC` data set contains few utilities used by Zowe. +The `SZWELOAD` data set contains config manager for REXX. + ### Procedure The high level qualifer (or HLQ) for these data sets is specified in the `zowe.yaml` section below. Ensure that you update the `zowe.setup.dataset.prefix` value to match your system. From 090a4455c4964beaa33bfb18375cc5263bec0f7d Mon Sep 17 00:00:00 2001 From: Martin Zeithaml <66114686+Martin-Zeithaml@users.noreply.github.com> Date: Fri, 15 Nov 2024 16:48:31 +0100 Subject: [PATCH 2/8] Update install-zowe-zos-convenience-build.md Signed-off-by: Martin Zeithaml <66114686+Martin-Zeithaml@users.noreply.github.com> --- docs/user-guide/install-zowe-zos-convenience-build.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/user-guide/install-zowe-zos-convenience-build.md b/docs/user-guide/install-zowe-zos-convenience-build.md index 6479e4a4ca..eb8ada603d 100644 --- a/docs/user-guide/install-zowe-zos-convenience-build.md +++ b/docs/user-guide/install-zowe-zos-convenience-build.md @@ -197,6 +197,7 @@ A sample run of the command is shown below using default values. Create MVS data sets if they are not exist Creating Zowe sample library - IBMUSER.ZWEV2.SZWESAMP Creating Zowe authorized load library - IBMUSER.ZWEV2.SZWEAUTH +Creating Zowe load library - IBMUSER.ZWEV2.SZWELOAD Creating Zowe executable utilities library - IBMUSER.ZWEV2.SZWEEXEC Copy files/SZWESAMP/ZWESIPRG to IBMUSER.ZWEV2.SZWESAMP From 238ecc98f08eb8e956a61fb73abc11000f5c304a Mon Sep 17 00:00:00 2001 From: Andrew Jandacek Date: Mon, 18 Nov 2024 10:17:00 +0100 Subject: [PATCH 3/8] minor language and formatting refactor Signed-off-by: Andrew Jandacek --- .../install-zowe-zos-convenience-build.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/user-guide/install-zowe-zos-convenience-build.md b/docs/user-guide/install-zowe-zos-convenience-build.md index eb8ada603d..d3f87d0074 100644 --- a/docs/user-guide/install-zowe-zos-convenience-build.md +++ b/docs/user-guide/install-zowe-zos-convenience-build.md @@ -52,8 +52,10 @@ After you download the PAX file, you can transfer it to z/OS and expand its cont ``` put .pax ``` + where: - `zowe-V.v.p` is a variable that indicates the name of the PAX file you downloaded. + * `zowe-V.v.p` + is a variable that indicates the name of the PAX file you downloaded. **Note:** When your terminal is connected to z/OS through FTP or SFTP, you can prepend commands with `l` to have them issued against your desktop. To list the contents of a directory on your desktop, type `lls` where `ls` lists contents of a directory on z/OS. @@ -67,9 +69,11 @@ After you download the PAX file, you can transfer it to z/OS and expand its cont pax -ppx -rf .pax ``` - Where _zowe-V.v.p_ is a variable that indicates the name of the PAX file you downloaded. When extracting the Zowe convenience build, you must always include the `-ppx` argument that preserves extended attributes. + where: + * `zowe-V.v.p` + is a variable that indicates the name of the PAX file you downloaded. When extracting the Zowe convenience build, you must always include the `-ppx` argument that preserves extended attributes. - This will expand to a file structure similar to the following one. + This command expands to a file structure similar to the following one: ``` /bin @@ -80,7 +84,7 @@ After you download the PAX file, you can transfer it to z/OS and expand its cont This is the Zowe runtime directory and is referred to as `` throughout this documentation. - **Note:** Zowe version 1 had a script `zowe-install.sh` that created a separate Zowe runtime directory from the expanded contents of the Zowe PAX file. Zowe v2 no longer has this step. **In Zowe v2, the contents of the expanded Zowe PAX file are the Zowe runtime directory.** + **Note:** Zowe version 1 had a script `zowe-install.sh` that created a separate Zowe runtime directory from the expanded contents of the Zowe PAX file. Zowe v2 no longer has this step. **In Zowe v2, and Zowe v3 the contents of the expanded Zowe PAX file are the Zowe runtime directory.** ## Step 3: (Optional) Add the `zwe` command to your PATH @@ -92,7 +96,7 @@ export PATH=${PATH}:/bin `` should be replaced with your real Zowe runtime directory path. This will update the `PATH` for the current shell. To make this update persistent, you can add the line to your `~/.profile` file, or the `~/.bashProfile` file if you are using a bash shell. To make this update system wide, you can update the `/etc/.profile` file. Once the PATH is updated, you can execute the `zwe` command from any USS directory. For the remainder of the documentation when `zwe` command is referenced, it is assumed that it has been added to your `PATH`. -The `zwe` command has built in help that can be retrieved with the `-h` suffix. For example, type `zwe -h` to display all of the supported commands. These are broken down into a number of sub-commands. +The `zwe` command has built in help that can be retrieved with the `-h` suffix. For example, type `zwe -h` to display all of the supported commands. These are broken down into a number of sub-commands: ``` zwe -h @@ -216,4 +220,4 @@ Copy components/zss/LOADLIB/ZWESAUX to IBMUSER.ZWEV2.SZWEAUTH ## Next steps -You successfully installed Zowe from the convenience build! However, before you start Zowe, you must complete several required configurations. Next, go to [Initialize the z/OS system and permissions](initialize-zos-system.md) to initialize your z/OS system for Zowe first. +You successfully installed Zowe from the convenience build! However, before you start Zowe, you must complete several required configurations. The next step is to [Initialize the z/OS system and permissions](initialize-zos-system.md) for Zowe. From 18594a0e8a3f88b2bfc99ffe44afba5780a7182a Mon Sep 17 00:00:00 2001 From: Martin Zeithaml Date: Mon, 18 Nov 2024 12:31:00 +0100 Subject: [PATCH 4/8] Table of members Signed-off-by: Martin Zeithaml --- .../install-zowe-zos-convenience-build.md | 59 ++++++++++++++----- 1 file changed, 45 insertions(+), 14 deletions(-) diff --git a/docs/user-guide/install-zowe-zos-convenience-build.md b/docs/user-guide/install-zowe-zos-convenience-build.md index d3f87d0074..ab04419345 100644 --- a/docs/user-guide/install-zowe-zos-convenience-build.md +++ b/docs/user-guide/install-zowe-zos-convenience-build.md @@ -84,7 +84,7 @@ After you download the PAX file, you can transfer it to z/OS and expand its cont This is the Zowe runtime directory and is referred to as `` throughout this documentation. - **Note:** Zowe version 1 had a script `zowe-install.sh` that created a separate Zowe runtime directory from the expanded contents of the Zowe PAX file. Zowe v2 no longer has this step. **In Zowe v2, and Zowe v3 the contents of the expanded Zowe PAX file are the Zowe runtime directory.** + **Note:** In Zowe v2, and Zowe v3 the contents of the expanded Zowe PAX file are the Zowe runtime directory. ## Step 3: (Optional) Add the `zwe` command to your PATH @@ -148,19 +148,49 @@ SZWELOAD | Executable utilities library | ANY | U | PDSE | U | 0 | 15 | N/A The `SZWESAMP` data set contains the following members. -Member name | Purpose ----|--- -ZWESECUR | JCL member to configure z/OS user IDs and permissions required to run Zowe -ZWENOSEC | JCL member to undo the configuration steps performed in ZWESECUR and revert z/OS environment changes. -ZWEKRING | JCL member to configure a z/OS keyring containing the Zowe certificate -ZWENOKYR | JCL member to undo the configuration steps performed in ZWEKRING -ZWESLSTC | JCL to start Zowe -ZWEXMSTC | JCL to start the Zowe cross memory server -ZWESIP00 | Parmlib member for the cross memory server -ZWESASTC | Started task JCL for the cross memory Auxiliary server -ZWESIPRG | Console commands to APF authorize the cross memory server load library -ZWESISCH | PPT entries required by Cross memory server and its Auxiliary address spaces to run in Key(4) -ZWECSVSM | JCL Member to create the VSAM data set for the caching service +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. @@ -169,6 +199,7 @@ 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. From 5ef0f29987057bf34f91b886a5c3940ab597df2b Mon Sep 17 00:00:00 2001 From: Martin Zeithaml Date: Mon, 18 Nov 2024 15:13:31 +0100 Subject: [PATCH 5/8] Minor changes Signed-off-by: Martin Zeithaml --- .../install-zowe-zos-convenience-build.md | 40 ++++++++++++------- 1 file changed, 25 insertions(+), 15 deletions(-) diff --git a/docs/user-guide/install-zowe-zos-convenience-build.md b/docs/user-guide/install-zowe-zos-convenience-build.md index ab04419345..08f23a83ad 100644 --- a/docs/user-guide/install-zowe-zos-convenience-build.md +++ b/docs/user-guide/install-zowe-zos-convenience-build.md @@ -17,7 +17,7 @@ Complete the following steps to install the Zowe runtime. ## Step 1: Obtain the convenience build 1. To download the PAX file, open your web browser on the [Zowe Download](https://www.zowe.org/download.html) website. -2. Navigate to **Zowe V2 Preview** -> **Convenience build** section, and select the button to download the v2 convenience build. +2. Navigate to **Zowe V3** -> **Zowe 3.v.p z/OS Convenience build** section, and select the button to download the v3 convenience build. ## Step 2: Transfer the convenience build to USS and expand it @@ -59,6 +59,12 @@ After you download the PAX file, you can transfer it to z/OS and expand its cont **Note:** When your terminal is connected to z/OS through FTP or SFTP, you can prepend commands with `l` to have them issued against your desktop. To list the contents of a directory on your desktop, type `lls` where `ls` lists contents of a directory on z/OS. + :::tip + You can simplify `sftp` usage for existing directory: + ``` + echo 'put .pax' | sftp userID@ip.of.zos.box:/path/to/zowe/runtime + ``` + After the PAX file has sucessfully transferred, exit your `sftp` or `ftp` session. 1. Open a USS shell to expand the PAX file. This can either be an ssh terminal, OMVS, iShell, or any other z/OS unix system services command environment. @@ -94,23 +100,27 @@ The `zwe` command is provided in the `/bin` directory. You can opti export PATH=${PATH}:/bin ``` -`` should be replaced with your real Zowe runtime directory path. This will update the `PATH` for the current shell. To make this update persistent, you can add the line to your `~/.profile` file, or the `~/.bashProfile` file if you are using a bash shell. To make this update system wide, you can update the `/etc/.profile` file. Once the PATH is updated, you can execute the `zwe` command from any USS directory. For the remainder of the documentation when `zwe` command is referenced, it is assumed that it has been added to your `PATH`. +`` should be replaced with your real Zowe runtime directory path. This will update the `PATH` for the current shell. To make this update persistent, you can add the line to your `~/.profile` file, or the `~/.bashProfile` file if you are using a bash shell. To make this update system wide, you can update the `/etc/.profile` file. Once the `PATH` is updated, you can execute the `zwe` command from any USS directory. For the remainder of the documentation when `zwe` command is referenced, it is assumed that it has been added to your `PATH`. -The `zwe` command has built in help that can be retrieved with the `-h` suffix. For example, type `zwe -h` to display all of the supported commands. These are broken down into a number of sub-commands: +The `zwe` command has built in help that can be retrieved with the `-h` option. For example, type `zwe -h` to display all of the supported commands. These are broken down into a number of sub-commands: ``` zwe -h ... Available sub-command(s): - - certificate - - components - - init - - install - - internal - - sample - - start - - stop - - version + - certificate + - components + - config + - diagnose + - init + - install + - internal + - migrate + - sample + - start + - stop + - support + - version ``` ## Step 4: Copy the zowe.yaml configuration file to preferred location @@ -120,7 +130,7 @@ Copy the template file `/example-zowe.yaml` file to a new location, When you execute the `zwe` command, the `-c` argument is used to pass the location of a `zowe.yaml` file. :::tip -To avoid passing `--config` or `-c` to every `zwe` commands, you can define `ZWE_CLI_PARAMETER_CONFIG` environment variable points to location of zowe.yaml. +To avoid passing `--config` or `-c` to every `zwe` commands, you can define `ZWE_CLI_PARAMETER_CONFIG` environment variable pointing to location of `zowe.yaml`. For example, after defining @@ -137,7 +147,7 @@ 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 following three data sets. See the following table for the storage requirements. +Zowe includes a number of files that are stored in the following 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 ---|---|---|---|---|---|---|---|--- @@ -218,7 +228,7 @@ zowe: ``` To create and install the MVS data sets, use the command `zwe install`. -1. In a USS shell, execute the command `zwe install -c /path/to/zowe.yaml`. This creates the three data sets and copy across their content. +1. In a USS shell, execute the command `zwe install -c /path/to/zowe.yaml`. This creates the data sets and copy across their content. 2. If the data sets already exist, specify `--allow-overwritten`. 3. To see the full list of parameters, execute the command `zwe install -h`. From b8f7c931a43b9d64a4077f7cd0642145f832f758 Mon Sep 17 00:00:00 2001 From: Martin Zeithaml Date: Mon, 18 Nov 2024 15:16:11 +0100 Subject: [PATCH 6/8] Indentation update Signed-off-by: Martin Zeithaml --- .../install-zowe-zos-convenience-build.md | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/user-guide/install-zowe-zos-convenience-build.md b/docs/user-guide/install-zowe-zos-convenience-build.md index 08f23a83ad..d8cbf32d31 100644 --- a/docs/user-guide/install-zowe-zos-convenience-build.md +++ b/docs/user-guide/install-zowe-zos-convenience-build.md @@ -108,19 +108,19 @@ The `zwe` command has built in help that can be retrieved with the `-h` option. zwe -h ... Available sub-command(s): - - certificate - - components - - config - - diagnose - - init - - install - - internal - - migrate - - sample - - start - - stop - - support - - version + - certificate + - components + - config + - diagnose + - init + - install + - internal + - migrate + - sample + - start + - stop + - support + - version ``` ## Step 4: Copy the zowe.yaml configuration file to preferred location From 0b2d38bc412ccadfba6a71991867d46a8ea8e90d Mon Sep 17 00:00:00 2001 From: Martin Zeithaml Date: Tue, 19 Nov 2024 12:56:00 +0100 Subject: [PATCH 7/8] Minor updates Signed-off-by: Martin Zeithaml --- docs/user-guide/install-zowe-zos-convenience-build.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/user-guide/install-zowe-zos-convenience-build.md b/docs/user-guide/install-zowe-zos-convenience-build.md index d8cbf32d31..e45cb1d15d 100644 --- a/docs/user-guide/install-zowe-zos-convenience-build.md +++ b/docs/user-guide/install-zowe-zos-convenience-build.md @@ -64,6 +64,7 @@ After you download the PAX file, you can transfer it to z/OS and expand its cont ``` echo 'put .pax' | sftp userID@ip.of.zos.box:/path/to/zowe/runtime ``` + ::: After the PAX file has sucessfully transferred, exit your `sftp` or `ftp` session. @@ -147,7 +148,7 @@ 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 following data sets. See the following table for the storage requirements. +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 ---|---|---|---|---|---|---|---|--- From f5d2747958289894a5c28677688d89f51f27f546 Mon Sep 17 00:00:00 2001 From: Andrew Jandacek Date: Wed, 20 Nov 2024 11:02:42 +0100 Subject: [PATCH 8/8] fix link Signed-off-by: Andrew Jandacek --- docs/user-guide/install-zowe-zos-convenience-build.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user-guide/install-zowe-zos-convenience-build.md b/docs/user-guide/install-zowe-zos-convenience-build.md index e45cb1d15d..562ea55277 100644 --- a/docs/user-guide/install-zowe-zos-convenience-build.md +++ b/docs/user-guide/install-zowe-zos-convenience-build.md @@ -1,10 +1,10 @@ # Installing the z/OS Build via Convenience Build (PAX file) -You install the Zowe™ convenience build by obtaining a PAX file and using this to create the Zowe runtime environment. +You can install the Zowe™ convenience build by obtaining a PAX file which is used to create the Zowe runtime environment. ## Introduction -The Zowe installation file for Zowe z/OS components is distributed as a PAX file that contains the runtimes and the scripts to install and launch the z/OS runtime. You must obtain the PAX file and transfer it to z/OS first. Then, to install, configure and start Zowe, you use the `zwe` command. This command defines help messages, logging options, and more. For details about how to use this command, see the [ZWE Server Command Reference](../appendix/zwe_server_command_reference/zwe/zwe.md). +The Zowe installation file for Zowe z/OS components is distributed as a PAX file that contains the runtimes and the scripts to install and launch the z/OS runtime. You must obtain the PAX file and transfer it to z/OS first. Then, to install, configure, and start Zowe, you use the `zwe` command. This command defines help messages, logging options, and more. For details about how to use this command, see the [ZWE Server Command Reference](../appendix/zwe_server_command_reference/zwe/zwe.md). The configuration data that is read by the `zwe` command are stored in a YAML configuration file named `zowe.yaml`. You modify the `zowe.yaml` file based on your environment. @@ -262,4 +262,4 @@ Copy components/zss/LOADLIB/ZWESAUX to IBMUSER.ZWEV2.SZWEAUTH ## Next steps -You successfully installed Zowe from the convenience build! However, before you start Zowe, you must complete several required configurations. The next step is to [Initialize the z/OS system and permissions](initialize-zos-system.md) for Zowe. +You successfully installed Zowe from the convenience build! However, before you start Zowe, you must complete several required configurations. The next step is [Initializing Zowe z/OS runtime](./configure-zowe-runtime.md).