LATEST VERSION: 3.3.1 - CHANGELOG
Pivotal Greenplum Command Center v3.3.1

Creating Greenplum Command Center Console Instances

A Command Center Console instance is a web server providing an HTML5 graphical console application to monitor system metrics and perform some administrative tasks for a single Greenplum Database cluster.

The Command Center Console runs on the gpmonws web server. The default web server port is 28080. Configuration files, log files, and runtime files for each Command Center instance are managed in a subdirectory of the $GPPERFMONHOME/instances directory.

If you have multiple Greenplum Database instances, you can create separate Command Center Console instances for each of them. Each separate console instance operates on a unique port and has its own unique configuration options. A multi-cluster view may be enabled to allow you to view status for all clusters. See Enabling Multi-Cluster Support for more information.

For more information about the web server, see Web Server Administration.

The Command Center Console supports current browser versions of Chrome, Safari, Firefox, and Internet Explorer.

Before You Begin

Ensure that the following prerequisites are satisfied:

  • Greenplum Command Center software is installed. See Install the Greenplum Command Center Software.
  • The gpperfmon database is created and the data collection agents are running. See Creating the gpperfmon Database.
  • The gpmon user is created and is able to log in to the gpperfmon database (psql -U gpmon gpperfmon).
  • Any certificates or Kerberos keytab files needed for encryption and user authentication are installed. These files must be readable by the gpadmin user. See Securing a Greenplum Command Center Console Instance.
  • If the gpmon user is to be authenticated with Kerberos, install the keytab file for the gpmon Kerberos principal on the Greenplum master and standby hosts and run kinit gpmon before you begin to create the Command Center Console instance. See Securing the gpmon Database User for more information.

The gpcmdr --setup command-line utility sets up the Command Center instance. The command can be run interactively, or you can create a configuration file and run the command non-interactively. If you use a configuration file, you can create multiple Command Center instances at once.

Creating the Greenplum Command Center Instance (Interactive)

Follow the steps below to create a new Command Center Console instance. To accept the displayed default values for any parameters at configuration time, press the ENTER key. To monitor multiple Greenplum Database clusters, run the Setup utility separately to create an instance for each cluster.

  1. Log in as the Greenplum administrator (gpadmin) and source the <gpcc-install-dir>/gpcc_path.sh file.
  2. With the Greenplum Database instance running, launch Setup.

    $ gpcmdr --setup
    
  3. Setup prompts you to enter an instance name. The instance name can contain letters, digits, and underscores.

  4. Setup prompts you to enter a display name for the instance. This name is displayed in the Command Center Console user interface to identify the instance. Enter a display name or press ENTER to use the instance name you entered in the previous step.

  5. Setup asks if the Greenplum Database master host is remote.

    If the master instance is on a different host enter y, and then enter the master host name and port number at the next prompts. Be sure to enter the host name—not the IP number—if you want to use Greenplum Command Center’s Workload Manager features.

  6. Setup asks if you want to enable Kerberos authentication for the new instance.

    To use this feature, Kerberos authentication must be enabled for Greenplum Database and the Kerberos administrator must have created a keytab file for Command Center. See Enabling Kerberos Authentication with Greenplum Command Center for details.

    If you enter n you can enable Kerberos authentication later using the gpcmdr --krbenable command.

    If you choose to enable Kerberos authentication:

    1. At the prompt Enter web server name for this instance enter the name of the host from the Kerberos principal.

      The principal name is in the format HTTP/<host>@<realm>. The host must be entered in the same format as the Kerberos principal and should exclude the port number.

    2. At the prompt Enter the GPDB Kerberos service name enter the name of the Kerberos service principal for Greenplum Database, which is in the format postgres/<host>@<realm>.

    3. At the prompt Choose Kerberos mode enter the number of the Kerberos mode you want to use.

      See Enabling Authentication With Kerberos for a description of these options.

    4. At the prompt Enter the path to the keytab file enter the full path to the keytab containing the web server principal.

      If you are setting up this instance on the Greenplum master, the keytab file may be the same one used for Greenplum Database. The file must be readable by the gpadmin user.

  7. Setup asks if you want to enable SSL connections for the Command Center Console. Enabling SSL also enables WebSockets for Command Center connections.

    Note: Because database login information is sent over the network, it is strongly recommended to enable SSL to encrypt Command Center communications.

    If you enter y to enable SSL, Setup asks you to specify the location of your X509 certificate file.

    Enter the full path to the certificate file. The certificate must be accessible and readable by the user that runs the Command Center web server. The path you enter is added to the Command Center instance’s app.conf file.

  8. Setup asks if you want to copy this Command Center instance to a standby master.

    This option is not available for remote installations.

    If you enter y, Setup prompts you to enter the standby master host name.

  9. Setup prompts you to enter the port number for the Command Center instance web server.

    Each Command Center instance that runs on the host must have a unique port number. The default port number is 28080.

  10. Setup asks if you want to enable SSL for the Web API.

    Enabling SSL for the Web API ensures that the Command Center application GPCC REST API requests and responses are encrypted.

    If you enter y Setup prompts you to enter the path to the certificate file to use to authenticate the server for Web API requests.

Setup creates the new Greenplum Command Center instance in a subdirectory of $GPPERFMONHOME/instances with the name of the instance. See About the Command Center Installation for a description of the contents of this directory.

Start the new Console instance with the following command:

gpcmdr --start <instance-name>

See Connecting to the Greenplum Command Center Console to connect to the instance from a workstation.

See Configuring Authentication for the Command Center Console for help setting up access for Command Center users.

Creating the Command Center Console Instance (Non-interactive)

It can be useful to run gpcmdr --setup non-interactively, taking input from a file. For example, you could install GPCC and create Command Center instances as part of a Greenplum cluster installation script. To accomplish this, create a configuration file and supply it to the gpcmdr utility using the --config_file option:

gpcmdr --setup --config_file file

The configuration file is similar to a Windows INI file, containing one or more sections beginning with a section header in square braces. Parameters in the optional [DEFAULT] section apply to all subsequent sections and may be overridden. Each section other than [DEFAULT] defines a Command Center Console instance to create.

Parameters are specified one-per-line as name-value pairs separated with equals signs (=) or colons (:). Comments begin with a number sign (#) or semicolon (;) and continue to the end of the line.

Here is an example configuration file:

[DEFAULT]
# defaults apply to all instances
remote_db: false
enable_copy_standby: true
standby_master_host: smdw
enable_kerberos: false
enable_ssl: true
ssl_cert_file: /etc/ssl/certs/cert.pem

[production]
master_hostname: mdw
instance_name: prod
display_name: Production
master_port: 5432
web_port: 28080

[development]
master_hostname: mdw
instance_name: dev
enable_copy_standby: false ; override
display_name: Development
master_port: 5532
web_port: 28090

See Setup Configuration File for a detailed description of the setup configuration file syntax and parameters.

Start the Command Center Console Instance

Start the Greenplum Command Center Console instance by entering:

gpcmdr --start

If you do not specify an instance name, all Command Center Console instances are started. To start a particular instance, you can specify the name of the instance. For example:

gpcmdr --start instance_name

See Administering Greenplum Command Center for a complete list of administrative commands.