cluster property is used to configure a
CUE Zipline cluster.
It describes the members of the cluster and how they communicate.
Clustering is optional. If you only intend to run a single instance of
CUE Zipline then the
cluster property can be omitted. If you do intend to
run a cluster, then each
instance in the cluster must have a similar (but not identical)
cluster property definition. In a cluster of two, for
example, the instances might have the following cluster definitions:
cluster: instance_id: zipline01 instance_name: Zipline 1 listen_address: 0.0.0.0:12790 members: - zipline1.myproject.com:12790,zipline2.myproject.com:12790 - zipline1.myproject.com:12790,zipline2.myproject.com:12790
cluster: instance_id: zipline02 instance_name: Zipline 2 listen_address: 0.0.0.0:12790 members: - zipline1.myproject.com:12790,zipline2.myproject.com:12790 - zipline1.myproject.com:12790,zipline2.myproject.com:12790
The internal ID of this CUE Zipline instance. The ID must be unique within the cluster. If not specified then it is set to the value of the
ZL_CLUSTER_INSTANCE_IDenvironment variable. If
ZL_CLUSTER_INSTANCE_IDis not set, then it is set to an automatically assigned UUID.
A descriptive name for the cluster instance. If not specified then it is set to the value of the
ZL_CLUSTER_INSTANCE_NAMEenvironment variable. If
ZL_CLUSTER_INSTANCE_NAMEis not set, then it is set to the name of the host.
The network address and port number to listen on for internal communication between CUE Zipline instances. The network address and port number must be accessible to all other instances in the cluster. If not specified then it is set to the value of the
ZL_CLUSTER_LISTEN_ADDRESSenvironment variable. If
ZL_CLUSTER_LISTEN_ADDRESSis not set, then it is set to
0.0.0.0:12790, which means "listen on port 12790, on all the host's network interfaces".
An array containing the network address and port number of each instance in the cluster. If not specified then it is set to the value of the
ZL_CLUSTER_MEMBERSenvironment variable. If
ZL_CLUSTER_MEMBERSis not set, then it is set to an empty array.
The value of
ZL_CLUSTER_MEMBERSmust be a comma-separated list of entries. For example:
membersis undefined or left as an empty array, then CUE Zipline will run as a single instance (always active).