The starctl command
The starctl
command controls and configures Stargate nodes.
Starting Stargate using starctl
starctl --cluster-name stargate \
--cluster-seed 127.0.0.1 \
--cluster-version 3.11 \
--listen 127.0.0.2 \
--simple-snitch
When Stargate is launched on a host as shown above, it will connect only to Cassandra clusters accessible on the host’s network. To run Stargate in a containerized environment, see the Installing Stargate with an existing Cassandra cluster documentation. |
starctl options
Option | Environment Variable | Default | Description | Example |
---|---|---|---|---|
|
|
Name of database cluster. |
|
|
|
|
The IP address of the seed node of the cluster. |
|
|
|
|
The major version of the database cluster. |
|
|
|
|
127.0.0.1 |
IP address Stargate services should listen on. This options value must match the regular expression
|
|
|
|
7000 |
Port that seed nodes are listening on. This options value represents a port and must fall in one of the following port ranges: 0, 1024-49151, 49152-65535 |
|
|
|
Datacenter name of this node. This must match the database backend. |
|
|
|
|
Rack name of this node. This must match the database backend. |
|
|
|
|
unset, or false |
Set this option if the backend cluster uses |
|
|
|
unset, or false |
Set if the backend is DSE. Do not set this option if the backend is Cassandra. |
|
|
|
9042 |
Port on which the CQL API service listens. This options value represents a port and must fall in one of the following port ranges: 0, 1024-49151, 49152-65535 |
|
|
|
unset, or false |
Set to enable |
|
|
|
unset, or false |
Use proxy protocol to determine the public address and port of CQL requests. |
|
|
|
unset, or false |
Enables developer mode, where the Stargate node behaves as a regular Cassandra node, joining the ring with tokens assigned in order to facilitate getting started quickly and not requiring additional nodes or an existing cluster. |
|
|
|
unset, or false |
If set bind the web services to the listen address only. |
|