Installing the Streaming Server

The Greenplum Streaming Server (GPSS) components are included in the VMware Greenplum 5 and 6 server distributions. If you want to install the newest version of these components, you may be required to download a package from the VMware Greenplum Streaming Server tile on Broadcom Support Portal.

The GPSS packages available for Greenplum 5/6/7 for download include:

GPSS gppkg Installer - A .gppkg file that you install to upgrade GPSS on all hosts in your VMware Greenplum cluster.
GPSS ETL Installer - An .rpm or .deb file that you use to install or upgrade GPSS on a dedicated ETL server host with no VMware Greenplum bits installed.
GPSS tarball - A .tar.gz file that you install to upgrade GPSS on a single dedicated ETL server host that includes a VMware Greenplum server installation.

Refer to the Supported Platforms section in the Release Notes to determine specific VMware Greenplum and operating system version support for GPSS.

About the Download Packages

The GPSS gppkg Installer and the GPSS tarball package files install the libraries, executables, and script files required to register and use the Greenplum Streaming Server client and server utilities directly into your VMware Greenplum installation.

The GPSS ETL Installer package file installs the client side executables and dependent libraries, and a script to set up the ETL runtime environment.

Name	Description
gpkafka	Load Kafka data into VMware Greenplum using a single command.
gpss	Start a VMware Greenplum Streaming Server instance.
gpsscli	Manage (submit, start, stop, and so forth) a VMware Greenplum Streaming Server data load job; currently supports Kafka, file, RabbitMQ, and S3 (Beta) data sources.
kafkacat	https://github.com/edenhill/kafkacat Kafka test and debug utility.

Downloading a GPSS Installer

Download the appropriate GPSS installer package for your VMware Greenplum version and operating system platform from Broadcom Support Portal. For example, to download the Greenplum 6 .gppkg package for Red Hat/CentOS 7, click to select the RHEL7->GPSS gppkg Installer for GPDB6 RHEL7 file.

Note
For more information about download prerequisites, troubleshooting, and instructions, see Download Broadcom products and software.

The naming format of the GPSS installer files is:

gpss-gpdb<major-version>-<gpss-version>-<platform>-x86_64.<filetype>

For example, the GPSS installer files for VMware Greenplum 5 for Red Hat/CentOS 6 are named:

gpss-gpdb5-1.10.4-rhel6-x86_64.gppkg
gpss-gpdb5-1.10.4-rhel6-x86_64.tar.gz
gpss-gpdb5-1.10.4-rhel6-x86_64.rpm

The GPSS installer files for VMware Greenplum 6 for Red Hat 7 are named:

gpss-gpdb6-1.10.4-rhel7-x86_64.gppkg
gpss-gpdb6-1.10.4-rhel7-x86_64.tar.gz
gpss-gpdb6-1.10.4-rhel7-x86_64.rpm

The GPSS installer files for VMware Greenplum 6 for Red Hat 8 are named:

gpss-gpdb6-1.10.4-rhel8-x86_64.gppkg
gpss-gpdb6-1.10.4-rhel8-x86_64.tar.gz
gpss-gpdb6-1.10.4-rhel8-x86_64.rpm

The GPSS installer files for VMware Greenplum 6 for Photon 3 are named:

gpss-gpdb6-1.10.4-photon3-x86_64.gppkg
gpss-gpdb6-1.10.4-photon3-x86_64.tar.gz
gpss-gpdb6-1.10.4-photon3-x86_64.rpm

The GPSS installer files for VMware Greenplum 6 for Ubuntu 18.04 are named:

gpss-gpdb6-1.10.4-ubuntu18.04-x86_64.gppkg
gpss-gpdb6-1.10.4-ubuntu18.04-x86_64.tar.gz
gpss-gpdb6-1.10.4-ubuntu18.04-x86_64.deb

The GPSS installer files for VMware Greenplum 6 for Rocky Linux 9 are named:

gpss-gpdb6-1.10.4-rocky9-x86_64.gppkg
gpss-gpdb6-1.10.4-rocky9-x86_64.tar.gz
gpss-gpdb6-1.10.4-rocky9-x86_64.rpm

The GPSS installer files for VMware Greenplum 7 for Red Hat 9 are named:

gpss-gpdb7-1.10.4-rhel9-x86_64.gppkg
gpss-gpdb7-1.10.4-rhel9-x86_64.tar.gz
gpss-gpdb7-1.10.4-rhel9-x86_64.rpm

The GPSS installer files for VMware Greenplum 7 for OEL 8 are named:

gpss-gpdb7-1.10.4-oel8-x86_64.gppkg
gpss-gpdb7-1.10.4-oel8-x86_64.tar.gz
gpss-gpdb7-1.10.4-oel8-x86_64.rpm

The GPSS installer files for VMware Greenplum 7 for OEL 9 are named:

gpss-gpdb7-1.10.4-oel9-x86_64.gppkg
gpss-gpdb7-1.10.4-oel9-x86_64.tar.gz
gpss-gpdb7-1.10.4-oel9-x86_64.rpm

The GPSS installer files for VMware Greenplum 7 for Rocky Linux 8 are named:

gpss-gpdb7-1.10.4-rocky8-x86_64.gppkg
gpss-gpdb7-1.10.4-rocky8-x86_64.tar.gz
gpss-gpdb7-1.10.4-rocky8-x86_64.rpm

Note the name and the file system location of the downloaded file.

Follow the instructions in Verifying the VMware Greenplum Software Download to verify the integrity of the Greenplum Streaming Server software.

Prerequisites

Before you install a GPSS package, ensure that you have stopped all Greenplum Streaming Server load jobs and gpss server instances running in the VMware Greenplum cluster and on the ETL host system.

Installing the GPSS gppkg

The GPSS gppkg Installer updates the GPSS components on all hosts in the VMware Greenplum cluster.

Note
The GPSS executables, libraries, and supporting files are installed directly into $GPHOME, overwriting the previous versions of the files.

Perform the following procedure to install the GPSS .gppkg:

Locate the installer file that you downloaded from Broadcom Support Portal and copy the file to the VMware Greenplum coordinator host.
Log in to the VMware Greenplum coordinator host as the gpadmin administrative user and set up your environment. For example:
```
$ ssh gpadmin@<gpcoord>
gpadmin@gpcoord$ . /usr/local/greenplum-db/greenplum_path.sh
```
Ensure that VMware Greenplum is running.
Run the gppkg command to install the GPSS .gppkg on all hosts in the VMware Greenplum cluster.

For example, to install the package on a Greenplum 6 cluster running on Red Hat/CentOS 7:
```
$ gppkg -i gpss-gpdb6-1.10.4-rhel7-x86_64.gppkg
```
To install the package on a Greenplum 7 cluster running on Red Hat/CentOS 8:
```
$ gppkg install gpss-gpdb7-1.10.4-rhel8-x86_64.gppkg
```

Installing the GPSS Tarball

The GPSS tarball .tar.gz installer updates the GPSS components on a single VMware Greenplum host.

Note
The GPSS executables, libraries, and supporting files are installed directly into $GPHOME, overwriting the previous versions of the files.

Perform the following procedure to install the GPSS .tar.gz:

Locate the installer file that you downloaded from Broadcom Support Portal and copy the file to the VMware Greenplum host.
Log in to the VMware Greenplum host as the gpadmin administrative user and set up your environment. For example:
```
$ ssh gpadmin@<gphost>
gpadmin@gphost$ . /usr/local/greenplum-db/greenplum_path.sh
```
Unpack the .tar.gz file. For example, to unpack the file for Greenplum 5 on Red Hat/CentOS 6:
```
gpadmin@gphost$ tar xzvf gpss-gpdb5-1.10.4-rhel6-x86_64.tar.gz
```
Unpacking the file creates a directory named gpss-gpdb5-1.10.4-rhel6_x86_64/ in the current working directory. Its contents include bin/, lib/, and share/ directories, as well as an install script named install_gpdb_component.

Navigate to the unpacked directory. For example:

 gpadmin@gphost$ cd gpss-gpdb5-1.10.4-rhel6_x86_64

Run the install script to install the new GPSS components into $GPHOME. For example:
```
 gpadmin@gphost$ ./install_gpdb_component
```

Installing the GPSS ETL Package

The GPSS ETL Installer installs the GPSS executables, libraries, and supporting files on a single ETL host.

Perform the following procedure to install the GPSS ETL package:

Locate the installer file that you downloaded from Broadcom Support Portal and copy the file to the ETL host.
Log in to the ETL host. For example:
```
$ ssh <etluser>@<etlhost>
```
Install the package using your package management utility. You must be the superuser or have sudo access to install packages.

For example, to install the ETL package for Greenplum 6 on Red Hat/CentOS 7:
```
etluser@etlhost$ sudo yum install gpss-gpdb6-1.10.4-rhel7-x86_64.rpm
```
To install the ETL package for Greenplum 6 on Ubuntu 18.04:
```
etluser@etlhost$ sudo dpkg --install gpss-gpdb6-1.10.4-ubuntu18.04-x86_64.deb
```
The GPSS ETL tools are installed into the /usr/local/gpss-<version> directory. The installation process creates a symbolic link from /usr/local/gpss to this install directory.
Before using the GPSS ETL tools, you must first source the gpss_path.sh environment file:
```
etluser@etlhost$ . /usr/local/gpss/gpss_path.sh
```

Inspecting the Quickstart Guide

When you install Greenplum Streaming Server in your system, it creates a directory under your installation path named docs/cli_help. This directory contains a quick start guide with useful information and examples to set up load jobs, along with some sample configuration files. You may copy the provided configuration files and adjust them to your environment settings.