You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pr@cassandra.apache.org by "aar0np (via GitHub)" <gi...@apache.org> on 2026/08/04 17:14:37 UTC
[PR] adjustments to clarify the README - CASSSIDECAR-488 [cassandra-sidecar]
aar0np opened a new pull request, #373:
URL: https://github.com/apache/cassandra-sidecar/pull/373
As per [CASSSIDECAR-488](https://issues.apache.org/jira/browse/CASSSIDECAR-488):
- Revising CIP-1 to CEP1.
- Adding Cassandra version qualifiers to be 4.0 or greater.
- Adding instructions on how to download and run the binaries.
- Additional instructions for defining environment variables.
- Clarifying instructions for running the build.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] adjustments to clarify the README - CASSSIDECAR-488 [cassandra-sidecar]
Posted by "aar0np (via GitHub)" <gi...@apache.org>.
aar0np commented on code in PR #373:
URL: https://github.com/apache/cassandra-sidecar/pull/373#discussion_r3716657969
##########
README.md:
##########
@@ -30,33 +30,51 @@ We use the [Sidecar for Apache Cassandra JIRA](https://issues.apache.org/jira/pr
Requirements
------------
1. Java >= 11<sup>1</sup> (OpenJDK or Oracle)
- 2. Apache Cassandra 4.0. We depend on virtual tables which is a 4.0 only feature.
+ 2. Apache Cassandra >= 4.0. We depend on virtual tables which is a 4.0+ only feature.
3. [Docker](https://www.docker.com/products/docker-desktop/) for running integration tests.
+Running the Sidecar from the binaries
+-------------------------------------
+The latest version of the Sidecar can be found at: https://dlcdn.apache.org/cassandra/cassandra-sidecar/
+
+ - Download the Sidecar from the link above.
+ - Untar: `tar -zxvf apache-cassandra-sidecar-0.4.0.tar.gz`
+ - Adjust the `conf/sidecar.yaml` file.
+ - Run: `bin/cassandra-sidecar`
+
+
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.
-```shell
-./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"`
+If you have difficulty in getting the build process to use the crrect version of Java, you can also override the `JAVACMD` variable.
+
+The above mentioned parameters can also be defined as environment variables:
+```shell
+export JAVACMD="/Users/flynn/.jenv/shims/java"
+export BRANCHES="cassandra-5.0"
+```
+
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.
-For multi-node in-jvm dtests, network aliases will need to be setup for each Cassandra node. The tests assume each node's
-ip address is 127.0.0.x, where x is the node id.
+```shell
+./scripts/build-dtest-jars.sh
+```
+
+### macOS network aliases
+
+For multi-node in-jvm dtests, network aliases will need to be setup for each Cassandra node. The tests assume each node's ip address is 127.0.0.x, where x is the node id.
For example if you populated your cluster with 3 nodes, create interfaces for 127.0.0.2 and 127.0.0.3 (the first node of course uses 127.0.0.1).
Review Comment:
Oh...I see what you mean. Let me move those two paragraphs ABOVE the "macOS network aliases" header like it was before.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] adjustments to clarify the README - CASSSIDECAR-488 [cassandra-sidecar]
Posted by "aar0np (via GitHub)" <gi...@apache.org>.
aar0np commented on PR #373:
URL: https://github.com/apache/cassandra-sidecar/pull/373#issuecomment-5185389595
Ok, corrections made.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] adjustments to clarify the README - CASSSIDECAR-488 [cassandra-sidecar]
Posted by "aar0np (via GitHub)" <gi...@apache.org>.
aar0np commented on code in PR #373:
URL: https://github.com/apache/cassandra-sidecar/pull/373#discussion_r3716652920
##########
README.md:
##########
Review Comment:
That "macOS network aliases" header is still there, it's just a little higher up.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] adjustments to clarify the README - CASSSIDECAR-488 [cassandra-sidecar]
Posted by "yifan-c (via GitHub)" <gi...@apache.org>.
yifan-c commented on code in PR #373:
URL: https://github.com/apache/cassandra-sidecar/pull/373#discussion_r3714766278
##########
README.md:
##########
@@ -30,33 +30,51 @@ We use the [Sidecar for Apache Cassandra JIRA](https://issues.apache.org/jira/pr
Requirements
------------
1. Java >= 11<sup>1</sup> (OpenJDK or Oracle)
- 2. Apache Cassandra 4.0. We depend on virtual tables which is a 4.0 only feature.
+ 2. Apache Cassandra >= 4.0. We depend on virtual tables which is a 4.0+ only feature.
3. [Docker](https://www.docker.com/products/docker-desktop/) for running integration tests.
+Running the Sidecar from the binaries
+-------------------------------------
+The latest version of the Sidecar can be found at: https://dlcdn.apache.org/cassandra/cassandra-sidecar/
+
+ - Download the Sidecar from the link above.
+ - Untar: `tar -zxvf apache-cassandra-sidecar-0.4.0.tar.gz`
+ - Adjust the `conf/sidecar.yaml` file.
+ - Run: `bin/cassandra-sidecar`
+
+
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.
-```shell
-./scripts/build-dtest-jars.sh
-```
-
The build script supports two parameters:
Review Comment:
after moving this script to the bottom of the section, "The build script" can read confusing.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] adjustments to clarify the README - CASSSIDECAR-488 [cassandra-sidecar]
Posted by "aar0np (via GitHub)" <gi...@apache.org>.
aar0np commented on code in PR #373:
URL: https://github.com/apache/cassandra-sidecar/pull/373#discussion_r3716637951
##########
README.md:
##########
@@ -30,33 +30,51 @@ We use the [Sidecar for Apache Cassandra JIRA](https://issues.apache.org/jira/pr
Requirements
------------
1. Java >= 11<sup>1</sup> (OpenJDK or Oracle)
- 2. Apache Cassandra 4.0. We depend on virtual tables which is a 4.0 only feature.
+ 2. Apache Cassandra >= 4.0. We depend on virtual tables which is a 4.0+ only feature.
3. [Docker](https://www.docker.com/products/docker-desktop/) for running integration tests.
+Running the Sidecar from the binaries
+-------------------------------------
+The latest version of the Sidecar can be found at: https://dlcdn.apache.org/cassandra/cassandra-sidecar/
+
+ - Download the Sidecar from the link above.
+ - Untar: `tar -zxvf apache-cassandra-sidecar-0.4.0.tar.gz`
+ - Adjust the `conf/sidecar.yaml` file.
+ - Run: `bin/cassandra-sidecar`
+
+
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.
-```shell
-./scripts/build-dtest-jars.sh
-```
-
The build script supports two parameters:
Review Comment:
Got it. Adding an extra sentence to clarify that.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] adjustments to clarify the README - CASSSIDECAR-488 [cassandra-sidecar]
Posted by "yifan-c (via GitHub)" <gi...@apache.org>.
yifan-c commented on code in PR #373:
URL: https://github.com/apache/cassandra-sidecar/pull/373#discussion_r3714782921
##########
README.md:
##########
@@ -30,33 +30,51 @@ We use the [Sidecar for Apache Cassandra JIRA](https://issues.apache.org/jira/pr
Requirements
------------
1. Java >= 11<sup>1</sup> (OpenJDK or Oracle)
- 2. Apache Cassandra 4.0. We depend on virtual tables which is a 4.0 only feature.
+ 2. Apache Cassandra >= 4.0. We depend on virtual tables which is a 4.0+ only feature.
3. [Docker](https://www.docker.com/products/docker-desktop/) for running integration tests.
+Running the Sidecar from the binaries
+-------------------------------------
+The latest version of the Sidecar can be found at: https://dlcdn.apache.org/cassandra/cassandra-sidecar/
+
+ - Download the Sidecar from the link above.
+ - Untar: `tar -zxvf apache-cassandra-sidecar-0.4.0.tar.gz`
+ - Adjust the `conf/sidecar.yaml` file.
+ - Run: `bin/cassandra-sidecar`
+
+
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.
-```shell
-./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"`
+If you have difficulty in getting the build process to use the crrect version of Java, you can also override the `JAVACMD` variable.
+
+The above mentioned parameters can also be defined as environment variables:
+```shell
+export JAVACMD="/Users/flynn/.jenv/shims/java"
+export BRANCHES="cassandra-5.0"
+```
+
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.
-For multi-node in-jvm dtests, network aliases will need to be setup for each Cassandra node. The tests assume each node's
-ip address is 127.0.0.x, where x is the node id.
+```shell
+./scripts/build-dtest-jars.sh
+```
+
+### macOS network aliases
+
+For multi-node in-jvm dtests, network aliases will need to be setup for each Cassandra node. The tests assume each node's ip address is 127.0.0.x, where x is the node id.
For example if you populated your cluster with 3 nodes, create interfaces for 127.0.0.2 and 127.0.0.3 (the first node of course uses 127.0.0.1).
Review Comment:
Those 2 paragraphs are common and should not be under `macOS network aliases`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] adjustments to clarify the README - CASSSIDECAR-488 [cassandra-sidecar]
Posted by "yifan-c (via GitHub)" <gi...@apache.org>.
yifan-c commented on code in PR #373:
URL: https://github.com/apache/cassandra-sidecar/pull/373#discussion_r3714779033
##########
README.md:
##########
Review Comment:
This is specifically required for macOS only.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
Re: [PR] CASSSIDECAR-488: adjustments to clarify the README [cassandra-sidecar]
Posted by "yifan-c (via GitHub)" <gi...@apache.org>.
yifan-c merged PR #373:
URL: https://github.com/apache/cassandra-sidecar/pull/373
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org