Installing Greenplum Workload Manager


  • Red Hat Enterprise Linux (RHEL) 64-bit 5.5+ or 6, CentOS 64-bit 5.5+ or 6, or SUSE Linux Enterprise 11SP4, 64-bit
  • Greenplum Database version 4.3.13.x or higher
  • Pivotal Greenplum Command Center installer for your platform

The Greenplum Workload Manager installers are included in the Pivotal Greenplum Command Center installer you download from Pivotal Network. The installer file, gp-wlm--.bin, is in the Greenplum Command Center installation directory, /usr/local/greenplum-cc-web, by default.

Running the Greenplum Workload Manager Installer

Greenplum Workload Manager is installed on the Greenplum Database master node. It automatically distributes the software to all segment servers in the database cluster. The installer detects the installed Workload Manager version, if any, and performs an upgrade if necessary. Run the installer with the --force option to force reinstallation of the current version.

The package installer has the following syntax:

./gp-wlm-<version>-<platform>.bin --help 

./gp-wlm-<version>-<platform>.bin --install=<DIR> [ --force ] [ --install-concurrency=<COUNT> ] 
[ --no-remove-old ] [ --skip-health-check ] [ --dbname-records=<database_name> ] 
[ --tool-manifest=<FILE> ] 


Displays command syntax for the Workload Manager installer.

The --install option is required. It specifies the directory where Greenplum Workload Manager will be installed, for example /home/gpadmin.

If the --install option points to an existing Greenplum Workload Manager install, the installer will check the currently installed version and perform an upgrade only if the current version is older than the version being installed. If the --force option is specified, the installer will allow installing the same version of Greenplum Workload Manager on top of itself. Note that --force does not allow you to downgrade Greenplum Workload Manager to an earlier version.

The maximum number of hosts to bootstrap at once. The default count is computed by the installer. This option places a limit on the number of processes the installer can fork.

By default, the installer removes all previous installation directories after an upgrade. The --no-remove-old option prevents the installer from removing old installation directories.

Do not perform a cluster health check after Workload Manager installation completes. This option is not recommended.

The name of the database where the gp_wlm_records table is created. The default is postgres. The template0 and template1 databases may not be specified. The database must exist at install time. The same database must be specified when upgrading to a new Workload Manager release.

--tool-manifest filename
The optional --tool-manifest option specifies a text file containing a list of commands and their absolute paths. Workload Manager normally finds standard system commands on the path. If your environment has incompatible implementations of these commands on the path, create a manifest file that provides the absolute path to a standard version.

Following is an example tools manifest file:


The installer creates a gp-wlm-data directory in the installation directory and installs the Greenplum Workload Manager release into it. A symbolic link gp-wlm in the installation directory links to the specific Greenplum Workload Manager release directory.

  1. Log in to the Greenplum master host as the gpadmin user.
  2. Ensure that the Greenplum Workload Manager installer is executable.

    $ chmod +x gp-wlm-<version>-<platform>.bin
  3. Run the Greenplum Workload Manager installer. Specify the absolute path to an installation directory where you have write permission. For example:

    $ ./gp-wlm-<version>-<platform>.bin --install=/home/gpadmin/

    This command installs Greenplum Workload Manager in the gp-wlm-data subdirectory on all of the segments and creates the gp-wlm symbolic link. For example, the above command installs Workload Manager in /home/gpadmin/gp-wlm-data/gp-wlm-release and creates the symbolic link /home/gpadmin/gp-wlm.

    Note: In rare cases, the installer can fail during the cluster-health-check phase. If the cluster is reported not healthy, re-run the installer with the --force option.

  4. To add the Workload Manager executables to your path, source <INSTALL_DIR>/gp-wlm/ in your shell.

    $ source <INSTALL_DIR>/gp-wlm/

    You can add the source command to your ~/.bash_profile or ~/.bashrc script to include the Workload Manager executables in your path whenever you log in.

  5. (Optional) To enable the vmem metrics, see the instructions in the Vmem section of the Workload Manager Metric Reference.

Uninstalling Greenplum Workload Manager

To uninstall Greenplum Workload Manager, run the following command:

$ <INSTALL_DIR>/gp-wlm/bin/uninstall --symlink <INSTALL_DIR>/gp-wlm