The GPText installation includes the installation of Apache Solr Cloud.
Before you install GPText:
- Install and configure your Greenplum Database system, version 4.3.5 or higher. See the Greenplum Database Installation Guide at http://gpdb.docs.pivotal.io.
- When you configure Greenplum Database, first reserve memory on each Greenplum segment host for GPText use. To determine the memory to set aside for GPText, multiply the number of GPText 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_limitserver configuration parameter. See the Greenplum Database server configuration parameter
gp_vmem_protect_limitin the Greenplum Database Reference Guide for recommended memory calculation formulas or visit the GPDB Virtual Memory Calculator web site.
- GPText requires Red Hat Enterprise Linux 5.x or 6.x.
- Install Oracle JRE 1.8.x and place it in
PATHon the master and all segment servers. Set the
JAVA_HOMEenvironment variable to the JRE installation directory and ensure that any other Java environment variables (
CLASSPATH) are set properly for the JRE 1.8 installation.
- GPText cannot be installed onto a shared NFS mount.
- Ensure that
nc(netcat) is installed on all Greenplum cluster hosts (
sudo yum install nc).
lsofon the Greenplum master and all hosts is recommended (
sudo yum install lsof).
GPText can use an existing Apache ZooKeeper cluster or you can install a “binding” ZooKeeper cluster on the Greenplum cluster during GPText installation. A separate ZooKeeper cluster with at least five nodes is recommended for best performance with heavy database loads. To use a separate ZooKeeper cluster, the cluster must be up and have network connectivity with the Greenplum cluster hosts before you begin installing GPText.
On the Greenplum master host, extract the GPText distribution file, a compressed tar archive. For example:
cd /home/gpadmin tar xvfz greenplum-text-release-rhel5_x86_64.tar.gz
The release directory contains an installation configuration file,
gptext_install_config, and the GPText installation binary, which has a name similar to
greenplum-text-version-OS.bin, for example,
If necessary, grant execute permission to the GPText binary. For example:
chmod +x /home/gpadmin/greenplum-text-2.0.0-rhel5_x86_64.bin
If you are installing GPText in a directory that is only accessible to root, for example
/usr/local, perform these steps:
- Create the installation directory as root and change the ownership to the GPText installer, gpadmin.
To install to a directory where the user may or may not have write permissions:
Use gpssh to create a directory with the same file path on all hosts (
smdw, and the segment hosts
sdw2, and so on). For example:
As root, set the file permissions and owner. For example:
# chmod 775 /usr/local/greenplum-text-<version> # chown gpadmin:gpadmin /usr/local/greenplum-text-<version>
gptext_install_configfile to set parameters for the installation. See Set Installation Parameters for details.
Run the GPText installation binary as
gpadminon the master server:
./greenplum-text-<version>.bin -c gptext_install_config
Accept the Pivotal license agreement.
A GPText configuration file named
gptext_install_config contains parameters to configure the GPText installation. Edit the file and set the parameters as described in the following table.
||An array of directory paths where GPText data directories are to be created. The number of directories in the array determines the number of GPText nodes that will be created on each physical host. If
||Sets the minimum and maximum memory each SolrCloud JVM can use.||
||Set a range of port numbers available to GPText nodes. GPText finds unused ports in the specified range.||18983 - 28983|
||Whether to deploy a GPText binding ZooKeeper cluster or use an existing ZooKeeper cluster. If set to
||The ZooKeeper data directory, required when
||The node path in ZooKeeper for GPText. This parameter is required whether
||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, that is:
First, make sure the GPText command-line utilities are in your path by sourcing the following file located in the GPText installation directory:
To use GPText in a database, you must first use the
gptext-installsql management utility to install the GPText user-defined functions and other objects in the database:
gptext-installsql database [database2 ... ]
The GPText objects are created in the
Start GPText by running the
gptext-start management utility at the command line:
To uninstall GPText, run the
gptext-uninstall utility. You must have superuser permissions on all databases with GPText schemas to run
gptext-uninstall runs only if there is at least one database with a GPText schema.