Installing Prizm Gateway

These instructions apply to new installations of Prizm Gateway™.. See Updating Prizm Gateway for instructions for updating an existing installation to a new release version. Note that you may install the product more than once (in separate subvolumes) on the same NonStop system if you wish.

Before proceeding with the installation process refer to the Release Notes for important information about the current release of the software, particularly the Installation Prerequisites.

The software is delivered in a single PAK archive containing the following files:

PRIZCON - The Prizm Gateway Console process
PRIZCONA - The Console UI asset file
PRIZGATE - The Prizm Gateway worker process
PRIZMON - The Prizm Monitor process
CFGCONI - The initial console process configuration file.
CFGGATEI - The initial Gateway process configuration file.

Overview of Installation

The process is performed from a TACL prompt. These are the steps:

Obtain a Product License

A license is required to run Prizm Gateway. If this is the first time you are installing the product on your NonStop system, you may obtain a free 30-day trial license at the Trial License Center. Otherwise, a license will be provided to you upon purchase of the product. Do not request a trial license until you are ready to begin using the product, as the 30-day timer starts on the day the license is issued. Note that you may install Prizm Gateway without a license, however the product will not function until a valid license is installed. See Product Licensing for information on how to install the license.

Download the Release Package

The software is distributed as a single PAK archive file. The software may be downloaded from the Software Download Center. Transfer the PAK file to your NonStop system using binary transfer mode.

Install the Release Package

Unpak the release package PAK archive file into an empty subvolume.

CODE

> UNPAK <pakfile> ($*.*.*), vol <installation-subvolume>, myid, listall

where <pakfile> is the name of the release package PAK archive file you transferred earlier.

Initial Setup of Configuration Files

Prizm Gateway stores its configuration in Escribe EDIT files in YAML format. Initial startup configuration files are included in the release package.

Copy the Gateway Configuration File

The initial gateway configuration file must be copied to the runtime file. Once copied, all changed are managed by the Console. Copy the file using the following command:

CODE

tacl > fup dup CFGGATEI, CFGGATE

Copy and Edit the Console Configuration File

The initial Console configuration file must be copied to the runtime file and customized for your environment.

CODE

tacl > fup dup CFGCONI, CFGCON
tacl > tedit CFGCON

The YAML configuration file has the following format. Note that YAML is case sensitive, and indentation is significant. Entries prefixed with '#' are comments and are considered omitted from the configuration. To include the entries in the configuration, remove the '#' character and align the entry with the other entries.

YML

---
config_prizm_console:
    port: 8080
    # tcpip_process: "$ZTC0"
    error_log: "LOGCONE"
    debug_log: false
    # access_log: "LOGCONA"
    tls: false
    tls_cert_file: "certpem"
    tls_key_file: "pkeypem"
    http2: false
...

An example of uncommenting an entry:

YML

---
config_prizm_console:
    port: 8080
    # TCPIP process is not the default.
    tcpip_process: "$ZTC1"
    error_log: "LOGCONE"
    debug_log: false
    # access_log: "LOGCONA"
    tls: false
    tls_cert_file: "certpem"
    tls_key_file: "pkeypem"
    http2: false
...

Edit the following parameters for your system.

Parameter	Description
port	Set this value to the TCP/IP port number that PRIZCON process will listen on. This is the TCP/IP port that you'll use to connect to the Console.
tcpip_process	The name of the TCP/IP process to use. If omitted, the value of the =TCPIP^PROCESS^NAME MAP define is used if it exists, otherwise $ZTC0 is used.
error_log	The name of the console error log file.
access_log	The name of the access log file (HTTP log file). If omitted, no log will be produced.
debug_log	Set this value to true to enable debug logging in the error_log.
tls	Set this value to true if you wish to use TLS for access to the Console.
tls_cert_file	If tls is set to true, you must provide an TLS certificate file in PEM format. Specify the name of the certificate file. The file may be stored in EDIT (type 101) or stream (type 180) format.
tls_key_file	If tls is set to true, you must provide an TLS private key file in PEM format. Specify the name of the certificate file. The file may be stored in EDIT (type 101) or stream (type 180) format. The key must match the certificate file.
http2	If tls is set to true, set this parameter to true to enable HTTP/2 protocol.