Installing Tanzu Greenplum Text

Prerequisites

The Tanzu Greenplum Text installation includes the installation of Apache Solr Cloud and, optionally, Apache ZooKeeper.

If you are installing a new Tanzu Greenplum Text release into an existing Tanzu Greenplum Text system, follow the instructions in Upgrading Tanzu Greenplum Text instead.

Following are Tanzu Greenplum Text installation prerequisites.

Install and configure your Greenplum Database system, version 4.3.6 or higher. See Installing and Upgrading Greenplum.
Tanzu Greenplum Text runs on Red Hat Enterprise Linux or CentOS 5.x, 6.x, or 7.x.
Tanzu Greenplum Text cannot be installed onto a shared NFS mount.
Install a JRE 1.8 on all hosts in the cluster.
Ensure that nc (netcat) is installed on all Greenplum cluster hosts (yum install nc).
Installing lsof on all cluster hosts is recommended (sudo yum install lsof).
Tanzu Greenplum Text nodes can be installed on the Greenplum Database cluster hosts alongside the Greenplum segments or on additional, non-database hosts accessible on the Greenplum cluster network. All hosts participating in the Tanzu Greenplum Text system must have the same operating system and configuration and have passwordless-ssh access for the gpadmin user. See the Tanzu Greenplum Installation Guide for instructions to configure hosts.
If you plan to place Tanzu Greenplum Text nodes on the Greenplum Database segment hosts, ensure that you reserve memory for Tanzu Greenplum Text use when you configure Greenplum Database. To determine the memory to set aside for Tanzu Greenplum Text, multiply the number of Tanzu Greenplum Text nodes to create on each Greenplum segment host by the JVM maximum size. Subtract this memory from the physical RAM when calculating the value for the Greenplum Database gp_vmem_protect_limit server configuration parameter. See the Greenplum Database server configuration parameter gp_vmem_protect_limit in the Greenplum Database Reference Guide for recommended memory calculation formulas or visit the GPDB Virtual Memory Calculator web site.
Apache Solr requires a ZooKeeper cluster with at minimum three nodes. You can install a "binding" ZooKeeper cluster with Tanzu Greenplum Text on the Greenplum cluster hosts, or you can use an existing ZooKeeper cluster. When deployed alongside Greenplum Database segments, ZooKeeper performance can be affected under heavy database load. For best performance, install a ZooKeeper cluster with at least three nodes (five nodes recommended) on separate hosts with network connectivity to the Greenplum network. See ZooKeeper Best Practices for more information about optimizing ZooKeeper performance.

Note: Tanzu Greenplum Text uses a temporary directory to extract or process intermediate files during installation and deployment. The default location is the /tmp directory. You can choose to specify an alternate directory if disk space or permissions issues in your environment prevent the use of /tmp for this purpose by providing the -t <temp-dir> option to the commands.

Install the Tanzu Greenplum Text Binary Distribution

On the Greenplum master host, extract the Tanzu Greenplum Text distribution file. For example:
```
$ cd /home/gpadmin
$ tar xvfz greenplum-text-<version>-<platform>.tar.gz
```
This creates the directory greenplum-text-<version>-<platform> containing the files: gptext_install_config and the Tanzu Greenplum Text installation binary, which has a name in the format greenplum-text-<version>-<platform>.bin.
If necessary, grant execute permission to the Tanzu Greenplum Text binary. For example:
```
$ chmod +x /home/gpadmin/greenplum-text-<version>-<platform>.bin
```
If you are installing Tanzu Greenplum Text in a parent directory that is not writable by the gpadmin user, you must create the installation directories on each Tanzu Greenplum Text host machine and set ownership and permissions to allow the gpadmin user write access to the directories.

For example, if you are installing Tanzu Greenplum Text in the default directory, /usr/local/greenplum-text-<version>, execute these commands on each host as root (or as gpadmin using sudo):
```
mkdir /usr/local/greenplum-text-<version>
mkdir /usr/local/greenplum-solr
chown gpadmin:gpadmin /usr/local/greenplum-text-<version>
chmod 775 /usr/local/greenplum-text-<version>
chown gpadmin:gpadmin /usr/local/greenplum-solr
chmod 775 /usr/local/greenplum-solr
```
Note: You can use the Greenplum Database gpssh command-line utility to execute these commands in parallel on all hosts if the gpadmin user has sudo privilege or if the root user has passwordless SSH access to all hosts. See the gpssh command reference in the Greenplum Database Utility Guide for details.

Complete the remaining steps as the gpadmin user.
Edit the gptext_install_config file to set parameters for the installation. See Set Installation Parameters for details. Review the user authentication setup for the SolrCloud web user interface, using GPTEXT_ENABLE_USER_AUTH. Enabling user authentication after Tanzu Greenplum Text installation, and when the cluster is running, is a disruptive process.
Run the Tanzu Greenplum Text installation binary as gpadmin on the master server:
```
$ ./greenplum-text-<version>-<platform>.bin -c <gptext_install_config>
```
Accept the license agreement and respond to the installer's prompts.

Optional Two-Part Tanzu Greenplum Text Installation

The Tanzu Greenplum Text two-part installation installs and deploys the Tanzu Greenplum Text software in separate steps. This gives you the option to install the software files to a read-only, shared directory mounted on all Tanzu Greenplum Text hosts in the cluster, rather than installing the software on every Tanzu Greenplum Text host.

If you install the Tanzu Greenplum Text software onto a shared drive, you must set the GPTEXT_CUSTOM_CONFIG_DIR parameter in the installation configuration file. This parameter specifies a writable directory that exists on every Tanzu Greenplum Text host where Tanzu Greenplum Text can store configuration files for external data sources. See Tanzu Greenplum Text installation parameters for more information about this parameter.

Run the Tanzu Greenplum Text installation in two parts by following the steps in this section.

Prepare Tanzu Greenplum Text installation directories as described in steps 1 through 3 in Install the Tanzu Greenplum Text Binaries.
Run the Tanzu Greenplum Text installation binary as gpadmin on the master server:
```
$ ./greenplum-text-<version>.bin -b
```
Note that the -c <gptext_install_config> option is omitted.
Source the Tanzu Greenplum Text environment script in the Tanzu Greenplum Text installation directory:
```
$ source <gptext-install-dir>/greenplum-text_path.sh
```
Edit the gptext_install_config file to set parameters for the Tanzu Greenplum Text deployment. See Set Installation Parameters for details. Be sure to uncomment and set the GPTEXT_CUSTOM_CONFIG_DIR parameter if you installed the software on a read-only drive. Also review the user authentication setup for the SolrCloud web user interface, using GPTEXT_ENABLE_USER_AUTH. Enabling user authentication after Tanzu Greenplum Text installation, and when the cluster is running, is a disruptive process.
Deploy the Tanzu Greenplum Text cluster with the gptext-deploy command. The command requires the -c option to specify the installation configuration file. Also include the -m option because you installed the Tanzu Greenplum Text software to a shared drive mounted on all Tanzu Greenplum Text hosts. If you do not include -m, gptext-deploy copies the Tanzu Greenplum Text software to all Tanzu Greenplum Text hosts.
```
$ gptext-deploy -m -c <gptext_install_config>
```

Set Installation Parameters

A Tanzu Greenplum Text configuration file named gptext_install_config contains parameters to configure the Tanzu Greenplum Text installation. Edit the file and set the parameters as described in the following section.

Note: The GPTEXT_HOSTS and DATA_DIRECTORY installation parameters determine the number of Tanzu Greenplum Text nodes that are deployed.

The maximum number of Tanzu Greenplum Text nodes supported is 960. The best practice recommendation is to deploy fewer Tanzu Greenplum Text nodes with more memory rather than to divide the memory available to Tanzu Greenplum Text among a larger number of Tanzu Greenplum Text nodes. For example, if there are eight primary segments per host in the Greenplum Database cluster, you should test with two or four Tanzu Greenplum Text nodes per host, adjusting the JAVA_OPTS installation parameter to divide the memory reserved for Tanzu Greenplum Text among them.

Tanzu Greenplum Text installation parameters

GPTEXT_HOSTS

An array of host names that determines the number of hosts on which to install Tanzu Greenplum Text. You may use the constant "ALLSEGHOSTS" to install Tanzu Greenplum Text on all Greenplum Database segment hosts. Tanzu Greenplum Text hosts must be passwordless ssh-accessible by the gpadmin user from all other hosts in the Greenplum Cluster.

declare -a GPTEXT_HOSTS=(gptext_h1 gptext_h2 gptext_h3)

GPTEXT_HOSTS="ALLSEGHOSTS"

If you use the constant "ALLSEGHOSTS", the number of Tanzu Greenplum Text node hosts is the same as the number of Greenplum segment hosts. If GPTEXT_HOSTS is set to an array of host names, the length of the array is the number of Tanzu Greenplum Text node hosts.

DATA_DIRECTORY

An array of directory paths where Tanzu Greenplum Text data directories are to be created. The number of directories in the array determines the number of Tanzu Greenplum Text nodes that will be created on each physical host. If GPTEXT_HOSTS lists multiple interfaces per host, the Tanzu Greenplum Text nodes are spread evenly across the interface addresses.

declare -a DATA_DIRECTORY=(/data/primary /data/primary)

GPTEXT_CUSTOM_CONFIG_DIR

The path to a directory where Tanzu Greenplum Text stores uploaded external data source configuration files and custom libraries. If you do not set this parameter, the default is to store these files in the `share` subdirectory of the Tanzu Greenplum Text installation directory. If you do specify a directory with this parameter, the directory is created on every Solr host in the cluster, and external configuration files and custom libraries will be stored there, leaving the Tanzu Greenplum Text installation directory free from application data.

JAVA_OPTS

Sets the minimum and maximum memory each SolrCloud JVM can use.

JAVA_OPTS="-Xms1024M -Xmx2048M"

GPTEXT_ENABLE_USER_AUTH

Set this parameter to true to enable user authentication for the SolrCloud web user interface. The default user account is `solr`.

GPTEXT_ENABLE_USER_AUTH=True

GPTEXT_ADMIN_PWD

The password value for the SolrCloud web user interface. The password is applied to the default account `solr` when `GPTEXT_ENABLE_USER_AUTH=True`.

GPTEXT_ADMIN_PWD=mypassword

GPTEXT_ADMIN_USER

The value for the SolrCloud web user account. By default set to `solr`. Change this value to a user account of your preference. You may only specify a single SolrCloud web user account.

GPTEXT_ADMIN_USER=solr

GPTEXT_PORT_BASE

GP_MAX_PORT_LIMIT

Set a range of port numbers available to Tanzu Greenplum Text nodes. Tanzu Greenplum Text finds unused ports in the specified range.

GPTEXT_PORT_BASE=18983
GP_MAX_PORT_LIMIT=28983

SOLR_TIMEZONE

Sets the timezone for the Solr cluster. You may use three timezone formats:
1. GMT+offset, like SOLR_TIMEZONE="GMT+8"
2. GMT+/-long offset, like SOLR_TIMEZONE="GMT+0800".
3. TZ name, like SOLR_TIMEZONE="Asia/Shanghai". See [List of TZ database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for a full list of the possible TZ name values.

SOLR_TIMEZONE="Asia/Tokyo"

If the timezone is not set, Tanzu Greenplum Text defaults to the timezone of the master host.

ZOO_CLUSTER

Whether to deploy a Tanzu Greenplum Text binding ZooKeeper cluster or use an existing ZooKeeper cluster. If set to "BINDING" the installation deploys a ZooKeeper cluster. To use an existing ZooKeeper cluster, set this parameter to a list of ZooKeeper nodes in the format "host1:port,host2:port,host3:port".

ZOO_CLUSTER="BINDING"

ZOO_HOSTS

If ZOO_CLUSTER is set to "BINDING", this parameter is an array of the hosts where the ZooKeeper nodes are to be installed. The array must contain 3, 5, or 7 host names, for example ZOO_HOSTS=(sdw1 sdw2 swd3 sdw4 sdw5). If you are using a single host for ZooKeeper, specify it multiple times, for example, ZOO_HOSTS=(sdw1 sdw1 sdw1).

declare -a ZOO_HOSTS=(sdw1 sdw2 sdw3 sdw4 sdw5)

ZOO_DATA_DIR

The ZooKeeper data directory, required when ZOO_CLUSTER is set to "BINDING".

ZOO_DATA_DIR="/data/master/"

ZOO_GPTXTNODE

The node path in ZooKeeper for Tanzu Greenplum Text. This parameter is required whether ZOO_CLUSTER is set to "BINDING" or a list of hosts.

ZOO_GPTXTNODE="gptext"

ZOO_PORT_BASE

ZOO_MAX_PORT_LIMIT

A range of port numbers to use for the ZooKeeper cluster. Unused ports are allocated from within this range. The range must contain at least 4000 port numbers.

ZOO_PORT_BASE=2188
ZOO_MAX_PORT_LIMIT=12188

GPTEXT_JAVA_HOME

The home directory of the Java installation to run for ZooKeeper and Solr processes. If not set, the JRE specified in the PATH and JAVA_HOME environment variables will be used.

GPTEXT_JAVA_HOME=/usr/java/jdk1.8.0_131

Starting Tanzu Greenplum Text

First, make sure the Tanzu Greenplum Text command-line utilities are in your path by sourcing the Greenplum Database and Tanzu Greenplum Text environment scripts. It is important to source the Tanzu Greenplum Text environment script each time you source the Greenplum Database script. For example:

$ source /usr/local/greenplum-db-<version>/greenplum_path.sh
$ source /usr/local/greenplum-text-<version>/greenplum-text_path.sh

To use Tanzu Greenplum Text in a database, you must first use the gptext-installsql management utility to install the Tanzu Greenplum Text user-defined functions and other objects in the database:

$ gptext-installsql database [database2 ... ]

The Tanzu Greenplum Text objects are created in the gptext schema.

The ZooKeeper cluster must be running before you start Tanzu Greenplum Text. If you installed a bound ZooKeeper cluster, start it with the zkManager command-line utility.

$ zkManager start

Start Tanzu Greenplum Text with the gptext-start utility.

$ gptext-start

Configure Greenplum Database

Tanzu Greenplum Text configuration parameters are saved in ZooKeeper. You can, however, view and set Tanzu Greenplum Text configuration parameters in a Greenplum Database session using the SHOW and SET commands.

If you are using Greenplum Database 4.3.x or 5.x, you must first declare the Tanzu Greenplum Text custom variable class by adding it to the Greenplum Database custom_variable_classes configuration parameter. The custom_variable_classes parameter is removed in Greenplum Database 6, so this step is unnecessary if you have Greenplum Database 6.

The custom_variable_classes configuration parameter is a comma-separated list of class names. It is unset by default. To see if any custom variable classes have already been configured, run this gpconfig command at the command line.

$ gpconfig -s custom_variable_classes

If no custom variable classes have been set, set the parameter with the following command.

$ gpconfig -c custom_variable_classes -v 'gptext'
[gpadmin@gpsne ~]$ gpconfig -c custom_variable_classes -v 'gptext'
20171029:12:29:11:028199 gpconfig:gpsne:gpadmin-[INFO]:-completed successfully

If other classes have been configured, add gptext to the existing list, separated by a comma.

Run gpstop -u to have Greenplum Database reload the configuration file.

View or set Tanzu Greenplum Text Configuration Parameters

When you want to view or set Tanzu Greenplum Text configuration parameters in a psql session, first execute the gptext.version() function to load the Tanzu Greenplum Text configuration parameters into the session.

=#  SELECT gptext.version();
           version
--------------------------------
 Greenplum Text Analytics 3.2.0
(1 row)

=# SHOW gptext.idx_delim;
 gptext.idx_delim
------------------
 ,
(1 row)

See Setting Tanzu Greenplum Text Configuration Parameters for more about Tanzu Greenplum Text configuration parameters.

Uninstalling Tanzu Greenplum Text

To uninstall Tanzu Greenplum Text, run the gptext-uninstall utility. You must have superuser permissions on all databases with Tanzu Greenplum Text schemas to run gptext-uninstall.

gptext-uninstall runs only if there is at least one database with a Tanzu Greenplum Text schema.

Execute:

$ gptext-uninstall