https://github.com/kurtosis-tech/cassandra-package

A Kurtosis Starlark Package that spins up a Cassandra Network
https://github.com/kurtosis-tech/cassandra-package

cassandra distributed-systems docker-compose kurtosis kurtosis-package

Last synced: about 2 months ago
JSON representation

A Kurtosis Starlark Package that spins up a Cassandra Network

• Host: GitHub
• URL: https://github.com/kurtosis-tech/cassandra-package
• Owner: kurtosis-tech
• Created: 2023-03-07T12:30:48.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-02T14:38:48.000Z (9 months ago)
• Last Synced: 2024-07-08T13:49:08.288Z (2 months ago)
• Topics: cassandra, distributed-systems, docker-compose, kurtosis, kurtosis-package
• Language: Starlark
• Homepage:
• Size: 1.81 MB
• Stars: 0
• Watchers: 8
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
### Cassandra Package

![Run of the Cassandra Package](/run.gif)

This is a [Kurtosis Starlark Package](https://docs.kurtosis.com/explanations/starlark) that allows you to spin up an `n node` Cassandra Cluster. It spins

up 3 nodes by default but you can tweak it

### Run

This assumes you have the [Kurtosis CLI](https://docs.kurtosis.com/cli) installed

Simply run

```bash

kurtosis run github.com/kurtosis-tech/cassandra-package

```

If you want to override the number of nodes,

```

kurtosis run github.com/kurtosis-tech/cassandra-package '{"num_nodes": }'

```

If you want to run this with monitoring on top; use

```

kurtosis run github.com/kurtosis-tech/cassandra-package '{"monitoring_enabled": true}'

```

This will spin up local instances of Prometheus and Grafana connected to your Cassandra cluster using a `jmx_exporter`. If you copy the Grafana URL from the output of

enclave run and paste it in your browser; you will be able to interact with metrics and dashboards on Grafana.

`admin` is the default value for the username & password for Grafana. The dashboard is under `dashboards/Cassandra Dashboard`.

### Using this in your own package

Kurtosis Packages can be used within other Kurtosis Packages, through what we call composition internally. Assuming you want to spin up Cassandra and your own service

together you just need to do the following

```py

main_cassandra_module = import_module("github.com/kurtosis-tech/cassandra-package/main.star")

# main.star of your Cassandra + Service package

def run(plan, args):

    plan.print("Spinning up the Cassandra Package")

    # this will spin up cassandra and return the output of the Cassandra package [cassandra-node-0 .. casandra-node-n]

    # any args (including num_datastores) parsed to your package would get passed down to the Cassandra Package

    cassandra_run_output = main_cassandra_module.run(plan, args)

```