Installing VMware Greenplum Platform Extension Framework

The VMware Greenplum Platform Extension Framework is available as a separate Broadcom Support Portal download for:

VMware Greenplum 5.x for CentOS 7.x and RHEL 7.x platforms
VMware Greenplum 6.x for RHEL 8.x, CentOS 7.x, RHEL 7.x, and Ubuntu 18.04 LTS platforms
VMware Greenplum 7 (Beta 2 and newer) for RHEL 8.x platforms

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

The PXF download package is an .rpm or .deb file that installs libraries, executables, and script files on a Greenplum Database host.

When you install the framework, you will:

Satisfy the prerequisites.
Download the package.
Install the package on every host in your Greenplum Database cluster.
Check out Next Steps for post-install topics.

Prerequisites

The recommended deployment model is to install PXF on all Greenplum Database hosts. Before you install version 6, ensure that you meet the following prerequisites:

VMware Greenplum version 5.21.2 or later, version 6.x, or version 7 (Beta 2+) is installed in the cluster.
You have access to all hosts (master, standby master, and segment hosts) in your Greenplum Database cluster.
You must be an operating system superuser, or have sudo privileges, to install the package. If you are installing on CentOS/RHEL, you can choose to install the package into a custom file system location.
You have installed Java 8 or 11 on all Greenplum Database hosts as described in Installing Java.
You can identify the operating system user that will own the installation. This user must be the same user that owns the Greenplum Database installation, or a user that has write privileges to the Greenplum Database installation directory.
If you have previously configured and are using the PXF in your Greenplum installation:
1. Identify and note the current version number.
2. Stop PXF as described in Stopping the Service.

Note: If this is your first installation of a PXF package, and the $GPHOME/pxf directory exists in your Greenplum installation, you may choose to remove the directory on all Greenplum hosts after you confirm that you have installed and configured PXF correctly and that it is working as expected.

If you choose to remove this directory, you may encounter warning: <pxf-filename>: remove failed: No such file or directory messages when you upgrade Greenplum. You can ignore these warnings for the PXF files.

Downloading the Package

Follow this procedure to download the PXF package:

Navigate to Broadcom Support Portal and locate Greenplum Platform Extension Framework under the desired Greemplum release.

The format of the download file name is pxf-gp<greenplum-major-version>-<pxf-version>-<pkg-version>.<platform>.<file_type>. For example:
```
pxf-gp6-6.6.0-2.el7.x86_64.rpm
```
or
```
pxf-gp6-6.6.0-2-ubuntu18.04-amd64.deb
```
Select the appropriate package for your Greenplum Database major version and operating system platform.
Make note of the directory to which the file was downloaded.
Follow the instructions in Verifying the VMware Greenplum Software Download in the Greenplum Database documentation to verify the integrity of the Greenplum Platform Extension Framework software.

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

Installing the Package

You must install the package on the Greenplum Database master and standby master hosts, and on each segment host.

If you installed an older version of the package on your hosts, installing a newer package removes the existing PXF installation, and installs the new version.

The install procedure follows:

Locate the installer file that you downloaded from Broadcom Support Portal.
Create a text file that lists your Greenplum Database standby master host and segment hosts, one host name per line. For example, a file named gphostfile may include:
```
gpmaster
mstandby
seghost1
seghost2
seghost3
```
Copy the downloaded package file to all hosts in your Greenplum cluster. For example, to copy the rpm to the /tmp directory on each host:
```
gphost$ gpscp -f gphostfile pxf-gp6-6.6.0-2.el7.x86_64.rpm =:/tmp/
```
Install the package on each Greenplum Database host using your package management utility. If a previous installation of PXF exists for the same Greenplum version, the files and runtime directories from the older version are removed before the current package is installed.
1. To install PXF into the default location on all Greenplum hosts:
  
  On a CentOS/RHEL version 7.x or 8.x system:
```
gphost$ gpssh -e -v -f gphostfile "sudo rpm -Uvh /tmp/pxf-gp6-6.6.0-2.el7.x86_64.rpm"
```
  On an Ubuntu system:
```
gphost$ gpssh -e -v -f gphostfile "sudo dpkg --install /tmp/pxf-gp6-6.6.0-2-ubuntu18.04-amd64.deb"
```
  The default package installation directory is /usr/local/pxf-gp<greenplum-major-version>.
2. To install PXF into a custom location on all Greenplum hosts (CentOS/RHEL only):
```
gpadmin@gphost$ gpssh -e -v -f gphostfile "sudo rpm -Uvh --prefix <install-location> pxf-gp6-6.6.0-2.el7.x86_64.rpm"
```
On all Greenplum hosts, set the ownership and permissions of the PXF installation files to enable access by the gpadmin user. For example, if you installed to the default location:
```
gphost$ gpssh -e -v -f gphostfile "sudo chown -R gpadmin:gpadmin /usr/local/pxf-gp*"
```
If you installed to a custom <install-location> on CentOS/RHEL, specify that location in the command.
(Optional) Add the bin directory to the PXF owner’s $PATH. For example, if you installed PXF for Greenplum 6 in the default location, you could add the following text to the .bashrc shell initialization script for the gpadmin user:
```
export PATH=$PATH:/usr/local/pxf-gp6/bin
```
Be sure to remove any previously-added $PATH entries for PXF in $GPHOME/pxf/bin.
Remove the package download file that you copied to each system. For example, to remove the rpm from /tmp:
```
gpadmin@gphost$ gpssh -e -v -f gphostfile "rm -f /tmp/pxf-gp6-6.6.0-2.el7.x86_64.rpm"
```

Next Steps

PXF is not active after installation. You must explicitly initialize and start the Service before you can use the framework.

See About the Installation and Configuration Directories for a list and description of important PXF files and directories. This topic also provides instructions for relocating runtime configuration directories.
If this is your first time using PXF, review Configuring PXF for a description of the initialization and configuration procedures that you must perform before you can use the framework.
If you installed the PXF rpm or deb as part of a Greenplum Database upgrade procedure, return to those upgrade instructions.
If you installed the rpm or deb into a Greenplum cluster in which you had already configured and were using version 5, you are required to perform some upgrade actions. Recall the original version of PXF (before you installed the rpm or deb), and perform Step 3 of the upgrade procedure.