https://github.com/instaclustr/instaclustr-minotaur

Tooling for consistent rebuilding of a Cassandra cluster
https://github.com/instaclustr/instaclustr-minotaur

apache build cassandra cli cluster consistent java keyspace netapp-public rebuild rebuilding tool

Last synced: 3 months ago
JSON representation

Tooling for consistent rebuilding of a Cassandra cluster

• Host: GitHub
• URL: https://github.com/instaclustr/instaclustr-minotaur
• Owner: instaclustr
• License: apache-2.0
• Created: 2020-10-23T06:15:58.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-10-21T07:56:33.000Z (over 3 years ago)
• Last Synced: 2024-06-21T18:44:31.404Z (8 months ago)
• Topics: apache, build, cassandra, cli, cluster, consistent, java, keyspace, netapp-public, rebuild, rebuilding, tool
• Language: Java
• Homepage: https://instaclustr.com
• Size: 121 KB
• Stars: 7
• Watchers: 5
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

        
# Instaclustr Minotaur

_Minotaur is a command line tool for consistent rebuilding of a Cassandra cluster._

image:https://img.shields.io/maven-central/v/com.instaclustr/minotaur.svg?label=Maven%20Central[link=https://search.maven.org/search?q=g:%22com.instaclustr%22%20AND%20a:%22minotaur%22]

image:https://circleci.com/gh/instaclustr/instaclustr-minotaur.svg?style=svg["Instaclustr",link="https://circleci.com/gh/instaclustr/instaclustr-minotaur"]

image::Minotaur.png[Minotaur,width=50%]

- Website: https://www.instaclustr.com/

- Documentation: https://www.instaclustr.com/support/documentation/

## Building

[source=bash]

----

$ mvn clean install

----

Artifacts are in `target`.

We provide:

* Minotaur jar

* rpm package

* deb package

## Example

[source=bash]

----

# here we suppose you have installed e.g. RPM

$ minotaur \

    --jmx-keystore=/path/to/keystore.p12 \

    --jmx-keystore-password=cassandra \

    --jmx-password=cassandra \

    --jmx-truststore=/path/to/truststore.jks \

    --jmx-truststore-password=cassandra \

    --jmx-user=cassandra \

    --jmx-service=172.19.0.10 \

    -k my_keyspace \

    -s dc1 \

----

JAR invocation

[source=bash]

----

$ java -jar target/minotaur.jar {args}

----

## Cassandra Version Compatibility

We have tested this against 3.11 and 4.0. Other versions should work ootb too as

we are just talking via JMX.

## Help

[source=bash]

----

Usage: minotaur [-hV] [--jmx-client-auth] [--jmx-keystore=[STRING]]

                [--jmx-keystore-password=[STRING]] [--jmx-password=[STRING]]

                [--jmx-service=[ADDRESS][:PORT]|[JMX SERVICE URL]] [--jmx-truststore=[PATH]]

                [--jmx-truststore-password=[PATH]] [--jmx-user=[STRING]]

                [-k=] -s=

Application for consistent rebuilding of a Cassandra cluster

  -h, --help                Show this help message and exit.

      --jmx-client-auth     boolean saying if c.s.m.j.ssl.need.client.auth should be set, defaults to false

      --jmx-keystore=[STRING]

                            Path to keystore file for Cassandra

      --jmx-keystore-password=[STRING]

                            Password to keystore file for Cassandra

      --jmx-password=[STRING]

                            Password for JMX for Cassandra

      --jmx-service=[ADDRESS][:PORT]|[JMX SERVICE URL]

                            Address (and optional port) of a Cassandra instance to connect to via JMX.

ADDRESS may be a

                              hostname, IPv4 dotted or decimal address, or IPv6 address. When ADDRESS

                              is omitted, the loopback address is used. PORT, when specified, must

                              be a valid port number. The default port 7199 will be substituted if

                              omitted. Defaults to ':7199'

      --jmx-truststore=[PATH]

                            Path to truststore file for Cassandra

      --jmx-truststore-password=[PATH]

                            Password to truststore file for Cassandra

      --jmx-user=[STRING]   User for JMX for Cassandra

  -k, --keyspaces=

                            if no keyspace is specified, all keyspaces on non-local strategy will be rebuilt.

  -s, --source-dc=

  -V, --version             Print version information and exit.

----

## Logging

We are using logback. `logback.xml` is already embedded in the built JAR, however if you

want to configure it feel free to provide your own `logback.xml` and configure it as follows:

----

java -Dlogback.configurationFile=my-custom-logback.xml -jar minotaur.jar ...

----

You can find the original file in `src/main/resources/logback.xml`.

## Further Information

- Please see https://www.instaclustr.com/support/documentation/announcements/instaclustr-open-source-project-status/ for Instaclustr support status of this project