Setup Configuration File

A setup configuration file contains properties used to define one or more Greenplum Command Center instances when gpcmdr is run with the --config_file option.

The configuration file uses the Python configuration file format, similar to the Microsoft INI file format. The file contains sections, introduced by a [section] header, and followed by name: value or name=value entries, one per line. Comments begin with a # or ; character and continue through the end of the line. A [DEFAULT] section sets default values for parameters that may be overriden in other sections.

See Setting Up Command Center Instances with a Configuration File for more information.

Parameters

remote_db

True if the instance is to run on a different host. Default: False.

master_host

The name of the host where the Greenplum Command Center Console is to be set up, if remote_db is True.

instance_name

The name of the instance to set up. This will become the name of a subdirectory in the instances directory where the instances configuration and log files are stored. Instance names may contain letters, digits, and underscores and are not case sensitive.

display_name

The name to display for the instance in the Command Center user interface. Display names may contain letters, digits, and underscores and are case sensitive. instance_name is used for display_name if this parameter is not provided.

master_port

The Greenplum Database master port. Default: 5432.

webserver_port

The listen port for the Command Center gpmonws server. This port must be different for each Command Center Console instance on the host. Default: 28080.

enable_ssl

True if client connections to the Command Center web server should be secured with SSL. Default: False.

ssl_cert_file

If enable_ssl is True, set this parameter to the full path to a valid certificate in PEM file format.

enable_kerberos

Set to True to enable Kerberos authentication.

webserver_url

The web server hostname, from the Kerberos HTTP service principal.

keytab

Path to the keytab file containing Kerberos principals for the Command Center web server and users.

enable_copy_standby

Set to True to have gpcmdr install the instance configuration on the Greenplum standby master host.

standby_master_host

The name of the Greenplum standby master host. Required when enable_copy_standby is True.

Examples

This example configuration sets up two Command Center instances, prod and dev. Parameters in the [DEFAULT] section apply to all instances and may be overridden by parameters in the [production] and [development] sections.

[DEFAULT]
remote_db=false
master_port=5432
ssl_cert_file=/tmp/cert.pem

[development]
instance_name=development
enable_copy_standby=false
webserver_port=28080
enable_ssl=false

[production]
instance_name=production
display_name=OurProduction
remote_db=true
master_host=mdw
master_port=15432
webserver_port=28081
enable_ssl=true
enable_copy_standby=true
standby_master_host=smdw

This example configuration has only one instance, so the [DEFAULT] section and section headers are not necessary.

instance_name=single
display_name=SINGLE
remote_db=true
master_host=10.152.10.149
master_port=5432
webserver_port=28082
enable_ssl=true
ssl_cert_file=/tmp/cert.pem
enable_copy_standby = true
standby_master_host=192.0.2.156