IBM Support

IBM Sterling Transformation Extender Runtime Server

General Page

This document provides a high-level overview of the IBM Sterling Transformation Extender (ITX) Runtime Server product. It includes steps for installing ITX Runtime Server operator and ITX Runtime Server instances in Red Hat OpenShift Container Platform (RHOCP) cluster environments using OpenShift web console. The document also provides a reference to the ITX Runtime Server CASE (Container Application Software for Enterprises) package which contains additional technical documentation and tools for installing ITX Runtime Server in command line mode, as well as in disconnected (air-gapped) RHOCP environments.
 

Introduction

IBM Sterling Transformation Extender (ITX) Runtime Server is a containerized application for running ITX maps. The supported runtime environment for ITX Runtime Server is Red Hat OpenShift Container Platform (RHOCP) version 4.4 or later. ITX Runtime Server is installed to a RHOCP cluster as an operator, and the operator is then utilized to install ITX Runtime Server instances. The interface that ITX Runtime Server provides is a set of REST API endpoints that can be invoked to deploy, catalog and run compiled ITX maps.

Installation Prerequisites

ITX maps can be designed and compiled for Linux 64 platform using ITX Design Studio. ITX Design Studio is available as a separate download option and must be installed locally on a Windows host. Please refer to the information provided with your entitlement for instruction how to download and install ITX Design Studio. For getting started with the ITX Design Studio and for detailed technical documentation, please refer to the ITX Knowledge Center.

Installing ITX Runtime Server Operator

Install from Red Hat Marketplace and verify in Red Hat OpenShift Container Platform in the Installed Operators section.

Creating ITX Runtime Server Instance

  1. Select the Installed Operators option under the Operators main menu option on the left-hand side of the web console screen.
  2. Click on the ITX Runtime Server Operator entry in the list. The operator details page will open.
  3. Click on the ITX Runtime Server menu option.
  4. Click the Create ITXRuntimeServer button.
  5. The Edit YAML option opens where you can enter configuration options for your new ITX Runtime Server instance. To be presented with a graphical UI page with the configuration options, click the Edit Form link located in the upper-right corner of the page. You can switch back and forth between the two forms. A brief description is presented for each configuration option. For further information about the supported configuration options, please refer to the Additional Details section in this document.

At a minimum, the settings that you will need to configure before installing the instance are the following:

  • License - you must accept the product license. Refer to the link provided in the displayed description for the setting
  • Storage - ITX Runtime Server requires two persistent volumes: one for the data (which includes compiled maps) and one for the logs. By default, the installation will: a) rely on the dynamic volume provisioning, b) use the default storage class defined in the cluster, and c) request the ReadWriteMany bind mode. You will need to change these settings if they are not supported in your cluster environment. please refer to the Additional Details section in this document for locating the README documents in the CASE archive, which provide more information on the storage configuration and requirements.
  1. Click on Create. The instance is deployed, and the workload image is downloaded.
  2. To verify the image is running, click on the Deployments page. You should be able to see two ITX deployments, one for the ITX Runtime Server operator (itx-rs-operator), and one for the newly deployed ITX Runtime Server instance (itx-rs-deployment). Click on the ITX Runtime Server instance deployment. Click on the Pods link. By default, a single pod will be created. Wait for the status of the pod to change to Running (1/1). Click on the Pod link and confirm the pod is running. Click on the Logs menu option to see the start-up success log messages reported by the pod. You can also click on the Terminal menu option if you wish to open a shell window attached to the pod.

For additional steps to perform to confirm the successful product installation, and for the getting started steps with the product, please refer to the README documents in the CASE archive, covered in the the Additional Details section in this document.

Uninstalling the Product

To remove an ITX Runtime Server instance without removing the operator, open the instance page. You can get to that page by selecting the Installed Operators option under the Operators main menu option on the left-hand side of the web console screen, and then clicking on the link in the Deployment column in the ITX Runtime Server row. You can get to the same page also by selecting the Custom Resource Definitions option under the Administration main menu option, selecting the ITXRuntimeServer entry, and then selecting the Instances menu option on the page that will open. Once you are on the ITX Runtime Server instance page, select the Actions drop-down menu, select Delete ITXRuntimeServer option and click Delete button to confirm you wish to delete the instance.

To remove the ITX Runtime Server operator, select the Installed Operators option under the Operators main menu option on the left-hand side of the web console screen. Click on the three-dots icon in the rightmost column for the ITX Runtime Server row entry and then select the Uninstall Operator option. Click the Uninstall button to confirm that you wish to delete the ITX Runtime Server operator.

Next, delete the ITXRuntimeServer custom resource definition (CRD). Select the Custom Resource Definitions option under the Administration main menu option on the left-hand side of the web console, and check if  ITXRuntimeServer entry is included in the list. If it is, click on the three-dots icon in the rightmost column for the row entry, click on the Delete Custom Resource Definition option and click the Delete button to confirm that you wish to delete the itxruntimeservers.itx.ibm.com custom resource definition.

After removing the operator and the CRD, the operator tile is still present in the OperatorHub page and you can proceed to install it again. If you wish to remove the tile from the OperatorHub page, select the Custom Resource Definitions option under the Administration main menu option on the left-hand side of the web console screen and locate the CatalogSource entry. DO NOT DELETE THIS ENTRY! Instead, click on it to open its Details page. Click the Instances menu option. Locate the ibm-itx-rs-catalog entry, click on the three-dots icon in the rightmost column in the row entry, select the Delete CatalogSource option and click Delete button to confirm you wish to delete the ibm-itx-rs-catalog catalog source.

Additional Details
 

For additional information about installing and configuring the ITX Runtime Server, please refer to the README.md document included in the ITX Runtime Server CASE package archive for this product.

You will need to download the CASE archive and unzip it on your machine. To view the contents of the archive, including the license and README.md documents, the machine can be Windows, Linux 64 or MacOS machine. To run the included scripts, however, the machine must be a Linux 64 machine.

You can retrieve the CASE archive from the following location. Look for the file ibm-itx-rs-x.y.z.tgz where x.y.z is the CASE version. Pick the latest CASE version available. The initial version, which corresponds to the ITX Runtime Server 10.0.3.0 GA release, is version 1.0.0.

The CASE archive contains license files for the ITX Runtime Server. The files are located under the case/ibm-itx-rs/licenses folder.

The CASE archive also contains a README.md document, located under case/ibm-itx-rs/README.md location.

The README.md document contains details for installing and using the product. Some of the areas covered in the document are:

  • Preparing and configuring certificates and keys for enabling SSL/TLS communication
  • Preparing and configuring optional Redis installation
  • Storage, networking and security considerations
  • Backup and recovery considerations
  • Manual installation from the command line, using the included script
  • Installation in a disconnected (air gap) environment, using the included script
  • Verifying the installation
  • Accessing the product REST API documentation (OpenAPI 3.0 and Swagger 2.0)

The README.md document is provided in the markdown (.md) format. You may view the document in a plain text editor, however for better viewing experience, an editor or a viewing application that supports rendering of text in markdown format is recommended.

[{"Line of Business":{"code":"LOB02","label":"AI Applications"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSVSD8","label":"IBM Transformation Extender"},"ARM Category":[{"code":"a8m0z000000bnDSAAY","label":"Release Information"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Version(s)"}]

Document Information

Modified date:
11 November 2020

UID

ibm16326517