zwe init subcommand overview

Review this article to learn about the individual subcommands executed in zwe init. Based on your use case, you may choose to run the subcommands of zwe init individually rather than running all of these commands together. Review this article to get started with using zwe init subcommands.

important

Some of the following zwe init subcommands require elevated permissions. See the required roles associated with each of these commands.

• Initializing Zowe custom data sets (zwe init mvs)
  • Procedure to initialize Zowe custom data sets
• Initializing Zowe security configurations (zwe init security)
• Performing APF authorization of load libraries (zwe init apfauth)
• Configuring Zowe to use TLS certificates (zwe init certificate)
• Installing Zowe main started tasks (zwe init stc)

Initializing Zowe custom data sets (zwe init mvs)

Use the zwe init mvs command to intialize Zowe custom MVS data sets.

Required role: system programmer

During the installation of Zowe, the following three data sets are created and populated with members copied across from the Zowe installation files:

• SZWEAUTH
• SZWESAMP
• SZWEEXEC

The contents of these data sets represent the original files that were provided as part of the Zowe installation and are not meant to be modified.

For modification and execution, it is necessary to create custom data sets by using the zwe init mvs command. For detailed information about this command, see the zwe init mvs command reference.

The folowing zowe.yaml section contains the parameters for the data set names:

zowe:
  setup:
    dataset:
      prefix: IBMUSER.ZWE
      parmlib: IBMUSER.ZWE.CUST.PARMLIB
      jcllib: IBMUSER.ZWE.CUST.JCLLIB
      authLoadlib: IBMUSER.ZWEV2.SZWEAUTH
      authPluginLib: IBMUSER.ZWE.CUST.ZWESAPL

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

Library DDNAME	Member Type	zowe.yaml	Target Volume	Type	Org	RECFM	LRECL	No. of 3390 Trks	No. of DIR Blks
CUST.PARMLIB	PARM Library Members	zowe.setup.dataset.parmlib	ANY	U	PDSE	FB	80	15	5
CUST.JCLLIB	JCL Members	zowe.setup.dataset.jcllib	ANY	U	PDSE	FB	80	15	5
CUST.ZWESAPL	CLIST copy utilities	zowe.setup.dataset.authPluginLib	ANY	U	PDSE	U	0	15	N/A

Procedure to initialize Zowe custom data sets

To initialize Zowe custom data sets, run the following command:

zwe init mvs -c /path/to/zowe.yaml

The following output is an example of running zwe init mvs.

Example:

#>zwe init mvs -c ./zowe.yaml
-------------------------------------------------------------------------------
>> Initialize Zowe custom data sets

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

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

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

Successful execution of zwe init mvs has the following results:

• In the zowe.yaml file, three custom data sets are created that have matching values with the following libraries:

  • zowe.setup.dataset.parmlib
  • zowe.setup.dataset.jcllib
  • zowe.setup.dataset.authPluginLib.

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

• The PDS SZWEAUTH is created. If SZWEAUTH already exists, the following error is thrown:

  Error ZWEL0158E: IBMUSER.ZWEV2.SZWEAUTH already exists

  You can ignore this message, or you can use the --allow-overwritten option on the command. For example, zwe init mvs -c zowe.yaml --allow-overwritten.

Initializing Zowe security configurations (zwe init security)

This subcommand creates the user IDs and security manager settings.

Required role: security administrator

If Zowe has already been launched on a z/OS system from a previous release of Zowe v2, you can skip this security configuration step unless told otherwise in the release documentation.

The JCL member .SZWESAMP(ZWESECUR) is provided to assist with the security configuration. Before submitting the ZWESECUR JCL member, customize this member to match site security rules. For script driven scenarios, you can run the command zwe init security which uses ZWESECUR as a template to create a customized member in .CUST.JCLLIB. This member contains the commands required to perform the security configuration.

For more information about zwe init security, see:

• Configure with zwe init security command in Configuring security.
• zwe init security in the Reference section.

tip

To avoid having to run the init security command, you can specify the flag --security-dry-run. This flag enables you to construct a JCL member containing the security commmands without running the member. This is useful for previewing commands and can also be used to copy and paste commands into a TSO command prompt for step by step manual execution.

Example:

#>zwe init security -c ./zowe.yaml --security-dry-run
-------------------------------------------------------------------------------
>> Run Zowe security configurations
Modify ZWESECUR
- IBMUSER.ZWEV2.CUST.JCLLIB(ZW134428) is prepared
Dry-run mode, security setup is NOT performed on the system.
Please submit IBMUSER.ZWEV2.CUST.JCLLIB(ZW134428) manually.
>> Zowe security configurations are applied successfully.
#>

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

Performing APF authorization of load libraries (zwe init apfauth)

Zowe contains load modules that require access to make privileged z/OS security manager calls. These load modules are held in two load libraries which must be APF authorized.

Required roles: security administrator

The command zwe init apfauth reads the PDS names for the following load libraries from zowe.yaml and performs the APF authority commands.

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

For more information about zwe init apfauth see:

• Performing APF authorization of load libraries.
• zwe init apfauth in the Reference section.

tip

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

Example:

zwe init apfauth --security-dry-run -c /path/to/zowe.yaml
-------------------------------------------------------------------------------
>> APF authorize load libraries
APF authorize IBMUSER.ZWEV2.SZWEAUTH
- Dry-run mode, security setup is NOT performed on the system.
  Please apply this operator command manually:
  SETPROG APF,ADD,DSNAME=IBMUSER.ZWEV2.SZWEAUTH,SMS
APF authorize IBMUSER.ZWEV2.CUST.ZWESAPL
- Dry-run mode, security setup is NOT performed on the system.
  Please apply this operator command manually:
  SETPROG APF,ADD,DSNAME=IBMUSER.ZWEV2.CUST.ZWESAPL,SMS
>> Zowe load libraries are APF authorized successfully.

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

Configuring Zowe to use TLS certificates (zwe init certificate)

Zowe uses digital certificates for secure, encrypted network communication over Secure Sockets Layer/Transport Layer Security (SSL/TLS) and HTTPS protocols.

Required roles: system programmer, security administrator

Zowe supports using either file-based (PKCS12) or z/OS key ring-based (when on z/OS) keystores and truststores, and can reuse compatible stores. You can use the zwe init certificate command to create keystores and truststores by either generating certificates or by allowing users to import their own compatible certificates.

For more information about init certificate, see:

• Configuring certificates.
• zwe init certificate in the Reference section.

Creating VSAM caching service datasets (zwe init vsam)

Zowe can work in a high availability (HA) configuration where multiple instances of the Zowe launcher are started, either on the same LPAR or different LPARs connected through sysplex distributor. If you are only running a single Zowe instance on a single LPAR you do not need to create a caching service so you may skip this step.

Required roles: system programmer

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

For more information about zwe init vsam, see Creating VSAM caching service datasets

Installing Zowe main started tasks (zwe init stc)

Execute the subcommand zwe init stc to install Zowe main started tasks.

Installation of Zowe main started tasks requires that JCL members for each of Zowe's started tasks be present on the JES proclib concatenation path.

Once you have completed security configuration, you can install the Zowe main started tasks.

Required role: system programmer

The JCL members for each of Zowe's started tasks need to be present on the JES proclib concatenation path. The command zwe init stc copies these members from the install source location .SZWESAMP to the targted PDS specified in the zowe.setup.dataset.proclib value USER.PROCLIB. The three proclib member names are specified in zowe.yaml arguments.

zowe:
  setup:
    security:
      stcs:
        zowe: ZWESLSTC
        zis: ZWESISTC
        aux: ZWESASTC

The zwe init stc command uses the CUST.JCL LIB data sets as a staging area to contain intermediatory JCL which are transformed version of the originals that are shiped in .SZWESAMP with paths, PDS locations, and other runtime data updated. If you wish to just generate the CUST.JCLLIB members without having them copied to USER.PROCLIB, specify --security-dry-run. If the JCL members are already in the target PROCLIB, specify --allow-overwritten.

Example:

#>zwe init stc -c ./zowe.yaml
-------------------------------------------------------------------------------
>> Install Zowe main started task

Modify ZWESLSTC
Modify ZWESISTC
Modify ZWESASTC

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

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

Next steps

After each of the zwe init subcommands run successfully, the next step is to complete configuring security.