gpss.json

A newer version of this documentation is available. Use the version menu above 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": bool_value ]
    },
    "Gpfdist": {
        "Host": "gpfdist_host",
        "Port": gpfdist_portnum [,
        "ReuseTables": bool_value ][,
        "BindAddress": bind_addr ]
    } [,
    "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 gpss and gpfdist service hosts, addresses, 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: bool_value
A boolean that identifies whether or not to use encrypted connections. The default value is false, do not use encryption.
Gpfdist Options

GPSS implements the gpfdist protocol. The gpss.json file exposes configuration options that you can use to identify the service location and bind options.

Host: gpfdist_host
The gpfdist service host name or IP address that GPSS sets in the external table LOCATION clause. The default value is the fully qualified distinguished name of the host on which GPSS is running.
Port: gpfdist_portnum
The gpfdist service port number. The default port number is 8080.
BindAddress: bind_addr
The address to which GPSS binds the gpfdist port. The default bind address is 0.0.0.0.
ReuseTables: bool_value
A boolean that identifies whether or not GPSS should reuse an external table when the job associated with a load operation is restarted. The default value is true, reuse the external table.
If you choose not to reuse external tables, GPSS deletes the external table associated with a load operation when you stop the job, and creates a new external table when you restart the job.
Note: You cannot re-enable external table reuse on a per-job basis when you disable external table reuse in this manner.
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