scylladb / scylladb/alternator-client-java
Document reasoning about aws region
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 0
- Forks
- 7
- Avg merge
- 21h 23m
- Merged PRs (30d)
- 9
Description
Jira task: https://scylladb.atlassian.net/browse/DRIVER-669
Jira epic: https://scylladb.atlassian.net/browse/DRIVER-27
Copied from Jira epic DRIVER-27:
There is a problem that we provide bogus AWS region name to the aws client.
If client have tracing/debuging or anything else that looks at aws region it can create confusion or missbehavior.
We need to document reasoning behind bogus AWS region and a way to set it properly.
Example case: https://github.com/scylladb/alternator-load-balancing/issues/30
Migrated from GitHub issue: https://github.com/scylladb/alternator-load-balancing/issues/32
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the linked Jira task DRIVER-669 and epic DRIVER-27, then review the example in alternator-load-balancing issue 30. Document why the client currently uses a bogus AWS region, the resulting confusion, and how users can set the region properly; the documentation is done when both the rationale and configuration method are clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, java
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100