The following guide shows you how to configure Shotover with support for proxying to a Cassandra Cluster.
In this example, we will be connecting to a Cassandra cluster that has the following topology:
Rewriting the peer ports
Shotover will be deployed as a sidecar to each node in the Cassandra cluster, listening on
9043. Use the following docker-compose.yaml to run the Cassandra cluster and Shotover sidecars. In this example we want to ensure that all our traffic to Cassandra goes through Shotover.
curl -L https://raw.githubusercontent.com/shotover/shotover-proxy/main/shotover-proxy/example-configs-docker/cassandra-peers-rewrite/docker-compose.yaml --output docker-compose.yaml
Below we can see an example of a Cassandra node and it's Shotover sidecar, notice that they are running on the same network address (
172.16.1.2) and the present directory is being mounted to allow Shotover to access the config and topology files.
cassandra-two: image: bitnami/cassandra:4.0 networks: cassandra_subnet: ipv4_address: 172.16.1.3 healthcheck: *healthcheck environment: *environment shotover-one: restart: always depends_on: - cassandra-two image: shotover/shotover-proxy network_mode: "service:cassandra-two" volumes: - type: bind source: $PWD target: /config
In this example we will use
cqlsh to connect to our cluster.
First we will modify our
topology.yaml file to have a single Cassandra source. This will:
- Define how Shotover listens for incoming connections from our client (
- Configure Shotover to connect to the Cassandra node via our defined remote address.
- Configure Shotover to rewrite all Cassandra ports with our Shotover port when the client connects
- Connect our Cassandra source to our Cassandra sink (transform).
Modify an existing
topology.yaml or create a new one and place the above example as the file's contents.
You will also need a config.yaml to run Shotover.
curl -L https://raw.githubusercontent.com/shotover/shotover-proxy/main/shotover-proxy/config/config.yaml --output config.yaml
We can now start the services with:
docker-compose up -d
With everything now up and running, we can test it out with our client. Let's start it up!
First we will run
cqlsh directly on our cluster with the command:
cqlsh 172.16.1.2 9042 -u cassandra -p cassandra
and check the
system.peers_v2 table with the following query:
SELECT peer, native_port FROM system.peers_v2;
You should see the following results returned:
peer | native_port ------------+------------- 172.16.1.3 | 9042 172.16.1.4 | 9042
Now run it again but on the Shotover port this time, run:
cqlsh 172.16.1.2 9043 -u cassandra -p cassandra
and use the same query again. You should see the following results returned, notice how the
native_port column is now the Shotover port of
peer | native_port ------------+------------- 172.16.1.3 | 9043 172.16.1.4 | 9043
If everything has worked, you will be able to use Cassandra, with your connection going through Shotover!
Adding Rate Limiting
The next section of this tutorial will cover adding rate limiting to your Cassandra cluster with Shotover. We will add the
RequestThrottling transform to our
topology.yaml as shown below. This transform should go at the front of the chain to prevent any unnecessary operations from occurring if a query is going to be rate limited.
--- sources: cassandra_prod: Cassandra: listen_addr: "0.0.0.0:9043" chain_config: main_chain: - RequestThrottling: max_requests_per_second: 40000 - CassandraPeersRewrite: port: 9043 - CassandraSinkSingle: remote_address: "127.0.0.1:9042" connect_timeout_ms: 3000 named_topics: testtopic: 5 source_to_chain_mapping: cassandra_prod: main_chain
In this example we will set your
max_requests_per_second to 40,000. This will allow a max of 40,000 queries per second to go through this Shotover instance, across all connections.
After completing this step you can restart your cluster with
docker-compose restart to enable rate limiting.