Google Git
Sign in
apache / cassandra-sidecar / cf796be039b9b08364de11fd7fec8a00cf699616
commitcf796be039b9b08364de11fd7fec8a00cf699616[log] [tgz]
authorFrancisco Guerrero <francisco.guerrero@apple.com>Tue Jun 27 21:20:13 2023 -0700
committerYifan Cai <ycai@apache.org>Thu Jul 13 13:53:55 2023 -0700
treeed2a0069b4293dfdb211fa2406d61dfbefba6aef
parentca8dd2e0381a19ede99ce4b70959ce7a584ea0d2 [diff]
CASSANDRASC-63: Support credential rotation in JmxClient

JMX credentials in a Cassandra instance can be rotated on a cadence, on every bounce, or by some other
means. In those cases, the `JmxClient` will no longer be able to connect to the instance completely
losing the ability to talk to that instance.

In this commit, we allow the `JmxClient` to support credential changes to be continue to talk to the
Cassandra instance uninterrupted without any potential downtime to the Sidecar service.

patch by Francisco Guerrero; reviewed by Dinesh Joshi, Yifan Cai for CASSANDRASC-63

# Conflicts:
#	CHANGES.txt
8 files changed
tree: ed2a0069b4293dfdb211fa2406d61dfbefba6aef
  1. .circleci/
  2. adapters/
  3. client/
  4. common/
  5. docs/
  6. gradle/
  7. ide/
  8. scripts/
  9. src/
  10. vertx-client/
  11. vertx-client-shaded/
  12. .gitignore
  13. build.gradle
  14. CHANGES.txt
  15. checkstyle.xml
  16. CONTRIBUTING.md
  17. gradle.properties
  18. gradlew
  19. gradlew.bat
  20. LICENSE.txt
  21. NOTICE.txt
  22. README.md
  23. settings.gradle
  24. spotbugs-exclude.xml
README.md

Apache Cassandra Sidecar [WIP]

This is a Sidecar for the highly scalable Apache Cassandra database. For more information, see the Apache Cassandra web site and CIP-1.

This is project is still WIP.

Requirements

  1. Java >= 1.8 (OpenJDK or Oracle), or Java 11
  2. Apache Cassandra 4.0. We depend on virtual tables which is a 4.0 only feature.
  3. Docker for running integration tests.

Build Prerequisites

We depend on the Cassandra in-jvm dtest framework for testing. Because these jars are not published, you must manually build the dtest jars before you can build the project.

./scripts/build-dtest-jars.sh

The build script supports two parameters:

  • REPO - the Cassandra git repository to use for the source files. This is helpful if you need to test with a fork of the Cassandra codebase.
    • default: git@github.com:apache/cassandra.git
  • BRANCHES - a space-delimited list of branches to build. -default: "cassandra-4.1 trunk"

Remove any versions you may not want to test with. We recommend at least the latest (released) 4.X series and trunk. See Testing for more details on how to choose which Cassandra versions to use while testing.

Getting started: Running The Sidecar

After you clone the git repo, you can use the gradle wrapper to build and run the project. Make sure you have Apache Cassandra running on the host & port specified in conf/sidecar.yaml.

$ ./gradlew run

Configuring Cassandra Instance

While setting up cassandra instance, make sure the data directories of cassandra are in the path stored in sidecar.yaml file, else modify data directories path to point to the correct directories for stream APIs to work.

Testing

The test framework is set up to run 4.1 and 5.0 (Trunk) tests (see TestVersionSupplier.java) by default.
You can change this via the Java property cassandra.sidecar.versions_to_test by supplying a comma-delimited string. For example, -Dcassandra.sidecar.versions_to_test=4.0,4.1,5.0.

CircleCI Testing

You will need to use the “Add Projects” function of CircleCI to set up CircleCI on your fork. When promoted to create a branch, do not replace the CircleCI config, choose the option to do it manually. CircleCI will pick up the in project configuration.

Contributing

We warmly welcome and appreciate contributions from the community. Please see CONTRIBUTING.md if you wish to submit pull requests.

Wondering where to go from here?