Command Center Utility Reference

posted Nov 8, 2012, 12:57 PM by Sachi Ojha
Greenplum provides the following utilities to install and maintain Greenplum Command Center:

1. gpperfmon_install - Enables the data collection agents.

2. gpcmdr - Sets up and manages the web application.

gpperfmon_install
Installs the Command Center database (gpperfmon) and optionally enables the data collection agents.

Synopsis
gpperfmon_install
[--enable --password gpmon_password --port gpdb_port]
[--pgpass path_to_file]
[--verbose]

gpperfmon_install --help | -h | -?

Description
The gpperfmon_install utility automates the steps required to enable the Command Center data collection agents. You must be the Greenplum system user (gpadmin) in order to run this utility. If using the --enable option, Greenplum Database instance must be restarted after the utility completes.

When run without any options, the utility will just create the Command Center database (gpperfmon). When run with the --enable option, the utility will also run the following additional tasks necessary to enable the Command Center data collection agents:

1.Creates the gpmon superuser role in Greenplum Database. The Command Center data collection agents require this role to connect to the database and write their data. The gpmon superuser role uses MD5-encrypted password authentication by default. Use the --password option to set the gpmon superuser’s password. Use the --port option to supply the port of the Greenplum Database master instance.

2.Updates the $MASTER_DATA_DIRECTORY/pg_hba.conf file. The utility will add the following line to the host-based authentication file (pg_hba.conf). This allows the gpmon user to locally connect to any database using MD5-encrypted password authentication:

local all gpmon md5

3.Updates the password file (.pgpass). In order to allow the data collection agents to connect as the gpmon role without a password prompt, you must have a password file that has an entry for the gpmon user. The utility add the following entry to your password file (if the file does not exist, the utility will create it):
*:5432:gpperfmon:gpmon:gpmon_password
If your password file is not located in the default location (~/.pgpass), use the --pgpass option to specify the file location.

4.Sets the server configuration parameters for Command Center. The following parameters must be enabled in order for the data collection agents to begin collecting data. The utility will set the following parameters in the postgresql.conf configuration files:
gp_enable_gpperfmon=on (in all postgresql.conf files)
gpperfmon_port=8888 (in all postgresql.conf files)
gp_external_enable_exec=on (in the master postgresql.conf file)

Options
--enable
In addition to creating the gpperfmon database, performs the additional steps
required to enable the Command Center data collection agents. When --enable is
specified the utility will also create and configure the gpmon superuser account and
set the Command Center server configuration parameters in the postgresql.conf
files.

--password gpmon_password
Required if --enable is specified. Sets the password of the gpmon superuser.

--port gpdb_port
Required if --enable is specified. Specifies the connection port of the Greenplum
Database master.

--pgpass path_to_file
Optional if --enable is specified. If the password file is not in the default location
of ~/.pgpass, specifies the location of the password file.

--verbose
Sets the logging level to verbose.

--help | -h | -?
Displays the online help.

Examples
Create the Command Center database (gpperfmon) only:

$ su - gpadmin

$ gpperfmon_install

Create the Command Center database (gpperfmon), create the gpmon superuser, and enable the Command Center agents:
$ su - gpadmin
$ gpperfmon_install --enable --password p@$$word --port 5432
$ gpstop -r

gpcmdr
Configures and manages instances of the Command Center Console.

Synopsis
gpcmdr --setup [instance_name]
| --start [instance_name]
| --stop [instance_name]
| --restart [instance_name]
| --status [instance_name]

Description
The gpcmdr utility sets up and configures Command Center Console instances, starts and stops instances, and provides status information.
For all actions, including starting and stopping, you can specify a console instance name. If you do not specify a name, the action applies to all existing console instances.

Options
--setup
Configures console components on the installation host. With this option, gpcmdr prompts for values to configure the components and writes the values to gpperfmonui.conf and lighttpd.conf. 

--start
Starts the specified instance (or all instances by default) and its associated web service.
--stop
Stops the specified instance (or all instances by default) and its associated web service.
--restart
Restarts the specified instance (or all instances by default) and its associated web service.
--status
Displays the status, either Running or Stopped, of the web service.
--version
Displays the version of the gpperfmon utility and the lighttpd web service.

Examples
Start the utility in order to install and configure a new instance:
$ gpcmdr --setup

Check the status of Command Center:
$ gpcmdr --status
Comments