Skip to main content
Version: v1.8.x

Installing Zowe SMP/E Alpha

Last updated
:  |
0 min read
|
Edit this page
 PDF
 Open doc issue

Contents

Introduction#

This program directory is intended for system programmers who are responsible for program installation and maintenance. It contains information about the material and procedures associated with the installation of Zowe Open Source Project (Base). This publication refers to Zowe Open Source Project (Base) as Zowe.

The Program Directory contains the following sections:

Zowe description#

Zoweâ„¢ is an open source project created to host technologies that benefit the Z platform. It is a sub-project of Open Mainframe Project which is part of the Linux Foundation. More information about Zowe is available at https://zowe.org.

Zowe FMIDs#

Zowe consists of the following FMIDs:

  • AZWE001

Program materials#

Basic Machine-Readable Materials are materials that are supplied under the base license and are required for the use of the product.

Basic machine-readable material#

The distribution medium for this program is via downloadable files. This program is in SMP/E RELFILE format and is installed using SMP/E. See Installation instructions for more information about how to install the program.

Program publications#

You can obtain the Zowe documentation from the Zowe doc site at https://docs.zowe.org/. No optional publications are provided for Zowe.

Program source materials#

No program source materials or viewable program listings are provided for Zowe in the SMP/E installation package. However, program source materials can be downloaded from the Zowe GitHub repositories at https://github.com/zowe/.

Publications useful during installation#

Publications listed below are helpful during the installation of Zowe.

Publication TitleForm Number
IBM SMP/E for z/OS User's GuideSA23-2277
IBM SMP/E for z/OS CommandsSA23-2275
IBM SMP/E for z/OS ReferenceSA23-2276
IBM SMP/E for z/OS Messages, Codes, and DiagnosisGA32-0883

These and other publications can be obtained from https://www.ibm.com/shop/publications/order.

Program support#

This section describes the support available for Zowe.

Because this is an alpha release of the Zowe FMID package for early testing and adoption, no formal support is offered. Support is available through the Zowe community. See Community Engagement for details. Slack is the preferred interaction channel.

Additional support may be available through other entities outside of the Open Mainframe Project and Linux Foundation which offers no warranty and provides the package under the terms of the EPL v2.0 license.

Statement of support procedures#

Report any problems which you feel might be an error in the product materials to the Zowe community via the Zowe GitHub community repo at https://github.com/zowe/community/issues/new/choose. You may be asked to gather and submit additional diagnostics to assist the Zowe Community for analysis and resolution.

Program and service level information#

This section identifies the program and relevant service levels of Zowe. The program level refers to the APAR fixes that have been incorporated into the program. The service level refers to the PTFs that have been incorporated into the program.

Program level information#

All issues of previous releases of Zowe that were resolved before August 2019 have been incorporated into this packaging of Zowe.

Service level information#

Since this is the first release of the SMP/E package, no PTFs have been created.

Installation requirements and considerations#

The following sections identify the system requirements for installing and activating Zowe. The following terminology is used:

  • Driving System: the system on which SMP/E is executed to install the program.
  • Target system: the system on which the program is configured and run.

Use separate driving and target systems in the following situations:

  • When you install a new level of a product that is already installed, the new level of the product will replace the old one. By installing the new level onto a separate target system, you can test the new level and keep the old one in production at the same time.
  • When you install a product that shares libraries or load modules with other products, the installation can disrupt the other products. By installing the product onto a separate target system, you can assess these impacts without disrupting your production system.

Driving system requirements#

This section describes the environment of the driving system required to install Zowe.

Driving system machine requirements#

The driving system can be run in any hardware environment that supports the required software.

Driving system programming requirements#

Program NumberProduct NameMinimum VRMMinimum Service Level will satisfy these APARsIncluded in the shipped product?
5650-ZOSz/OSV2.2.0 or laterN/ANo

Notes:

Zowe is installed into a file system, either HFS or zFS. Before installing Zowe, you must ensure that the target system file system data sets are available for processing on the driving system. OMVS must be active on the driving system and the target system file data sets must be mounted on the driving system.

If you plan to install Zowe in a zFS file system, this requires that zFS be active on the driving system. Information on activating and using zFS can be found in z/OS Distributed File Service zSeries File System Administration (SC24-5989).

Target system requirements#

This section describes the environment of the target system required to install and use Zowe.

Zowe installs in the z/OS (Z038) SREL.

Target system machine requirements#

The target system can run in any hardware environment that supports the required software.

Target system programming requirements#

Installation requisites

Installation requisites identify products that are required and must be present on the system or products that are not required but should be present on the system for the successful installation of Zowe.

Mandatory installation requisites identify products that are required on the system for the successful installation of Zowe. These products are specified as PREs or REQs.

Zowe has no mandatory installation requisites.

Conditional installation requisites identify products that are not required for successful installation of Zowe but can resolve such things as certain warning messages at installation time. These products are specified as IF REQs.

Zowe has no conditional installation requisites.

Operational requisites

Operational requisites are products that are required and must be present on the system, or, products that are not required but should be present on the system for Zowe to operate all or part of its functions.

Mandatory operational requisites identify products that are required for this product to operate its basic functions. The following table lists the target system mandatory operational requisites for Zowe.

Program NumberProduct Name and Minimum VRM/Service Level
5650-ZOSIBM z/OS Management Facility V2.2.0 or higher
5655-SDKIBM SDK for Node.js - z/OS V8.16.0 or higher
5655-DGHIBM 64-bit SDK for z/OS Java Technology Edition V8.0.0

Conditional operational requisites identify products that are not required for Zowe to operate its basic functions but are required at run time for Zowe to operate specific functions. These products are specified as IF REQs. Zowe has no conditional operational requisites.

Toleration/coexistence requisites

Toleration/coexistence requisites identify products that must be present on sharing systems. These systems can be other systems in a multi-system environment (not necessarily Parallel SysplexTM), a shared DASD environment (such as test and production), or systems that reuse the same DASD environment at different time intervals.

Zowe has no toleration/coexistence requisites.

Incompatibility (negative) requisites

Negative requisites identify products that must not be installed on the same system as Zowe.

Zowe has no negative requisites.

DASD storage requirements#

Zowe libraries can reside on all supported DASD types.

Total DASD space required by Zowe

Library TypeTotal Space Required in 3390 TrksDescription
Target30 Tracks/
Distribution12030 Tracks/
File System(s)9000 Tracks/
Web Download26111 TracksThese are temporary data sets, which can be removed after the SMP/E install.

Notes:

  1. For non-RECFM U data sets, we recommend using system-determined block sizes for efficient DASD utilization. For RECFM U data sets, we recommend using a block size of 32760, which is most efficient from the performance and DASD utilization perspective.

  2. Abbreviations used for data set types are shown as follows.

    • U - Unique data set, allocated by this product and used by only this product. This table provides all the required information to determine the correct storage for this data set. You do not need to refer to other tables or program directories for the data set size.

    • S - Shared data set, allocated by this product and used by this product and other products. To determine the correct storage needed for this data set, add the storage size given in this table to those given in other tables (perhaps in other program directories). If the data set already exists, it must have enough free space to accommodate the storage size given in this table.

    • E - Existing shared data set, used by this product and other products. This data set is not allocated by this product. To determine the correct storage for this data set, add the storage size given in this table to those given in other tables (perhaps in other program directories). If the data set already exists, it must have enough free space to accommodate the storage size given in this table.

      If you currently have a previous release of Zowe installed in these libraries, the installation of this release will delete the old release and reclaim the space that was used by the old release and any service that had been installed. You can determine whether these libraries have enough space by deleting the old release with a dummy function, compressing the libraries, and comparing the space requirements with the free space in the libraries.

      For more information about the names and sizes of the required data sets, see Allocate SMP/E target and distribution libraries.

  3. Abbreviations used for the file system path type are as follows.

    • N - New path, created by this product.
    • X - Path created by this product, but might already exist from a previous release.
    • P - Previously existing path, created by another product.

  4. All target and distribution libraries listed have the following attributes:

    • The default name of the data set can be changed.
    • The default block size of the data set can be changed.
    • The data set can be merged with another data set that has equivalent characteristics.
    • The data set can be either a PDS or a PDSE, with some exceptions. If the value in the "ORG" column specifies "PDS", the data set must be a PDS. If the value in "DIR Blks" column specifies "N/A", the data set must be a PDSE.

  5. All target libraries listed have the following attributes:

    • These data sets can be SMS-managed, but they are not required to be SMS-managed.
    • These data sets are not required to reside on the IPL volume.
    • The values in the "Member Type" column are not necessarily the actual SMP/E element types that are identified in the SMPMCS.

  6. All target libraries that are listed and contain load modules have the following attributes:

    • These data sets cannot be in the LPA, with some exceptions. If the value in the "Member Type" column specifies "LPA", it is advised to place the data set in the LPA.
    • These data sets can be in the LNKLST.
    • These data sets are not required to be APF-authorized, with some exceptions. If the value in the "Member Type" column specifies "APF", the data set must be APF-authorized.

Storage requirements for SMP/E work data sets

Library DDNAMETYPEORGRECFMLRECLNo. of 3390 TrksNo. of DIR Blks
SMPWRK6SPDSFB80(20,200)50
SYSUT1USEQ----(20,200)0

In the table above, (20,200) specifies a primary allocation of 20 tracks, and a secondary allocation of 200 tracks.

Storage requirements for SMP/E data sets

Library DDNAMETYPEORGRECFMLRECLNo. of 3390 TrksNo. of DIR Blks
SMPPTSSPDSEFB80(12000,3000)50

The following figures describe the target and distribution libraries and file system paths required to install Zowe. The storage requirements of Zowe must be added to the storage required by other programs that have data in the same library or path.

Note: Use the data in these tables to determine which libraries can be merged into common data sets. In addition, since some ALIAS names may not be unique, ensure that no naming conflicts will be introduced before merging libraries.

Storage requirements for Zowe target libraries

Note: These target libraries are not required for the initial alpha drop of Zowe SMP/E but will be required for subsequent drops so are included here for future reference.

Library DDNAMEMember TypeTarget VolumeTypeOrgRECFMLRECLNo. of 3390 TrksNo. of DIR Blks
SZWEAUTHAPF Load ModulesANYUPDSEU015N/A
SZWESAMPSamplesANYUPDSEFB80155

Zowe file system paths

DDNAMETYPEPath Name
SZWEZFSX/usr/lpp/zowe/SMPE

Storage requirements for Zowe distribution libraries

Note: These target libraries are not required for the initial alpha drop of Zowe SMP/E but will be required for subsequent drops so are included here for future reference.

Library DDNAMETYPEORGRECFMLRECLNo. of 3390 TrksNo. of DIR Blks
AZWEAUTHUPDSEU015N/A
AZWESAMPUPDSEFB80155
AZWEZFSUPDSEVB69951200030

The following figures list data sets that are not used by Zowe, but are required as input for SMP/E.

Data Set NameTYPEORGRECFMLRECLNo. of 3390 TrksNo. of DIR Blks
hlq.ZOWE.AZWE001.F1UPDSEFB805N/A
hlq.ZOWE.AZWE001.F2UPDSEFB805N/A
hlq.ZOWE.AZWE001.F4UPDSEVB69959000N/A
hlq.ZOWE.AZWE001.SMPMCSUSEQFB801N/A
z/OS UNIX file systemUzFSN/AN/A17095N/A

Note: These are temporary data sets, which can be removed after the SMP/E installation.

FMIDs deleted#

Installing Zowe might result in the deletion of other FMIDs.

To see which FMIDs will be deleted, examine the ++VER statement in the SMPMCS of the product. If you do not want to delete these FMIDs now, install Zowe into separate SMP/E target and distribution zones.

Note: These FMIDs are not automatically deleted from the Global Zone. If you want to delete these FMIDs from the Global Zone, use the SMP/E REJECT NOFMID DELETEFMID command. See the SMP/E Commands book for details.

Special considerations

Zowe has no special considerations for the target system.

Installation instructions#

This section describes the installation method and the step-by-step procedures to install and activate the functions of Zowe.

Notes:

  • If you want to install Zowe into its own SMP/E environment, consult the SMP/E manuals for instructions on creating and initializing the SMPCSI and SMP/E control data sets.
  • You can use the sample jobs that are provided to perform part or all of the installation tasks. The SMP/E jobs assume that all DDDEF entries that are required for SMP/E execution have been defined in appropriate zones.
  • You can use the SMP/E dialogs instead of the sample jobs to accomplish the SMP/E installation steps.

SMP/E considerations for installing Zowe#

Use the SMP/E RECEIVE, APPLY, and ACCEPT commands to install this release of Zowe.

SMP/E options subentry values#

The recommended values for certain SMP/E CSI subentries are shown in the following table. Using values lower than the recommended values can result in failures in the installation. DSSPACE is a subentry in the GLOBAL options entry. PEMAX is a subentry of the GENERAL entry in the GLOBAL options entry. See the SMP/E manuals for instructions on updating the global zone.

SubentryValueComment
DSSPACE(1200,1200,1400)Space allocation
PEMAXSMP/E DefaultIBM recommends using the SMP/E default for PEMAX.

Overview of the installation steps#

Follow these high-level steps to download and install Zowe Open Source Project (Base).

  1. Download the Zowe SMP/E package
  2. Allocate file system to hold web download package
  3. Upload the download package to the host
  4. Extract and expand the compress SMPMCS and RELFILEs
  5. Sample installation jobs
  6. Create SMP/E environment (optional)
  7. Perform SMP/E RECEIVE
  8. Allocate SMP/E target and distribution libraries
  9. Allocate, create and mount ZSF files (Optional)
  10. Allocate z/OS UNIX paths
  11. Create DDDEF Entries
  12. Perform SMP/E APPLY
  13. Perform SMP/E ACCEPT
  14. Run REPORT CROSSZONE
  15. Cleaning up obsolete data sets, paths, and DDDEFs

Download the Zowe SMP/E package#

To download the Zowe SMP/E package, open your web browser and go to the Zowe Download website. Click the Zowe SMP/E Alpha button to save the files to a folder on your desktop.

You will receive two files on your desktop.

  • AZWE001.pax.Z (binary)

    The SMP/E input data sets to install Zowe are provided as compressed files in AZWE001.pax.Z. This pax archive file holds the SMP/E MCS and RELFILEs.

  • AZWE001.readme.txt (text)

    The README file AZWE001.readme.txt is a single JCL file containing a job with the job steps you need to begin the installation, including comprehensive comments on how to tailor them. There is a sample job step that executes the z/OS UNIX System Services pax command to extract package archives. This job also executes the GIMUNZIP program to expand the package archives so that the data sets can be processed by SMP/E.

    Review this file on your desktop and follow the instructions that apply to your system.

Allocate file system to hold the download package#

You can either create a new z/OS UNIX file system (zFS) or create a new directory in an existing file system to place AZWE001.pax.Z. The directory that will contain the download package must reside on the z/OS system where the function will be installed.

To create a new file system, and directory, for the download package, you can use the following sample JCL (FILESYS).

Copy and paste the sample JCL into a separate data set, uncomment the job, and modify the job to update required parameters before submitting it.

//FILESYS JOB <job parameters>
//*
//***************************************************************
//* This job must be updated to reflect your environment.
//* This sample:
//* . Allocates a new z/OS UNIX file system
//* . Creates a mount point directory
//* . Mounts the file system
//*
//* - Provide valid job card information
//* - Change:
//* @zfs_path@
//* ----+----1----+----2----+----3----+----4----+----5
//* - To the absolute z/OS UNIX path for the download
//* package (starting with /)
//* - Maximum length is 50 characters
//* - Do not include a trailing /
//* @zfs_dsn@
//* - To your file system data set name
//*
//* Your userid MUST be defined as a SUPERUSER to successfully
//* run this job
//*
//***************************************************************
//*
//CREATE EXEC PGM=IDCAMS,REGION=0M,COND=(0,LT)
//SYSPRINT DD SYSOUT=*
//SYSIN DD *
DEFINE CLUSTER ( -
NAME(@zfs_dsn@) -
TRK(#size) -
/*VOLUME(volser)*/ -
LINEAR -
SHAREOPTIONS(3) -
)
//*
// SET ZFSDSN='@zfs_dsn@'
//FORMAT EXEC PGM=IOEAGFMT,REGION=0M,COND=(0,LT),
// PARM='-aggregate &ZFSDSN -compat'
//*STEPLIB DD DISP=SHR,DSN=IOE.SIOELMOD before z/OS 1.13
//*STEPLIB DD DISP=SHR,DSN=SYS1.SIEALNKE from z/OS 1.13
//SYSPRINT DD SYSOUT=*
//*
//MOUNT EXEC PGM=IKJEFT01,REGION=0M,COND=(0,LT)
//SYSEXEC DD DISP=SHR,DSN=SYS1.SBPXEXEC
//SYSTSPRT DD SYSOUT=*
//SYSTSIN DD *
PROFILE MSGID WTPMSG
oshell umask 0022; +
mkdir -p @zfs_path@
MOUNT +
FILESYSTEM('@zfs_dsn@') +
MOUNTPOINT('@zfs_path@') +
MODE(RDWR) TYPE(ZFS) PARM('AGGRGROW')
//*

Expected Return Codes and Messages: You will receive a return code of 0 if this job runs correctly.

Upload the download package to the host#

Upload the AZWE001.readme.txt file in text format and the AZWE001.pax.Z file in binary format from your workstation to the z/OS UNIX file system. The instructions in this section are also in the AZWE001.readme.txt file that you downloaded.

There are many ways to transfer the files or make them available to the z/OS system where the package will be installed. In the following sample dialog, we use FTP from a Microsoft Windows command line to do the transfer. This assumes that the z/OS host is configured as an FTP host/server and that the workstation is an FTP client. Commands or other information entered by the user are in bold, and the following values are assumed.

User enters:Values
mvsaddrTCP/IP address or hostname of the z/OS system
tsouidYour TSO user ID
tsopwYour TSO password
d:Location of the downloaded files
@zfs_path@z/OS UNIX path where to store the files. This matches the @zfs_path@ variable you specified in the previous step.

Important! The AZWE001.pax.Z file must be uploaded to the z/OS driving system in binary format, or the subsequent UNPAX step will fail.

Sample FTP upload scenario:

_C:/>ftp mvsaddr_
Connected to mvsaddr.
200-FTPD1 IBM FTP CS %version% at mvsaddr, %time% on %date%. 220 Connection will close if idle for more than 5 minutes.
_User (mvsaddr:(none)): tsouid_
331 Send password please
_Password: tsopw_
230 tsouid is loaded on. Working directory is "tsouid.".
_ftp> cd @zfspath@
250 HFS directory @zfs_path@ is the current working directory
_ftp> ascii_
200 Representation type is Ascii NonPrint
_ftp> put c:/AZWE001.readme.txt_
200 Port request OK.
150 Storing data set @zfs_path@/AZWE001.readme.txt
250 Transfer completed successfully.
ftp: 0344 bytes sent in 0.01 sec. (1366.67 Kbs)
_ftp binary_
200 Representation type is Image
_ftp> put c:\AZWE001.pax.Z_
200 Port request OK.
145 Storing data set @zfs_path@/AZWE001.pax.Z
250 Transfer completed successfully.
ftp: 524192256 bytes sent in 1.26 sec. (1040.52 Kbs)
_ftp: quit_
221 Quit command received. Goodbye.

If you are unable to connect with ftp and only able to use sftp, the commands above are the same except that you will use sftp at the command prompt instead of ftp. Also, because sftp only supports binary file transfer, the ascii and binary commands should be omitted. After you transfer the AZWE001.readme.txt file, it will be in an ASCII codepage so you need to convert it to EBCDIC before it can be used. To convert AZWE001.readme.txt to EBCDIC, log in to the distribution system using ssh and run an ICONV command.

_C:>/ssh tsouid@mvsaddr_
_tsouid@mvsaddr's password: tsopw_
/u/tsouid:>
cd:@zfs_path@
@zfs_path:>
@zfs_path:>iconv -f ISO8859-1 -t IBM-1047 AZWE001.readme.txt > AZWE001.readme.EBCDIC
@zfs_path:>rm AZWE001.readme.txt
@zfs_path:>mv AZWE001.readme.EBCDIC AZWE001.readme.txt
@zfs_path:>exit
C:>/

Extract and expand the compressed SMPMCS and RELFILEs#

The AZWE001.readme.txt file uploaded in the previous step holds a sample JCL to expand the compressed SMPMCS and RELFILEs from the uploaded AZWE001.pax.Z file into data sets for use by the SMP/E RECEIVE job. The JCL is repeated here for your convenience.

  • @zfs_path@ matches the variable that you specified in the previous step.

  • If the oshell command gets a RC=256 and message "pax: checksum error on tape (got ee2e, expected 0)", then the archive file was not uploaded to the host in binary format.

  • GIMUNZIP allocates data sets to match the definitions of the original data sets. You might encounter errors if your SMS ACS routines alter the attributes used by GIMUNZIP. If this occurs, specify a non-SMS managed volume for the GINUMZIP allocation of the data sets. For example:

    storclas-"storage_class" volume="data_set_volume"
    newname-"..."/>

  • Normally, your Automatic Class Selection (ACS) routines decide which volumes to use. Depending on your ACS configuration, and whether your system has constraints on disk space, units, or volumes, some supplied SMP/E jobs might fail due to volume allocation errors. See GIMUNZIP for more details.

    //EXTRACT JOB <job parameters>
    //* - Change:
    //* @PREFIX@
    //* ----+----1----+----2----+
    //* - To your desired data set name prefix
    //* - Maximum length is 25 characters
    //* - This value is used for the names of the
    //* data sets extracted from the download-package
    //* @zfs_path@
    //* ----+----1----+----2----+----3----+----4----+----5
    //* - To the absolute z/OS UNIX path for the download
    //* package (starting with /)
    //* - Maximum length is 50 characters
    //* - Do not include a trailing /
    //*
    //UNPAX EXEC PGM=IKJEFT01,REGION=0M,COND=(0,LT)
    //SYSEXEC DD DISP=SHR,DSN=SYS1.SBPXEXEC
    //SYSTSPRT DD SYSOUT=*
    //SYSTSIN DD *
    oshell cd @zfs_path@/ ; +
    pax -rvf AZWE001.pax.Z
    //*
    //GIMUNZIP EXEC PGM=GIMUNZIP,REGION=0M,COND=(0,LT)
    //*STEPLIB DD DISP=SHR,DSN=SYS1.MIGLIB
    //SYSUT3 DD UNIT=SYSALLDA,SPACE=(CYL,(50,10))
    //SYSUT4 DD UNIT=SYSALLDA,SPACE=(CYL,(25,5))
    //SMPOUT DD SYSOUT=*
    //SYSPRINT DD SYSOUT=*
    //SMPDIR DD PATHDISP=KEEP,
    // PATH='@zfs_path@/'
    //SYSIN DD *
    <GIMUNZIP>
    <ARCHDEF archid="AZWE001.SMPMCS"
    newname="@PREFIX@.ZOWE.AZWE001.SMPMCS"/>
    <ARCHDEF archid="AZWE001.F1"
    newname="@PREFIX@.ZOWE.AZWE001.F1"/>
    <ARCHDEF archid="AZWE001.F2"
    newname="@PREFIX@.ZOWE.AZWE001.F2"/>
    <ARCHDEF archid="AZWE001.F4"
    newname="@PREFIX@.ZOWE.AZWE001.F4"/>
    </GIMUNZIP>
    //*

GIMUNZIP#

The GIMUNZIP job may issue allocation error messages for SYSUT1 similar to these:

IEF244I ZWE0GUNZ GIMUNZIP - UNABLE TO ALLOCATE 1 UNIT(S) 577
AT LEAST 1 OFFLINE UNIT(S) NEEDED.
IEF877E ZWE0GUNZ NEEDS 1 UNIT(S) 578
FOR GIMUNZIP SYSUT1
FOR VOLUME SCRTCH- 1
OFFLINE
0AA4-0AA6 0AD0-0AD4
:
*07 IEF238D ZWE0GUNZ - REPLY DEVICE NAME OR 'CANCEL'.
CNZ2605I At 10.10.22 the system will automatically 581
reply: CANCEL
to the following WTOR:
0007 IEF238D ZWE0GUNZ - REPLY DEVICE NAME OR 'CANCEL'.
R 0007,CANCEL
IKJ56883I FILE SYSUT1 NOT ALLOCATED, REQUEST CANCELED
- --TIMINGS (MINS.)--
-JOBNAME STEPNAME PROCSTEP RC EXCP TCB SRB CLOCK
-ZWE0GUNZ 12 2311 ****** .00 2.4
-ZWE0GUNZ ENDED. NAME- TOTAL TCB CPU TIME=
$HASP395 ZWE0GUNZ ENDED - RC=0012

The job will end with RC=12. If this happens, add a TEMPDS control statement to the existing SYSIN as shown below:

//SYSIN DD *
<GIMUNZIP>
<TEMPDS volume="&VOLSER"> </TEMPDS>
<ARCHDEF archid="&FMID..SMPMCS"
newname="@PREFIX@.ZOWE.&FMID..SMPMCS"/>
<ARCHDEF archid="&FMID..F1"
newname="@PREFIX@.ZOWE.&FMID..F1"/>
<ARCHDEF archid="&FMID..F2"
newname="@PREFIX@.ZOWE.&FMID..F2"/>
<ARCHDEF archid="&FMID..F4"
newname="@PREFIX@.ZOWE.&FMID..F4"/>
</GIMUNZIP>
//*

where, &VOLSER is a DISK volume with sufficient free space to hold temporary copies of the RELFILES. As a guide, this may require 1,000 cylinders, or about 650 MB.

Sample installation jobs#

The following sample installation jobs are provided in hlq.ZOWE.AZWE001.F1, or equivalent, as part of the project to help you install Zowe:

Job NameJob TypeDescriptionRELFILE
ZWE1SMPESMP/ESample job to create an SMP/E environment (optional)ZOWE.AZWE001.F1
ZWE2RCVERECEIVESample SMP/E RECEIVE jobZOWE.AZWE001.F1
ZWE3ALOCALLOCATESample job to allocate target and distribution librariesZOWE.AZWE001.F1
ZWE4ZFSALLOMZFSSample job to allocate, create mountpoint, and mount zFS data setsZOWE.AZWE001.F1
ZWE5MKDMKDIRSample job to invoke the supplied ZWEMKDIR EXEC to allocate file system pathsZOWE.AZWE001.F1
ZWE6DDEFDDDEFSample job to define SMP/E DDDEFsZOWE.AZWE001.F1
ZWE7APLYAPPLYSample SMP/E ACCEPT jobZOWE.AZWE001.F1
ZWE8ACPTACCEPTSample SMP/E ACCEPT jobZOWE.AZWE001.F1

Note: When Zowe is downloaded from the web, the RELFILE data set name will be prefixed by your chosen high-level qualifier, as documented in the Extract and expand the compressed SMPMCS and RELFILEs section.

You can access the sample installation jobs by performing an SMP/E RECEIVE (refer to Perform SMP/E RECEIVE), then copy the jobs from the RELFILES to a work data set for editing and submission.

You can also copy the sample installation jobs from the product files by submitting the following job. Before you submit the job, add a job statement and change the lowercase parameters to uppercase values to meet the requirements of your site.

//STEP1 EXEC PGM=IEBCOPY
//SYSPRINT DD SYSOUT=*
//IN DD DSN=ZOWE.AZWE001.F1,
// DISP=SHR,
//* VOL=SER=filevol,
// UNIT=SYSALLDA
//OUT DD DSNAME=jcl-library-name,
// DISP=(NEW,CATLG,DELETE),
// SPACE=(TRK,(5,5,5)),
//* VOL=SER=dasdvol,
// UNIT=SYSALLDA
//SYSUT3 DD UNIT=SYSALLDA,SPACE=(CYL,(1,1))
//SYSIN DD *
COPY INDD=IN,OUTDD=OUT
/*

See the following information to update the statements in the sample above:

  • IN:

    • filevol is the volume serial of the DASD device where the downloaded files reside.

  • OUT:

    • jcl-library-name is the name of the output data set where the sample jobs are stored.
    • dasdvol is the volume serial of the DASD device where the output data set resides. Uncomment the statement is a volume serial must be provided.

The following supplied jobs might fail due to disk space allocation errors, as mentioned above for GIMUNZIP. Review the following sections for example error and actions that you can take to resolve the error.

ZWE2RCVE#

IEC032I E37-04,IGC0005E,ZWE2RCVE,RECEIVE,SMPTLIB,0AC0,USER10,
ZOWE.SMPE.AZWE001.F4

Add space and directory allocations to this SMPCNTL statement in the preceding ZWE1SMPE job:

ADD DDDEF(SMPTLIB) UNIT(SYSALLDA) .

This makes it as below:

ADD DDDEF(SMPTLIB) CYL SPACE(2,1) DIR(10) UNIT(SYSALLDA) .

ZWE1SMPE and ZWE4ZFS#

Example error

IDC3506I REQUIRED VOLUMES AND/OR DEVICETYPES HAVE BEEN OMITTED
IDC3003I FUNCTION TERMINATED. CONDITION CODE IS 12
IDC0002I IDCAMS PROCESSING COMPLETE. MAXIMUM CONDITION CODE WAS 12

Uncomment the VOLUMES(...) control statements and refer to the comments at the start of the JCL job for related necessary changes.

ZWEMKDIR, ZWE1SMPE, ZWE2RCVE, ZWE3ALOC, ZWE4ZFS and ZWE5MKD#

Example error

IEF257I ZWE3ALOC ALLOCD ALLOCD AZWEZFS - SPACE REQUESTED NOT AVAILABLE
IEF272I ZWE3ALOC ALLOCD ALLOCD - STEP WAS NOT EXECUTED.

Uncomment the VOL=SER=&... control statements and refer to the comments at the start of the JCL job for related necessary changes.

Create SMP/E environment (Optional)#

If you choose to create a new SMP/E environment for this install, you can use one of the following two options.

Create SMP/E Environment using JCL#

A sample job ZWE1SMPE is provided or you may choose to use your own JCL. If you are using an existing CSI, do not run the sample job ZWE1SMPE. If you choose to use the sample job provided, edit and submit ZWE1SMPE. Consult the instructions in the sample job for more information.

Note: If you want to use the default of letting your Automatic Class Selection (ACS) routines decide which volume to use, comment out the following line in the sample job ZWE1SMPE.

// SET CSIVOL=#csivol

Expected Return Codes and Messages: You will receive a return code of 0 if this job runs correctly.

Create SMP/E Environment with z/OSMF Workflow#

z/OSMF workflow simplifies the procedure to create an SMP/E environment for Zowe. Register and execute the Zowe SMP/E workflow to create SMP/E environment in the z/OSMF web interface. Perform the following steps to register and execute the Zowe workflow in the z/OSMF web interface:

  1. Log in to the z/OSMF web interface.

  2. Select Workflows from the navigation tree.

  3. Select Create Workflow from the Actions menu.

  4. Enter the complete path to the workflow definition file in the Workflow Definition filed.

    The workflow is located in the ZWEWRF01 member of the hlq.ZOWE.AZWE001.F4 data set.

  5. (Optional) Enter the path to the customized variable input file that you prepared in advance.

    The variable input file is located in ZWEYML01 member of the hlq.ZOWE.AZWE001 data set.

    Create a copy of the variable input file. Modify the file as necessary according to the built-in comments. Set the field to the path where the new file is located. When you execute the workflow, the values from the variable input file override the workflow variables default values.

  6. Select the system where you want to execute the workflow.

  7. Select Next.

  8. Specify the unique workflow name.

  9. Select or enter an Owner Use ID and select Assign all steps to owner user ID.

  10. Select Finish.

    The workflow is registered in z/OSMF and ready to execute.

  11. Select the workflow that you registered from the workflow list.

  12. Execute the steps in order.

    For general information about how to execute z/OSMF workflow steps, watch the z/OSMF Workflows Tutorial.

  13. Perform the following steps to execute each step individually:

    1. Double-click the title of the step.

    2. Select the Perform tab.

    3. Review the step contents and update the input values as required.

    4. Select Next.

    5. Repeat the previous two steps to complete all items until the option Finish is available.

    6. Select Finish.

      After you execute each step, the step is marked as Complete. The workflow is executed.

After you complete executing all the steps individually, the Zowe SMP/E is created.

Perform SMP/E RECEIVE#

Edit and submit sample job ZWE2RCVE to perform the SMP/E RECEIVE for Zowe. Consult the instructions in the sample job for more information.

Expected Return Codes and Messages: You will receive a return code of 0 if this job runs correctly.

Allocate SMP/E target and distributions libraries#

Edit and submit sample job ZWE3ALOC to allocate the SMP/E target and distribution libraries for Zowe. Consult the instructions in the sample job for more information.

Expected Return Codes and Messages: You will receive a return code of 0 if this job runs correctly.

Allocate, create and mount ZSF files (Optional)#

This job allocates, creates a mountpoint, and mounts zFS data sets.

If you plan to install Zowe into a new z/OS UNIX file system, you can edit and submit the optional ZWE4ZFS job to perform the following tasks. Consult the instructions in the sample job for more information.

  • Create the z/OS UNIX file system
  • Create a mountpoint
  • Mount the z/OS UNIX file system on the mountpoint

The recommended z/OS UNIX file system type is zFS. The recommended mountpoint is /usr/lpp/zowe.

Before running the sample job to create the z/OS UNIX file system, you must ensure that OMVS is active on the driving system. zFS must be active on the driving system if you are installing Zowe into a file system that is zFS.

If you create a new file system for this product, consider updating the BPXPRMxx PARMLIB member to mount the new file system at IPL time. This action can be helpful if an IPL occurs before the installation is completed.

MOUNT FILESYSTEM('#dsn')
MOUNTPOINT('/usr/lpp/zowe')
MODE(RDWR) /* can be MODE(READ) */
TYPE(ZFS) PARM('AGGRGROW') /* zFS, with extents */

See the following information to update the statements in the previous sample:

  • #dsn is the name of the data set holding the z/OS UNIX file system.
  • /usr/lpp/zowe is the name of the mountpoint where the z/OS UNIX file system will be mounted.

Expected Return Codes and Messages: You will receive a return code of 0 if this job runs correctly.

Allocate z/OS UNIX paths#

The target system HFS or zFS data set must be mounted on the driving system when running the sample ZWE5MKD job since the job will create paths in the HFS or zFS.

Before running the sample job to create the paths in the file system, you must ensure that OMVS is active on the driving system and that the target system's HFS or zFS file system is mounted on the driving system. zFS must be active on the driving system if you are installing Zowe into a file system that is zFS.

If you plan to install Zowe into a new HFS or zFS file system, you must create the mountpoint and mount the new file system on the driving system for Zowe.

The recommended mountpoint is /usr/lpp/zowe.

Edit and submit sample job ZWE5MKD to allocate the HFS or zFS paths for Zowe. Consult the instructions in the sample job for more information.

If you create a new file system for this product, consider updating the BPXPRMxx PARMLIB member to mount the new file system at IPL time. This action can be helpful if an IPL occurs before the installation is completed.

Expected Return Codes and Messages: You will receive a return code of 0 if this job runs correctly.

Create DDDEF entries#

Edit and submit sample job ZWE6DDEF to create DDDEF entries for the SMP/E target and distribution libraries for Zowe. Consult the instructions in the sample job for more information.

Expected Return Codes and Messages: You will receive a return code of 0 if this job runs correctly.

Perform SMP/E APPLY#

In this step, you run the sample job ZWE7APLY to apply Zowe. This step can take a long time to run, depending on the capacity of your system, and on what other jobs are running.

Follow these steps

  1. Ensure that you have the latest HOLDDATA; then edit and submit sample job ZWE7APLY to perform an SMP/E APPLY CHECK for Zowe. Consult the instructions in the sample job for more information.

    The latest HOLDDATA is available through several different portals, including http://service.software.ibm.com/holdata/390holddata.html. The latest HOLDDATA may identify HIPER and FIXCAT APARs for the FMIDs you will be installing. An APPLY CHECK will help you determine whether any HIPER or FIXCAT APARs are applicable to the FMIDs you are installing. If there are any applicable HIPER of FIXCAT APARs, the APPLY CHECK will also identify fixing PTFs that will resolve the APARs, if a fixing PTF is available.

    You should install the FMIDs regardless of the status of unresolved HIPER or FIXCAT APARs. However, do not deploy the software until the unresolved HIPER and FIXCAT APARs have been analyzed to determine their applicability. That is, before deploying the software either ensure fixing PTFs are applied to resolve all HIPER or FIXCAT APARs, or ensure the problems reported by all HIPER or FIXCAT APARs are not applicable to your environment.

    To receive the full benefit of the SMP/E Causer SYSMOD Summary Report, do not bypass the PRE, ID, REQ, and IFREQ on the APPLY CHECK. The SMP/E root cause analysis identifies the cause only of errors and not of warnings (SMP/E treats bypassed PRE, ID, REQ, and IFREQ conditions as warnings, instead of errors).

    Here are sample APPLY commands:

    1. To ensure that all recommended and critical service is installed with the FMIDs, receive the latest HOLDDATA and use the APPLY CHECK command as follows

      APPLY S(fmid,fmid,...) CHECK
      FORFMID(fmid,fmid,...)
      SOURCEID(RSU*)
      FIXCAT(IBM.PRODUCTINSTALL-REQUIREDSERVICE)
      GROUPEXTEND .
    • Some HIPER APARs might not have fixing PTFs available yet. You should analyze the symptom flags for the unresolved HIPER APARs to determine if the reported problem is applicable to your environment and if you should bypass the specific ERROR HOLDs in order to continue the installation of the FMIDs.
    • This method requires more initial research, but can provide resolution for all HPERs that have fixing PTFs available and not in a PE chain. Unresolved PEs or HIPERs might still exist and require the use of BYPASS.

    1. To install the FMIDs without regard for unresolved HIPER APARs, you can add the BYPASS(HOLDCLASS(HIPER)) operand to the APPLY CHECK command. This will allow you to install FMIDs, even though one of more unresolved HIPER APARs exist. After the FMIDs are installed, use the SMP/E REPORT ERRSYSMODS command to identify unresolved HIPER APARs and any fixing PTFs.

      APPLY S(fmid,fmid,...) CHECK
      FORFMID(fmid,fmid,...)
      SOURCEID(RSU*)
      FIXCAT(IBM.PRODUCTINSTALL-REQUIREDSERVICE)
      GROUPEXTEND
      BYPASS(HOLDCLASS(HIPER)) .
      ..any other parameters documented in the program directory
    • This method is quicker, but requires subsequent review of the Exception SYSMOD report produced by the REPORT ERRSYSMODS command to investigate any unresolved HIPERs. If you have received the latest HOLDDATA, you can also choose to use the REPORT MISSINGFIX command and specify Fix Category IBM.PRODUCTINSTALL-REQUIREDSERVICE to investigate missing recommended service.
    • If you bypass HOLDs during the installation of the FMIDs because fixing PTFs are not yet available, you can be notified when the fixing PTFs are available by using the APAR Status Tracking (AST) function of the ServiceLink or the APAR Tracking function of Resource Link.

  2. After you take actions that are indicated by the APPLY CHECK, remove the CHECK operand and run the job again to perform the APPLY.

Note: The GROUPEXTENDED operand indicates the SMP/E applies all requisite SYSMODs. The requisite SYSMODS might be applicable to other functions.

Expected Return Codes and Messages from APPLY CHECK: You will receive a return code of 0 if the job runs correctly.

Expected Return Codes and Messages from APPLY: You will receive a return code of 0 if the job runs correctly.

Perform SMP/E ACCEPT#

Edit and submit sample job ZWE8ACPT to perform an SMP/E ACCEPT CHECK for Zowe. Consult the instructions in the sample job for more information.

To receive the full benefit of the SMP/E Causer SYSMOD Summary Report, do not bypass the PRE, ID, REQ, and IFREQ on the ACCEPT CHECK. The SMP/E root cause analysis identifies the cause of errors but not warnings (SMP/E treats bypassed PRE, ID, REQ, and IFREQ conditions as warnings rather than errors).

Before you use SMP/E to load new distribution libraries, it is recommended that you set the ACCJCLIN indicator in the distribution zone. In this way, you can save the entries that are produced from JCLIN in the distribution zone whenever a SYSMOD that contains inline JCLIN is accepted. For more information about the ACCJCLIN indicator, see the description of inline JCLIN in the SMP/E Commands book for details.

After you take actions that are indicated by the ACCEPT CHECK, remove the CHECK operand and run the job again to perform the ACCEPT.

Note: The GROUPEXTEND operand indicates that SMP/E accepts all requisite SYSMODs. The requisite SYSMODS might be applicable to other functions.

Expected Return Codes and Messages from ACCEPT CHECK: You will receive a return code of 0 if this job runs correctly.

If PTFs that contain replacement modules are accepted, SMP/E ACCEPT processing will link-edit or bind the modules into the distribution libraries. During this processing, the Linkage Editor or Binder might issue messages that indicate unresolved external references, which will result in a return code of 4 during the ACCEPT phase. You can ignore these messages, because the distribution libraries are not executable and the unresolved external references do not affect the executable system libraries.

Expected Return Codes and Messages from ACCEPT: You will receive a return code of 0 if this job runs correctly.

Run REPORT CROSSZONE#

The SMP/E REPORT CROSSZONE command identifies requisites for products that are installed in separate zones. This command also creates APPLY and ACCEPT commands in the SMPPUNCH data set. You can use the APPLY and ACCEPT commands to install those cross-zone requisites that the SMP/E REPORT CROSSZONE command identifies.

After you install Zowe, it is recommended that you run REPORT CROSSZONE against the new or updated target and distribution zones. REPORT CROSSZONE requires a global zone with ZONEINDEX entries that describe all the target and distribution libraries to be reported on.

For more information about REPORT CROSSZONE, see the SMP/E manuals.

Cleaning up obsolete data sets, paths, and DDDEFs#

The web download data sets listed in DASD storage requirements are temporary data sets. You can delete these data sets after you complete the SMP/E installation.

Activating Zowe#

File system execution#

If you mount the file system in which you have installed Zowe in read-only mode during execution, then you do not have to take further actions to activate Zowe.

Zowe customization#

You can find the necessary information about customizing and using Zowe on the Zowe doc site.

On this page