Installing Stargate with an existing Cassandra cluster

Stargate can be installed alongside an existing Cassandra cluster.

Using Stargate with Cassandra 3.11

Pull the Docker image

This image contains the Cassandra Query Language (CQL), REST and GraphQL APIs, and GraphQL Playground along with an Apache Cassandra 3.11 backend.

docker pull stargateio/stargate-3_11:v0.0.8

Starting Stargate with Cassandra 3.11

Stargate can be added to an existing Cassandra 3.11 cluster operating in a containerized environment in the following way:

docker run --name stargate \
  -d stargateio/stargate-3_11:v0.0.8 \
  --cluster-name stargate \
  --cluster-seed 127.0.0.1 \
  --cluster-version 3.11 \
  --listen 127.0.0.2 \
  --simple-snitch

where:

  • --cluster-seed is set to the IP address of a running Cassandra node.

  • --cluster-version is set to the version of Cassandra running in the cluster.

  • --listen-address is set to the address on which Stargate will listen.

  • --simple-snitch sets the snitch on the Stargate node.

Use the --simple-snitch option if the endpoint_snitch setting in the cluster is set to SimpleSnitch. If the cluster uses a different endpoint_snitch use the --dc and --rack options to define the topology of the node.

The full set of options are described in the starctl documentation.

The --cluster-name option can alternately be set using -e and setting the CLUSTER_NAME environment variable to the name of the cluster.

The --cluster-version option can alternately be set using -e and setting the CLUSTER_VERSION environment variable to the version of the cluster.

The --developer-mode option can alternately be set using -e and setting the DEVELOPER_MODE environment variable to true.

When Stargate is launched within a container on Mac OS X as shown above, it will connect only to Cassandra clusters running within the same Docker environment. To run Stargate so that it can connect to a cluster running outside of a containerized environment, see the starctl documentation.