Store Variables

GATEWAY_STORE_BACKEND

Whether to place store the gateway persistent data "locally" at
GATEWAY_APPLICATION_WORKING_DIR/gateway.db or in memory.

For more information see → Store Backend

Environment Variable

GATEWAY_STORE_BACKEND

File

Section: store
Key: backend

Default

local

Values

["local", "memory"]

GATEWAY_STORE_ETCD_CA_CERTIFICATE_FILE

The certificate authority certificate file to use when connecting to etcd.

Environment Variable

GATEWAY_STORE_ETCD_CA_CERTIFICATE_FILE

File

Section: store
Key: etcd_ca_certificate_file

Default

No default value provided

GATEWAY_STORE_ETCD_CERTIFICATE_FILE

The public certificate file to use when connecting to etcd.

Environment Variable

GATEWAY_STORE_ETCD_CERTIFICATE_FILE

File

Section: store
Key: etcd_certificate_file

Default

No default value provided

GATEWAY_STORE_ETCD_CLIENT_CERT_AUTH

When running gateway with GATEWAY_STORE_BACKEND set to etcd and with GATEWAY_STORE_ETCD_USE_TLS set to true, this configuration variable modifies what type of TLS authentication method will be used.

If set to false, gateway will attempt to connect to etcd using "Client-to-Server Transport Security" where the only required certificate on the gateway side will be from GATEWAY_STORE_ETCD_CA_CERTIFICATE_FILE.

This is the similar to Example 1: Client-to-server transport security with HTTPS in the etcd documentation.

If set to true, gateway will attempt to connect to etcd using"Client-to-Server Authentication" where mutual TLS authentication will occur between the gateway instance as well as the etcd server. This will require you to set:

• GATEWAY_STORE_ETCD_CA_CERTIFICATE_FILE
• GATEWAY_STORE_ETCD_CERTIFICATE_FILE
• GATEWAY_STORE_ETCD_PRIVATE_KEY_FILE

This is similar to Example 3: Transport security & client certificates in a cluster in the etcd documentation.

Environment Variable

GATEWAY_STORE_ETCD_CLIENT_CERT_AUTH

File

Section: store
Key: etcd_client_cert_auth

Default

false

GATEWAY_STORE_ETCD_HOSTS

When running gateway with GATEWAY_STORE_BACKEND set to etcd, this configuration variable allows you to set the etcd host that gateway should connect to for its backend storage. A host entry consists of an address and a port (e.g. hostname:port). If there is more than one host in the etcd cluster, the hosts should be separated by spaces (e.g. hostname1:port hostname2:port).

Environment Variable

GATEWAY_STORE_ETCD_HOSTS

File

Section: store
Key: etcd_hosts

Default

localhost:2379

GATEWAY_STORE_ETCD_PRIVATE_KEY_FILE

The private key file to use when connecting to etcd.

Environment Variable

GATEWAY_STORE_ETCD_PRIVATE_KEY_FILE

File

Section: store
Key: etcd_private_key_file

Default

No default value provided

GATEWAY_STORE_ETCD_USE_TLS

Controls whether or not gateway will utilize TLS authentication when connecting to the etcd cluster.

More information on configuring TLS on an etcd cluster can be found here → Etcd Database

Also see the etcd page here → Notes on TLS Authentication

Environment Variable

GATEWAY_STORE_ETCD_USE_TLS

File

Section: store
Key: etcd_use_tls

Default

true