diff --git a/docs/user-guide/configure-sysplex.md b/docs/user-guide/configure-sysplex.md index fe5fed7e06..c14dffe362 100644 --- a/docs/user-guide/configure-sysplex.md +++ b/docs/user-guide/configure-sysplex.md @@ -31,7 +31,7 @@ The following example DVIPA configuration ensures the availability of Zowe in Ho 2. Define a DVIPA for both systems: - ``` + ```plaintext VIPADYNAMIC VIPADEFINE 255.255.255.0 x.x.x.V VIPADISTRIBUTE DEFINE DISTM HOTSTANDBY x.x.x.V @@ -61,7 +61,7 @@ If SYSA fails, new work requests to Zowe are routed to the server on SYSB. When If you do not want the distributor to switch back to the preferred target when it becomes available, you can specify the `NOAUTOSWITCHBACK` parameter for the `VIPADISTRIBUTE` statement. -``` +```plaintext VIPADYNAMIC VIPADEFINE 255.255.255.0 x.x.x.V VIPADISTRIBUTE DEFINE DISTM HOTSTANDBY NOAUTOSWITCHBACK x.x.x.V @@ -70,4 +70,3 @@ VIPADYNAMIC x.x.x.B BACKUP ENDVIPADYNAMIC ``` - diff --git a/docs/user-guide/configuring-at-tls-for-zowe-server.md b/docs/user-guide/configuring-at-tls-for-zowe-server.md index e65749fa80..8f4e94b399 100644 --- a/docs/user-guide/configuring-at-tls-for-zowe-server.md +++ b/docs/user-guide/configuring-at-tls-for-zowe-server.md @@ -385,7 +385,7 @@ TTLSRule ZoweServerRule { LocalAddr All RemoteAddr All - LocalPortRange 7554-7559 # Range covers all possible Zowe services + LocalPortRange 7551-7559 # Range covers all possible Zowe services Jobname ZWE1* Direction Inbound TTLSGroupActionRef ServerGroupAction diff --git a/docs/user-guide/install-zowe-pswi-acquire.md b/docs/user-guide/install-zowe-pswi-acquire.md index 1714d8e0b6..1bcfaf5028 100644 --- a/docs/user-guide/install-zowe-pswi-acquire.md +++ b/docs/user-guide/install-zowe-pswi-acquire.md @@ -4,56 +4,62 @@ As a systems programmer, you can acquire an IBM z/OSMF portable package for your When you complete the acquisition process, the product software is ready for installation using z/OSMF Deployments. -- **Note**: Before you begin the acquisition process, ensure that you address the z/OSMF requirements. +:::note +Before you begin the acquisition process, ensure that you address the z/OSMF requirements. +::: The z/OSMF product acquisition process consists of 2 tasks. -1. Download the portable software instance from Zowe downloads and transfer it to the mainframe. +1. Download the portable software instance from Zowe downloads and transfer the instance to the mainframe. 2. Register the portable software instance in z/OSMF. ## Download the Portable Software Instance from Zowe Downloads The portable software instance is a portable form of a software instance, including the SMP/E CSI data sets, all associated SMP/E-managed target and distribution libraries, non-SMP/E-managed data sets, and meta-data that is required to describe the product software instance. -To acquire the portable software instance, you can download it from the Zowe Downloads page and transfer it to a local z/OSMF host using a file transfer utility, such as FTP. +To acquire the portable software instance, you can download it from the Zowe Downloads page and transfer the instance to a local z/OSMF host using a file transfer utility, such as FTP. 1. Go to [Zowe Downloads](https://www.zowe.org/download.html) and find **Zowe - Portable Software Instance**. 2. Download the latest version of the package to your workstation. -3. Use an file transfer utility such as an FTP client to transfer the single pax file to the mainframe. -4. Execute the JCL to unpack the installation file and restore the individual pax files. Sample JCL follows: -``` - //USSBATCH EXEC PGM=BPXBATCH - //STDOUT DD SYSOUT=* - //STDERR DD SYSOUT=* - //STDPARM DD * - sh cd /yourUSSpaxdirectory/; - pax -rvf yourpaxfilename.ZOSMF.pax.Z - /* -``` +3. Use a file transfer utility such as an FTP client to transfer the single pax file to the mainframe. +4. Execute the JCL to unpack the installation file and restore the individual pax files. + +**Sample JCL:** + + ```jcl + //USSBATCH EXEC PGM=BPXBATCH + //STDOUT DD SYSOUT=* + //STDERR DD SYSOUT=* + //STDPARM DD * + sh cd /yourUSSpaxdirectory/; + pax -rvf yourpaxfilename.ZOSMF.pax.Z + /* + ``` + 5. Customize the sample JCL as follows and then submit for execution: 1. Add a JOB statement. 2. Update the USS directory (*yourUSSpaxdirectory*) with the path name where you want to copy the pax file. 3. Update *yourpaxfilename* with the name of the pax file that you want to copy to the mainframe. -:::tip Expected results: -USSBATCH can take several minutes to execute. You will receive a return code of 0 if this job runs correctly. +:::tip Expected results: +USSBATCH can take several minutes to execute. You will receive a return code of `0` if this job runs correctly. ::: -After successful execution, the individual pax files are restored and ready for use. Next step is to Register Portable Software Instance in z/OSMF. +After successful execution, the individual pax files are restored and ready for use. The next step is to register the Portable Software Instance in z/OSMF. ## Register Portable Software Instance in z/OSMF -After you have acquired and downloaded the portable software instance to a local z/OSMF host system, you must log in to z/OSMF to register the product software and define the portable software instance to z/OSMF as shown in the following procedure. When you complete these steps, the portable software instance is registered in z/OSMF and ready for installation (deployment). +After you have acquired and downloaded the portable software instance to a local z/OSMF host system, it is necessary to log in to z/OSMF to register the product software and define the portable software instance to z/OSMF as shown in the following procedure. When you complete these steps, the portable software instance is registered in z/OSMF and ready for installation (deployment). 1. Log in to the z/OSMF web interface and select your user ID in the top or bottom right-hand corner to switch between the Desktop Interface and Classic Interface. 2. Complete **either** of the following steps to display the Software Management page: 1. In the Desktop Interface, select **Software Management**. 2. In the Classic Interface, select **Software**, **Software Management**. 3. Select **Portable Software Instances** to define your portable software instance to z/OSMF. -4. Select **Add** from the Actions menu and select **From z/OSMF System**. Then the Add Portable Software Instance page should display. +4. Select **Add** from the Actions menu and select **From z/OSMF System**. The _Add Portable Software Instance_ page should display. 5. Select or type the system name (destination LPAR) and UNIX directory (destination USS directory) where the portable software instance files reside and select **Retrieve**. 6. Enter a name for the new portable software instance. You can also enter an optional description and assign one or more categories that display existing packages. 7. Select **OK**. -Now the new portable software instance is defined to z/OSMF. And the portable software instance is now registered in z/OSMF and ready to install (deploy). +The new portable software instance is now defined to z/OSMF, and the portable software instance is registered in z/OSMF and ready to install (deploy). diff --git a/docs/user-guide/install-zowe-pswi-deployment.md b/docs/user-guide/install-zowe-pswi-deployment.md index e751605e59..ae9e18ce1a 100644 --- a/docs/user-guide/install-zowe-pswi-deployment.md +++ b/docs/user-guide/install-zowe-pswi-deployment.md @@ -5,20 +5,27 @@ After the portable software instance or software instance is registered in z/OSMF, you can use z/OSMF Deployments to install the product software and create the product data sets (global, CSI, target libraries, and distribution libraries) for the new software instance. The deployment jobs create a copy of the source product data sets to create the product target runtime environment. Creating a copy of the SMP/E target data sets keeps the SMP/E environment clean and separates the product runtime environment for maintenance activities. You can also perform z/OSMF workflows to customize the SMP/E data sets, mount UNIX System Services (USS) files if necessary, and configure the new software instance on the target system. -To install Zowe PSWI using z/OSMF and make the product software available for use on a system by users and other programs, you need to define a new deployment. This step defines the SMP/E environment name and the prefix of the CSI data set in z/OSMF. Specify data set allocation parameters for all SMP/E data sets, target libraries, and distribution libraries. +## Prerequisite - Define a new deployment -To define a new deployment, complete the deployment checklist (specify the USS path, DSN, VOLSERs), and submit the deployment jobs through the z/OSMF user interface. When the deployment is complete, you have a source and target copy of the software. +To install Zowe PSWI using z/OSMF and make the product software available for use on a system by users and other programs, you first need to define a new deployment. This step defines the SMP/E environment name and the prefix of the CSI data set in z/OSMF. Specify data set allocation parameters for all SMP/E data sets, target libraries, and distribution libraries. -For more information about these tasks, see [Deploying software](https://www.ibm.com/docs/en/zos/2.4.0?topic=task-deploying-software) in the IBM documentation. +To define a new deployment, complete the deployment checklist as specified in [Deploying software](https://www.ibm.com/docs/en/zos/2.4.0?topic=task-deploying-software) in the IBM documentation. +Specify the following configuration elements: + +* UNIX System Services path (USS path) +* Data Set Name (DNS) +* Volume Serial Numbers (VOLSERs) + +Then submit the deployment jobs through the z/OSMF user interface. When the deployment is complete, you have a source and target copy of the software. Subsequent product maintenance activities update the SMP/E environment without affecting your active product runtime environments. You can decide when to redeploy the maintenance-updated SMP/E target data sets to each of the product runtime environments. -Before installing, ensure the [z/OSMF requirements](install-zowe-pswi-address-requirements#confirm-that-the-installer-has-read-create-update-and-execute-privileges-in-zos) are met. +Before installing, ensure the [z/OSMF requirements](./install-zowe-pswi-address-requirements.md#confirm-that-the-installer-has-read-create-update-and-execute-privileges-in-zos) are met. ## Installing process 1. Display the Deployments table in z/OSMF (**Software ManagementU**, **Deployments**). -2. Define a new deployment by selecting **New** from the Actions menu. The deployment checklist displays, where you can also modify, view, copy, cancel, or remove existing deployments. +2. Define a new deployment by selecting **New** from the Actions menu. The deployment checklist displays where you can also modify, view, copy, cancel, or remove existing deployments. 3. Complete the deployment checklist items as described in _Defining new deployments_ in the IBM documentation. As you complete the deployment checklist, be sure to make the following selections: 1. Specify the properties for this deployment (name, description, and optional category). @@ -41,26 +48,72 @@ Before installing, ensure the [z/OSMF requirements](install-zowe-pswi-address-re **Example:** `_targetpathname_**/staticpathextension**`. **Note:** If your product does not include USS directories, ignore this instruction. - 6. Define the job settings to generate the JCL to install the software and view the deployment summary. Update the JOB statement as needed. - **Note:** If the target system for the deployment is in a JES Multi-Access Spool (MAS) and the mount point is only accessible from the target system, add a System Affinity (SYSAFF) to the job card to ensure execution on the system where the zFS resides. + 6. Define the job settings to generate the JCL to install the software and view the deployment summary. Update the JOB statement as needed. + + **Note:** If the target system for the deployment is in a JES Multi-Access Spool (MAS) and the mount point is only accessible from the target system, add a System Affinity (SYSAFF) to the job card to ensure execution on the system where the zFS resides. + + 7. Submit the deployment jobs in sequential order. Wait for each job to complete, and then select **Refresh** to register job completion in z/OSMF. + + :::tip Expected results: + You will receive a return code of `0` if this job runs correctly. When all deployment jobs are executed successfully, you have unzipped, renamed and copied the product data sets, updated the CSI data set, and specified the properties for the target software instance. + ::: - 7. Submit the deployment jobs in sequential order, wait for each job to complete, and then select **Refresh** to register job completion in z/OSMF. - :::tip Expected results: - You will receive a return code of 0 if this job runs correctly. When all deployment jobs are executed successfully, you have unzipped, renamed and copied the product data sets, updated the CSI data set, and specified the properties for the target software instance. - ::: - 8. Complete **Mount Workflow** to mount the Zowe zFS. Complete both steps in the workflow. Perform the following steps to execute each step individually: 1. Click the title of the step. - 2. Select the Perform tab. + 2. Select the **Perform** tab. 3. Review the step contents and update the JCL if needed. - 4. Select Next. - 5. Repeat the previous two steps to complete all items until the Finish option is available. + 4. Select **Next**. + 5. Repeat the previous two steps to complete all items until the **Finish** option is available. 9. (Optional) To configure your Zowe instance, follow the procedure in [Configuring Zowe with z/OSMF Workflows](configure-zowe-zosmf-workflow.md). 10. Specify the name and description of the new target software instance. - - All workflows that are mentioned in the previous steps are part of the PSWI. - **Note:** You do not have to execute all workflows during PSWI provisioning in z/OSMF immediately. +:::note Notes +* All workflows that are mentioned in the previous steps are part of the PSWI. +* You do not have to execute all workflows during PSWI provisioning in z/OSMF immediately. +::: The deployment process is complete. The new software instance is defined to z/OSMF. You are now ready to Import Product Information into z/OSMF before you install product maintenance. + +## Recommendations + +### Cleanup + +If there is a need to update the deployment settings such as the HLQ after a previous run, note that the deployment process does not perform a full cleanup of the datasets. +Before attempting job execution again, make sure the following datasets are deleted to avoid write conflicts: + +```plaintext +{TARGET_HLQ}.PRODUCT.ZOWE.V2.CSI +{TARGET_HLQ}.PRODUCT.ZOWE.V2.D.AZWEAUTH.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.D.AZWESAMP.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.D.AZWEZFS.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.SMPLOG.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.SMPLOGA.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.SMPLTS.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.SMPMTS.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.SMPPTS.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.SMPSCDS.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.SMPSTS.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.T.SZWEAUTH.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.T.SZWEEXEC.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.T.SZWELOAD.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.T.SZWESAMP.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.WORKFLOW.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.ZFS.# +``` + +If deployment options must be modified and the JCL recreated, first check the original JCL for the temporary ZFS dataset name. + +**Example:** +`.SWDEPL..ZFS` + + Delete this name manually. + + :::note + Note that the deployment job is unable to clean this data set name once the data set is recreated because the value for `random_id` will change. + ::: + +### Resources + +It is recommended to update the job card to run with `REGION=0M`, particularly for job `IZUD01DZ` which unpaxes the contents. diff --git a/docs/user-guide/install-zowe-pswi.md b/docs/user-guide/install-zowe-pswi.md index e8d58e1901..824b92475a 100644 --- a/docs/user-guide/install-zowe-pswi.md +++ b/docs/user-guide/install-zowe-pswi.md @@ -3,7 +3,7 @@ As a systems programmer, your responsibilities include acquiring, installing, maintaining, and configuring mainframe products on your systems. z/OSMF lets you perform these tasks. z/OSMF lets you manage software on your z/OS systems through a browser at any time, from any location. By streamlining some traditional tasks and automating others, z/OSMF can simplify some areas of system management and also reduce the level of expertise that is required for managing system activities. Experienced users can view, define, and update policies that affect system behavior, monitor system performance, and manage their z/OS software. As products and vendors adopt z/OSMF services, you can install and maintain all your mainframe products in a common way according to industry best practices. After configuration is complete, you can execute the product and easily provision new software instances for use on other systems throughout your environment. -## End-to-end installation diagram +## End-to-end installation diagram ![PSWI installation diagram](../images/install/PSWI-install.png) @@ -19,19 +19,17 @@ To install Zowe using z/OSMF, ensure that you meet the following requirements: Refer to the following subpages to guide you through the installation procedure using z/OSMF. -* [Address z/OSMF Requirements](./install-zowe-pswi-address-requirements.md) - +- [Address z/OSMF Requirements](./install-zowe-pswi-address-requirements.md) Provides information about z/OSMF general configuration and security requirements. -* [Acquire a z/OSMF Portable Software Instance](./install-zowe-pswi-acquire.md) - +- [Acquire a z/OSMF Portable Software Instance](./install-zowe-pswi-acquire.md) Provides the steps to acquire the product software by downloading the z/OSMF portable software instance to the z/OSMF host. You must then register the portable software instance in z/OSMF. -* [Install Product Software Using z/OSMF Deployments](./install-zowe-pswi-deployment.md) - +- [Install Product Software Using z/OSMF Deployments](./install-zowe-pswi-deployment.md) Provides the steps to install (deploy) the portable software instance to an LPAR using z/OSMF Deployments. This step creates the SMP/E environment and runs the RECEIVE, APPLY, and ACCEPT steps to prepare the software instance for SMP/E operations. This step also: - * Customizes the data set names that are defined to SMP/E. - * Mounts required USS files if necessary. - * Performs workflow execution to customize the deployed runtime environment for use on a specific z/OS system. + + - Customizes the data set names that are defined to SMP/E. + - Mounts required USS files if necessary. + - Performs workflow execution to customize the deployed runtime environment for use on a specific z/OS system. When these tasks are completed, you are ready to install preventive maintenance. diff --git a/docs/user-guide/zos-components-installation-checklist-dev.md b/docs/user-guide/zos-components-installation-checklist-dev.md index bf36e325f8..346605fb50 100644 --- a/docs/user-guide/zos-components-installation-checklist-dev.md +++ b/docs/user-guide/zos-components-installation-checklist-dev.md @@ -43,7 +43,7 @@ Use one of the following installation options to install Zowe z/OS components. | Verification Step | Task | Results | Time Estimate | |----|-----------|----|-------------| | [Verify Zowe Application Framework installation](../user-guide/verify-zowe-runtime-install.md#verifying-zowe-application-framework-installation) | Open the Zowe Desktop from a supported browser | You should be able to open the Zowe Desktop from a supported browser. | 20 minutes| -| [Verify API Mediation installation](../user-guide/verify-zowe-runtime-install.md#verifying-api-mediation-installation) |Use a REST API client to review the value of the status variable of the API Catalog service routed through the API Gateway | See the example presented in Verify API Mediation installation | 15 minutes | +| [Verify API Mediation installation](../user-guide/verify-zowe-runtime-install.md#verifying-api-mediation-layer-installation) |Use a REST API client to review the value of the status variable of the API Catalog service routed through the API Gateway | See the example presented in Verify API Mediation installation | 15 minutes | |[Verify z/OS Services installation](../user-guide/verify-zowe-runtime-install.md#verifying-zos-services-installation) |Zowe z/OS services usually are registered with Zowe APIML Discovery| You should see JSON format data of all jobs running on the system | 15 minutes | diff --git a/versioned_docs/version-v2.18.x/user-guide/configure-sysplex.md b/versioned_docs/version-v2.18.x/user-guide/configure-sysplex.md index 4cd8cafc55..e45e2f3e9c 100644 --- a/versioned_docs/version-v2.18.x/user-guide/configure-sysplex.md +++ b/versioned_docs/version-v2.18.x/user-guide/configure-sysplex.md @@ -10,12 +10,13 @@ Zowe high availability instances require a Sysplex environment that consists of - At least one coupling facility - At least one Sysplex timer - Connection to shared DASD -- Shared SAF database, see [Sharing a database with sysplex communication in data sharing mode](https://www.ibm.com/docs/en/zos/2.1.0?topic=sd-sharing-database-sysplex-communication-in-data-sharing-mode) -- Sysplex Distributor with configured Dynamic VIPA TCP/IP address, see [Configuring Sysplex Distributor](#configuring-sysplex-distributor) for instructions -- VSAM record-level sharing (RLS), see [Preparing for VSAM record-level sharing](https://www.ibm.com/docs/en/zos/2.4.0?topic=sharing-preparing-vsam-record-level) -- USS Shared file system, see [How to share file systems in a Sysplex](https://www.ibm.com/docs/en/zos/2.4.0?topic=planning-sharing-file-systems-in-sysplex) +- Shared SAF database. See [Sharing a database with sysplex communication in data sharing mode](https://www.ibm.com/docs/en/zos/2.1.0?topic=sd-sharing-database-sysplex-communication-in-data-sharing-mode) +- Sysplex Distributor with configured Dynamic VIPA TCP/IP address. See [Configuring Sysplex Distributor](#configuring-sysplex-distributor) for instructions +- VSAM record-level sharing (RLS). See [Preparing for VSAM record-level sharing](https://www.ibm.com/docs/en/zos/2.4.0?topic=sharing-preparing-vsam-record-level) + - Not required if using infinispan as Caching Service solution. VSAM storage for the Caching Service is deprecated and will be removed in a future release. +- USS Shared file system. See [How to share file systems in a Sysplex](https://www.ibm.com/docs/en/zos/2.4.0?topic=planning-sharing-file-systems-in-sysplex) - JESPlex/JES2 Multi-Access Spool (MAS) environment -- z/OSMF high availability, see [Configuring z/OSMF high availability in Sysplex](systemrequirements-zosmf-ha.md) +- z/OSMF high availability. See [Configuring z/OSMF high availability in Sysplex](systemrequirements-zosmf-ha.md) - Node.js v14.x (except v14.17.2), or v16.x :::note @@ -32,7 +33,7 @@ The following example DVIPA configuration ensures the availability of Zowe in Ho 2. Define a DVIPA for both systems: - ``` + ```plaintext VIPADYNAMIC VIPADEFINE 255.255.255.0 x.x.x.V VIPADISTRIBUTE DEFINE DISTM HOTSTANDBY x.x.x.V @@ -41,8 +42,7 @@ The following example DVIPA configuration ensures the availability of Zowe in Ho x.x.x.B BACKUP ENDVIPADYNAMIC ``` - - where, + - **x.x.x.A** Specifies the home address for SYSA. @@ -62,7 +62,7 @@ If SYSA fails, new work requests to Zowe are routed to the server on SYSB. When If you do not want the distributor to switch back to the preferred target when it becomes available, you can specify the `NOAUTOSWITCHBACK` parameter for the `VIPADISTRIBUTE` statement. -``` +```plaintext VIPADYNAMIC VIPADEFINE 255.255.255.0 x.x.x.V VIPADISTRIBUTE DEFINE DISTM HOTSTANDBY NOAUTOSWITCHBACK x.x.x.V @@ -71,4 +71,3 @@ VIPADYNAMIC x.x.x.B BACKUP ENDVIPADYNAMIC ``` - diff --git a/versioned_docs/version-v2.18.x/user-guide/configuring-at-tls-for-zowe-server.md b/versioned_docs/version-v2.18.x/user-guide/configuring-at-tls-for-zowe-server.md index 0f3f56ca33..8806609461 100644 --- a/versioned_docs/version-v2.18.x/user-guide/configuring-at-tls-for-zowe-server.md +++ b/versioned_docs/version-v2.18.x/user-guide/configuring-at-tls-for-zowe-server.md @@ -209,7 +209,7 @@ TTLSRule ApimlClientRule LocalAddr All LocalPortRange 1024-65535 RemoteAddr All - RemotePortRange 7551-7555 # Range covers API ML services (gateway, discovery, api catalog, caching service) + RemotePortRange 7551-7559 # Range covers API ML services (gateway, discovery, api catalog, caching service) Jobname ZWE1A* # Generate according to zowe.job.prefix in zowe.yaml Direction Outbound TTLSGroupActionRef ClientGroupAction @@ -393,7 +393,7 @@ TTLSRule ZoweServerRule { LocalAddr All RemoteAddr All - LocalPortRange 7554-7559 # Range covers all possible Zowe services + LocalPortRange 7551-7559 # Range covers all possible Zowe services Jobname ZWE1* Direction Inbound TTLSGroupActionRef ServerGroupAction diff --git a/versioned_docs/version-v2.18.x/user-guide/install-zowe-pswi-acquire.md b/versioned_docs/version-v2.18.x/user-guide/install-zowe-pswi-acquire.md index 1714d8e0b6..e477b38278 100644 --- a/versioned_docs/version-v2.18.x/user-guide/install-zowe-pswi-acquire.md +++ b/versioned_docs/version-v2.18.x/user-guide/install-zowe-pswi-acquire.md @@ -4,24 +4,29 @@ As a systems programmer, you can acquire an IBM z/OSMF portable package for your When you complete the acquisition process, the product software is ready for installation using z/OSMF Deployments. -- **Note**: Before you begin the acquisition process, ensure that you address the z/OSMF requirements. +:::note +Before you begin the acquisition process, ensure that you address the z/OSMF requirements. +::: The z/OSMF product acquisition process consists of 2 tasks. -1. Download the portable software instance from Zowe downloads and transfer it to the mainframe. +1. Download the portable software instance from Zowe downloads and transfer the instance to the mainframe. 2. Register the portable software instance in z/OSMF. ## Download the Portable Software Instance from Zowe Downloads The portable software instance is a portable form of a software instance, including the SMP/E CSI data sets, all associated SMP/E-managed target and distribution libraries, non-SMP/E-managed data sets, and meta-data that is required to describe the product software instance. -To acquire the portable software instance, you can download it from the Zowe Downloads page and transfer it to a local z/OSMF host using a file transfer utility, such as FTP. +To acquire the portable software instance, you can download it from the Zowe Downloads page and transfer the instance to a local z/OSMF host using a file transfer utility, such as FTP. 1. Go to [Zowe Downloads](https://www.zowe.org/download.html) and find **Zowe - Portable Software Instance**. 2. Download the latest version of the package to your workstation. 3. Use an file transfer utility such as an FTP client to transfer the single pax file to the mainframe. -4. Execute the JCL to unpack the installation file and restore the individual pax files. Sample JCL follows: -``` +4. Execute the JCL to unpack the installation file and restore the individual pax files. + +**Sample JCL:** + +```jcl //USSBATCH EXEC PGM=BPXBATCH //STDOUT DD SYSOUT=* //STDERR DD SYSOUT=* @@ -30,30 +35,31 @@ To acquire the portable software instance, you can download it from the Zowe Dow pax -rvf yourpaxfilename.ZOSMF.pax.Z /* ``` + 5. Customize the sample JCL as follows and then submit for execution: 1. Add a JOB statement. 2. Update the USS directory (*yourUSSpaxdirectory*) with the path name where you want to copy the pax file. 3. Update *yourpaxfilename* with the name of the pax file that you want to copy to the mainframe. -:::tip Expected results: -USSBATCH can take several minutes to execute. You will receive a return code of 0 if this job runs correctly. +:::tip Expected results: +USSBATCH can take several minutes to execute. You will receive a return code of `0` if this job runs correctly. ::: -After successful execution, the individual pax files are restored and ready for use. Next step is to Register Portable Software Instance in z/OSMF. +After successful execution, the individual pax files are restored and ready for use. The next step is to register the Portable Software Instance in z/OSMF. ## Register Portable Software Instance in z/OSMF -After you have acquired and downloaded the portable software instance to a local z/OSMF host system, you must log in to z/OSMF to register the product software and define the portable software instance to z/OSMF as shown in the following procedure. When you complete these steps, the portable software instance is registered in z/OSMF and ready for installation (deployment). +After you have acquired and downloaded the portable software instance to a local z/OSMF host system, it is necessary to log in to z/OSMF to register the product software and define the portable software instance to z/OSMF as shown in the following procedure. When you complete these steps, the portable software instance is registered in z/OSMF and ready for installation (deployment). 1. Log in to the z/OSMF web interface and select your user ID in the top or bottom right-hand corner to switch between the Desktop Interface and Classic Interface. 2. Complete **either** of the following steps to display the Software Management page: 1. In the Desktop Interface, select **Software Management**. 2. In the Classic Interface, select **Software**, **Software Management**. 3. Select **Portable Software Instances** to define your portable software instance to z/OSMF. -4. Select **Add** from the Actions menu and select **From z/OSMF System**. Then the Add Portable Software Instance page should display. +4. Select **Add** from the Actions menu and select **From z/OSMF System**. The _Add Portable Software Instance_ page should display. 5. Select or type the system name (destination LPAR) and UNIX directory (destination USS directory) where the portable software instance files reside and select **Retrieve**. 6. Enter a name for the new portable software instance. You can also enter an optional description and assign one or more categories that display existing packages. 7. Select **OK**. -Now the new portable software instance is defined to z/OSMF. And the portable software instance is now registered in z/OSMF and ready to install (deploy). +The new portable software instance is now defined to z/OSMF. The portable software instance is registered in z/OSMF and ready to install (deploy). diff --git a/versioned_docs/version-v2.18.x/user-guide/install-zowe-pswi-deployment.md b/versioned_docs/version-v2.18.x/user-guide/install-zowe-pswi-deployment.md index 866723aee8..ddf71495bb 100644 --- a/versioned_docs/version-v2.18.x/user-guide/install-zowe-pswi-deployment.md +++ b/versioned_docs/version-v2.18.x/user-guide/install-zowe-pswi-deployment.md @@ -5,20 +5,28 @@ After the portable software instance or software instance is registered in z/OSMF, you can use z/OSMF Deployments to install the product software and create the product data sets (global, CSI, target libraries, and distribution libraries) for the new software instance. The deployment jobs create a copy of the source product data sets to create the product target runtime environment. Creating a copy of the SMP/E target data sets keeps the SMP/E environment clean and separates the product runtime environment for maintenance activities. You can also perform z/OSMF workflows to customize the SMP/E data sets, mount UNIX System Services (USS) files if necessary, and configure the new software instance on the target system. -To install Zowe PSWI using z/OSMF and make the product software available for use on a system by users and other programs, you need to define a new deployment. This step defines the SMP/E environment name and the prefix of the CSI data set in z/OSMF. Specify data set allocation parameters for all SMP/E data sets, target libraries, and distribution libraries. +## Prerequisite - Define a new deployment -To define a new deployment, complete the deployment checklist (specify the USS path, DSN, VOLSERs), and submit the deployment jobs through the z/OSMF user interface. When the deployment is complete, you have a source and target copy of the software. +To install Zowe PSWI using z/OSMF and make the product software available for use on a system by users and other programs, you need to define a new deployment. This step defines the SMP/E environment name and the prefix of the CSI data set in z/OSMF. Specify data set allocation parameters for all SMP/E data sets, target libraries, and distribution libraries. -For more information about these tasks, see [Deploying software](https://www.ibm.com/docs/en/zos/2.4.0?topic=task-deploying-software) in the IBM documentation. +To define a new deployment, complete the deployment checklist as specified in [Deploying software](https://www.ibm.com/docs/en/zos/2.4.0?topic=task-deploying-software) in the IBM documentation. +Specify the following configuration elements: + +* UNIX System Services path (USS path) +* Data Set Name (DNS) +* Volume Serial Numbers (VOLSERs) + +Then submit the deployment jobs through the z/OSMF user interface. When the deployment is complete, you have a source and target copy of the software. Subsequent product maintenance activities update the SMP/E environment without affecting your active product runtime environments. You can decide when to redeploy the maintenance-updated SMP/E target data sets to each of the product runtime environments. -Before installing, ensure the [z/OSMF requirements](install-zowe-pswi-address-requirements#confirm-that-the-installer-has-read-create-update-and-execute-privileges-in-zos) are met. +Before installing, ensure the [z/OSMF requirements](./install-zowe-pswi-address-requirements.md#confirm-that-the-installer-has-read-create-update-and-execute-privileges-in-zos) +are met. ## Installing process 1. Display the Deployments table in z/OSMF (**Software ManagementU**, **Deployments**). -2. Define a new deployment by selecting **New** from the Actions menu. The deployment checklist displays, where you can also modify, view, copy, cancel, or remove existing deployments. +2. Define a new deployment by selecting **New** from the Actions menu. The deployment checklist displays where you can also modify, view, copy, cancel, or remove existing deployments. 3. Complete the deployment checklist items as described in _Defining new deployments_ in the IBM documentation. As you complete the deployment checklist, be sure to make the following selections: 1. Specify the properties for this deployment (name, description, and optional category). @@ -41,26 +49,72 @@ Before installing, ensure the [z/OSMF requirements](install-zowe-pswi-address-re **Example:** `_targetpathname_**/staticpathextension**`. **Note:** If your product does not include USS directories, ignore this instruction. - 6. Define the job settings to generate the JCL to install the software and view the deployment summary. Update the JOB statement as needed. - **Note:** If the target system for the deployment is in a JES Multi-Access Spool (MAS) and the mount point is only accessible from the target system, add a System Affinity (SYSAFF) to the job card to ensure execution on the system where the zFS resides. + 6. Define the job settings to generate the JCL to install the software and view the deployment summary. Update the JOB statement as needed. + + **Note:** If the target system for the deployment is in a JES Multi-Access Spool (MAS) and the mount point is only accessible from the target system, add a System Affinity (SYSAFF) to the job card to ensure execution on the system where the zFS resides. - 7. Submit the deployment jobs in sequential order, wait for each job to complete, and then select **Refresh** to register job completion in z/OSMF. - :::tip Expected results: - You will receive a return code of 0 if this job runs correctly. When all deployment jobs are executed successfully, you have unzipped, renamed and copied the product data sets, updated the CSI data set, and specified the properties for the target software instance. + 7. Submit the deployment jobs in sequential order, wait for each job to complete, and then select **Refresh** to register job completion in z/OSMF. + + :::tip Expected results: + You will receive a return code of `0` if this job runs correctly. When all deployment jobs are executed successfully, you have unzipped, renamed and copied the product data sets, updated the CSI data set, and specified the properties for the target software instance. ::: - + 8. Complete **Mount Workflow** to mount the Zowe zFS. Complete both steps in the workflow. Perform the following steps to execute each step individually: 1. Click the title of the step. - 2. Select the Perform tab. + 2. Select the **Perform** tab. 3. Review the step contents and update the JCL if needed. - 4. Select Next. - 5. Repeat the previous two steps to complete all items until the Finish option is available. + 4. Select **Next**. + 5. Repeat the previous two steps to complete all items until the **Finish** option is available. 9. (Optional) To configure your Zowe instance, follow the procedure in [Configuring Zowe with z/OSMF Workflows](configure-zowe-zosmf-workflow.md). 10. Specify the name and description of the new target software instance. - - All workflows that are mentioned in the previous steps are part of the PSWI. - **Note:** You do not have to execute all workflows during PSWI provisioning in z/OSMF immediately. +:::note Notes + * All workflows that are mentioned in the previous steps are part of the PSWI. + * You do not have to execute all workflows during PSWI provisioning in z/OSMF immediately. +::: The deployment process is complete. The new software instance is defined to z/OSMF. You are now ready to Import Product Information into z/OSMF before you install product maintenance. + +## Recommendations + +### Cleanup + +If there is a need to update the deployment settings such as the HLQ after a previous run, note that the deployment process does not perform a full cleanup of the datasets. +Before attempting job execution again, make sure the following datasets are deleted to avoid write conflicts: + +```plaintext +{TARGET_HLQ}.PRODUCT.ZOWE.V2.CSI +{TARGET_HLQ}.PRODUCT.ZOWE.V2.D.AZWEAUTH.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.D.AZWESAMP.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.D.AZWEZFS.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.SMPLOG.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.SMPLOGA.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.SMPLTS.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.SMPMTS.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.SMPPTS.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.SMPSCDS.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.SMPSTS.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.T.SZWEAUTH.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.T.SZWEEXEC.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.T.SZWELOAD.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.T.SZWESAMP.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.WORKFLOW.# +{TARGET_HLQ}.PRODUCT.ZOWE.V2.ZFS.# +``` + +If deployment options must be modified and the JCL recreated, first check the original JCL for the temporary ZFS dataset name. + +**Example:** +`.SWDEPL..ZFS` + +Delete this name manually. + +:::note +Note that the deployment job is unable to clean this data set name once the data set is recreated because the value for `random_id` will change. +::: + +### Resources + +It is recommended to update the job card to run with `REGION=0M`, particularly for job `IZUD01DZ` which unpaxes the contents. diff --git a/versioned_docs/version-v2.18.x/user-guide/install-zowe-pswi.md b/versioned_docs/version-v2.18.x/user-guide/install-zowe-pswi.md index e8d58e1901..824b92475a 100644 --- a/versioned_docs/version-v2.18.x/user-guide/install-zowe-pswi.md +++ b/versioned_docs/version-v2.18.x/user-guide/install-zowe-pswi.md @@ -3,7 +3,7 @@ As a systems programmer, your responsibilities include acquiring, installing, maintaining, and configuring mainframe products on your systems. z/OSMF lets you perform these tasks. z/OSMF lets you manage software on your z/OS systems through a browser at any time, from any location. By streamlining some traditional tasks and automating others, z/OSMF can simplify some areas of system management and also reduce the level of expertise that is required for managing system activities. Experienced users can view, define, and update policies that affect system behavior, monitor system performance, and manage their z/OS software. As products and vendors adopt z/OSMF services, you can install and maintain all your mainframe products in a common way according to industry best practices. After configuration is complete, you can execute the product and easily provision new software instances for use on other systems throughout your environment. -## End-to-end installation diagram +## End-to-end installation diagram ![PSWI installation diagram](../images/install/PSWI-install.png) @@ -19,19 +19,17 @@ To install Zowe using z/OSMF, ensure that you meet the following requirements: Refer to the following subpages to guide you through the installation procedure using z/OSMF. -* [Address z/OSMF Requirements](./install-zowe-pswi-address-requirements.md) - +- [Address z/OSMF Requirements](./install-zowe-pswi-address-requirements.md) Provides information about z/OSMF general configuration and security requirements. -* [Acquire a z/OSMF Portable Software Instance](./install-zowe-pswi-acquire.md) - +- [Acquire a z/OSMF Portable Software Instance](./install-zowe-pswi-acquire.md) Provides the steps to acquire the product software by downloading the z/OSMF portable software instance to the z/OSMF host. You must then register the portable software instance in z/OSMF. -* [Install Product Software Using z/OSMF Deployments](./install-zowe-pswi-deployment.md) - +- [Install Product Software Using z/OSMF Deployments](./install-zowe-pswi-deployment.md) Provides the steps to install (deploy) the portable software instance to an LPAR using z/OSMF Deployments. This step creates the SMP/E environment and runs the RECEIVE, APPLY, and ACCEPT steps to prepare the software instance for SMP/E operations. This step also: - * Customizes the data set names that are defined to SMP/E. - * Mounts required USS files if necessary. - * Performs workflow execution to customize the deployed runtime environment for use on a specific z/OS system. + + - Customizes the data set names that are defined to SMP/E. + - Mounts required USS files if necessary. + - Performs workflow execution to customize the deployed runtime environment for use on a specific z/OS system. When these tasks are completed, you are ready to install preventive maintenance.