Skip to content

adjustments to clarify the README - CASSSIDECAR-488 - #373

Open
aar0np wants to merge 2 commits into
apache:trunkfrom
aar0np:trunk
Open

adjustments to clarify the README - CASSSIDECAR-488#373
aar0np wants to merge 2 commits into
apache:trunkfrom
aar0np:trunk

Conversation

@aar0np

@aar0np aar0np commented Aug 4, 2026

Copy link
Copy Markdown

As per 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.

Comment thread README.md
./scripts/build-dtest-jars.sh
```

The build script supports two parameters:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

after moving this script to the bottom of the section, "The build script" can read confusing.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it. Adding an extra sentence to clarify that.

Comment thread README.md
Comment on lines -59 to 84
### macOS network aliases
To get up and running, create a temporary alias for every node except the first:

```
for i in {2..20}; do sudo ifconfig lo0 alias "127.0.0.${i}"; done
```

Note that this does not persist across reboots, so you'll have to run it every time you restart.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is specifically required for macOS only.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That "macOS network aliases" header is still there, it's just a little higher up.

Comment thread README.md Outdated
Comment on lines 72 to 77
### 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).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those 2 paragraphs are common and should not be under macOS network aliases

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh...I see what you mean. Let me move those two paragraphs ABOVE the "macOS network aliases" header like it was before.

@aar0np

aar0np commented Aug 4, 2026

Copy link
Copy Markdown
Author

Ok, corrections made.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants