gpss.json

A newer version of this documentation is available. Click here to view the most up-to-date release of the Greenplum 5.x documentation.

gpss.json

Greenplum Stream Server configuration file.

Synopsis

{
    "ListenAddress": {
        "Host": "gpss_host",
        "Port": gpss_portnum [,
        "SSL": use_ssl ]
    },
    "Gpfdist": {
        "Host": "gpfdist_host",
        "Port": gpfdist_portnum
    } [,
    "Certificate": {
        "CertFile": "certfile_path",
        "KeyFile": "keyfile_path",
        "CAFile": "CAfile_path"
    }]
}

Description

You specify runtime configuration properties for the gpss server utility in a JSON-formatted configuration file. Run properties for GPSS include server and gpfdist hosts and port numbers and optional encryption certificates and key files.

This reference page uses the name gpss.json to refer to this file; you may choose your own name for the file.

Keywords and Values

GPSS ListenAddress Options
Host: gpss_host
The host name or IP address on which GPSS listens for client connections. The default host is 127.0.0.1.
Port: gpss_portnum
The port number on which the gpss service instance listens. The default port number is 5000.
SSL: use_ssl
A boolean that identifies whether or not to use encrypted connections. The default value is false, do not use encryption.
Gpfdist Options
Host: gpfdist_host
The name or IP address of the host on which gpfdist is running. The default host is the output of the hostname command.
Port: gpfdist_portnum
The gpfdist port number. The default port number is 8080.
gpss and gpfdist Encryption Options

When you specify encryption options, GPSS uses the SSL certificates to authenticate both the client connection to itself and the connection to Greenplum Database. GPSS uses the gpfdists protocol to transfer encrypted data between itself and Greenplum Database.

CertFile: certfile_path
File system path to the server certificate.
KeyFile: keyfile_path
File system path to the server key file.
CAFile: CAfile_path
File system path to the Certificate Authority file. The CAfile_path must contain the entire Certificate Authority chain.

Examples

Start a Greenplum Stream Server instance with properties as defined in a configuration file named gpss4ic.json located in the current directory:

$ gpss gpss4ic.json

Example gpss4ic.json configuration file:

{
    "ListenAddress": {
        "Host": "",
        "Port": 50007
    },
    "Gpfdist": {
        "Host": "",
        "Port": 8319
    }
    "Certificate": {
        "CertFile": "/home/gpadmin/gpdb_bin/ext/server.crt",
        "KeyFile": "/home/gpadmin/gpdb_bin/ext/server.key",
        "CAFile": "/home/gpadmin/gpdb_bin/ext/rootCA.pem"
    }
}

See Also

gpss