Install z/IRIS clients

Created: 29 Mar 2021 | Updated: 31 Aug 2023

Preparing for the installation

z/IRIS z/OS Client package

mainstorconcept GmbH and its partners license and distribute z/IRIS software. For more information about obtaining the required licenses to run z/IRIS, please consult your z/IRIS representative.

z/IRIS client packages can be downloaded from the mainstorconcept repository. 

Script with cURL example

VERSION='1.14.0'
FILE='zosclient_1.14.0.zip'
USERNAME='<username>'
TOKEN='<token>'

curl --user "$USERNAME:$TOKEN" \
     -O "https://gitlab.com/api/v4/projects/47009651/packages/generic/zosclient/{VERSION}/zosclient_{VERSION}.zip"

Git API Example

Users will be prompted to provide the username and token before the download begins.

https://gitlab.com/api/v4/projects/47009651/packages/generic/zosclient/{VERSION}/zosclient_{VERSION}.zip

Verify minimum requirements

Please refer to the minimum hardware and software requirements page.

Kafka streaming preparations

Refer to Apache Kafka - Configuration Guide for more information.

Kafka cluster broker list

Obtain the hostnames and ports for the Kafka Cluster brokers.

Kafka topic

Obtain the topic(s) created for z/IRIS communication.

Kafka installed on Unix System Services ($KAFKA_HOME)

z/IRIS clients use Kafka Producers to stream SMF records to network accessible Kafka clusters. Users must install a distribution of Kafka on Unix System Services. The z/OS Client will require the installation directory path to locate the required Java artifacts.

The Kafka installation directory is referred to as $KAFKA_HOME in this guide.

zFS Mounted Files System ($APP_HOME)

Customize and run the following JCL example to create and mount a new zFS directory for z/IRIS z/OS Client installation. This directory is referred to $APP_HOME in this guide.

Sample JCL to create z/IRIS zFS directory

// JOB
//* Create a z/IRIS zFS directory
//CREATE EXEC PGM=BPXBATCH,
// PARM='SH mkdir -p /usr/lpp/ziris'
//* Create ZFS mount point for z/IRIS
//DEFINE EXEC PGM=IDCAMS
//SYSPRINT DD SYSOUT=*
//SYSIN DD *
DEFINE CLUSTER (NAME(hlq.ZIRIS.ZFS) -
LINEAR CYL(200 50)) -
VOLUMES(xxxxxx)
/*
//* Mount the z/IRIS directory
//MOUNT EXEC PGM=IKJEFT01,DYNAMNBR=10
//SYSTSPRT DD SYSOUT=*
//SYSTSIN DD *
MOUNT FILESYSTEM('hlq.ZIRIS.ZFS') +
MOUNTPOINT('/usr/lpp/ziris') +
TYPE(ZFS) MODE(RDWR) /* AUTOMOVE */

RACF preparation 

The z/IRIS z/OS Client requires a surrogate user id to control and permit access to resources like MVS Display Command, Started Task attach and SMF In-Memory Resources.

ADDUSER ZIRIS DFLTGRP(SYS1)  +
 OPERATIONS +  
 OMVS( +                                  
 UID(0) +                                 
 SHARED +                                
 THREADSMAX(500) +                        
)
RDEFINE STARTED ZIRIS.** UACC(NONE) STDATA(USER(ZIRIS) +
  GROUP(SYS1) TRUSTED(YES))
SETROPTS RACLIST(STARTED) REFRESH
PERMIT BPX.SERVER CLASS(FACILITY) ID(ZIRIS) ACCESS(READ)
PERMIT BPX.FILEATTR.APF CL(FACILITY) ID(ZIRIS) ACCESS(READ)
PERMIT BPX.FILEATTR.PROGCTL CL(FACILITY) ID(ZIRIS) ACCESS(READ)
PERMIT BPX.FILEATTR.SHARELIB CL(FACILITY) ID(ZIRIS) ACCESS(READ)
PERMIT ifa.inmem.racf.resource.name CLASS(FACILITY)  ID(ZIRIS) +
  ACCESS(READ)
SETROPT RACLIST(FACILITY) REFRESH
PERMIT  MVS.DISPLAY.M CLASS(OPERCMDS) ID(ZIRIS) UACC(READ)
PERMIT  MVS.DISPLAY.SMF CLASS(OPERCMDS) ID(ZIRIS) UACC(READ)
SETROPTS RACLIST(OPERCMDS) REFRESH

Steps to install z/OS client package

1. Extract and upload (in binary mode) the zirisv%%.pax.z to the $APP_HOME directory on z/OS USS. 

2. Unpack the file using the tar command:

   pax command

   BASH

   pax -rvzf zirisv1%%.pax.z 

3. Apply the authorized extended attribute to $APP_HOME/bin/CONSL001:

   extattr command

   CODE

   cd $APP_HOME/bin
   extattr +a ./CONSL001

4. Make all commands in $APP_HOME/bin executable:

   chmod command

   CODE

   cd $APP_HOME/bin
   chmod +x ./*