Skip to content

Commit 31e7c94

Browse files
authored
Update README with known issues (#89)
* Update README with known issues * Fix wording
1 parent 187088e commit 31e7c94

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
- [Locally build and run](https://github.com/datastax/cql-proxy#locally-build-and-run)
1212
- [Run a `cql-proxy` docker image](https://github.com/datastax/cql-proxy#run-a-cql-proxy-docker-image)
1313
- [Use Kubernetes](https://github.com/datastax/cql-proxy#use-kubernetes)
14+
- [Known issues](https://github.com/datastax/cql-proxy#known-issues)
15+
- [Token-aware load balancing](https://github.com/datastax/cql-proxy#token-aware-load-balancing)
1416

1517

1618
## What is `cql-proxy`?
@@ -200,6 +202,11 @@ Using Kubernetes with `cql-proxy` requires a number of steps:
200202
```sh
201203
kubectl logs <deployment-name>
202204
```
205+
## Known issues
206+
207+
### Token-aware load balancing
208+
209+
Drivers that use token-aware load balancing may print a warning or may not work when using cql-proxy. Because cql-proxy abstracts the backend cluster as a single endpoint this doesn't always work well with token-aware drivers that expect there to be at least "replication factor" number of nodes in the cluster. Many drivers print a warning (which can be ignored) and fallback to something like round-robin, but other drivers might fail with an error. For the drivers that fail with an error it is required that they disable token-aware or configure the round-robin load balancing policy.
203210
204211
[astra]: https://astra.datastax.com/
205212
[drivers]: https://docs.datastax.com/en/driver-matrix/doc/driver_matrix/common/driverMatrix.html
@@ -210,5 +217,3 @@ Using Kubernetes with `cql-proxy` requires a number of steps:
210217
[dse]: https://www.datastax.com/products/datastax-enterprise
211218
[instructions]: https://docs.datastax.com/en/astra/docs/manage-application-tokens.html
212219
[bundle]: https://docs.datastax.com/en/astra/docs/obtaining-database-credentials.html#_getting_your_secure_connect_bundle
213-
214-

0 commit comments

Comments
 (0)