Installing or Upgrading Workbench on Unix

Owned by John McKeever
Last updated: Aug 21, 2023 by Chiang Tan
3 min read

The MettleCI Workbench is browser-based application which is served from a lightweight agent that resides on your DataStage development environment’s Engine Tier.

In order to be able to install Workbench, you must be in a terminal session either logged in as root or as a user that can sudo as root.

Before installing MettleCI Workbench you will need to perform a pre-installation Java update to make sure your Java environment is compatible with MettleCI.

Pre-install steps if operating Workbench with a non-default user

By default, the MettleCI Workbench installer creates a new user called mciworkb (if it doesn’t already exist) and sets its primary group to dstage. All files created during the installation are owned by that user and group.

If your environment requires you to use a different user, do the following:

  1. As root, create an environment variable called DM_WORKBENCH_USER and set it to the name of the user you want to use.

  2. If the user you want to use does not exist it will be created automatically by the rpm installer.

If your environment requires you to use a different group, do the following:

  1. As root, create an environment variable called DM_DSTAGE_GROUP and set it to the name of the group you want to use.

  • If the group you want to use does not exist it will not be created by the rpm installer.

  • The DM_DSTAGE_GROUP group must be created manually prior to running the installation.

  • In this case, the Workbench service account user (either mciworkb or whatever user is set in DM_WORKBENCH_USER) must already exist and be manually placed in the group prior to running the installation.

Use the export or setenv command (depending on which shell you’re using) to set these environment variables. This ensures the installation processes are able to access them.

In this case, you must install as root and avoid changing shells between the setting of environment variables and the execution of installation commands.

Installation / Upgrade

  1. Download the latest RPM distributable (see Accessing the MettleCI Software Distribution). The rest of these instructions assume this is located in your user’s HOME directory (~).

  1. From that directory, install the package from the shell of your DataStage Development Engine using Package Manager (RPM) (NOTE: For new installations this will create a user called mciworkb. A full set of changes that this process performs are listed in the System Administrator Notes.)

    $> sudo rpm -U dm-mettleci-workbench-x.x-x.noarch.rpm $> # or for IBM AIX... $> sudo rpm -U dm-mettleci-workbench-x.x-x.noarch.rpm --nodeps --ignoreos

    … where x.x.x is the build version of the workbench you downloaded.

  2. The license will be installed during the first step of the Post Installation wizard process. You can…

    1. Use the license file that came with your IBM Passport Advantage package, or

    2. Request your license file from your Data Migrators sales contact.

  3. Start the MettleCI Workbench service using the following command

    $> sudo service dm-mettleci-workbench start $> # or for IBM AIX... $> mciworkbench.rc start

  4. Access the updated workbench using the relevant URL

  5. Perform a force refresh of your browser while accessing MettleCI Workbench using the instructions described here.

Verify your install/upgrade

  1. Verify your Workbench service is running:

    $> sudo service dm-mettleci-workbench status $> # or for IBM AIX... $> mciworkbench.rc status

  2. Opening the following URL in your browser: http://[SERVER_URL]:8080. and check the build number at the bottom of your Workbench browser screen. This should match the number in the number in the filename of the latest RPM distributable you downloaded and installed. If not, see the troubleshooting article A Workbench update doesn't appear to have installed.

Post-installation

  1. Configure your MettleCI environment by opening the following URL in your browser: http://[SERVER_URL]:8080 to start a wizard-based process.

  2. Follow the setup wizard to provide the various configuration information that MettleCI Workbench requires.

Uninstall Workbench

  1. You can uninstall the MettleCI Workbench package like any other RPM package:

You'll need to use a similar command to uninstall the Unit Test Harness too.

Downgrading Workbench

  1. If something goes wrong and you need to downgrade your version of MettleCI Workbench, without performing an uninstall/reinstall, you can use the following command:

    … where x.x.x is the build version of the workbench you want to downgrade to.

 

 

© 2015-2024 Data Migrators Pty Ltd.