Skip to content

Commit cd8211a

Browse files
committed
Remove token-aware use case for multiple proxies
1 parent 204c636 commit cd8211a

File tree

1 file changed

+1
-29
lines changed

1 file changed

+1
-29
lines changed

README.md

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,7 @@ All configuration keys match their command-line flag counterpart, e.g. `--astra-
108108
109109
#### Setting up peer proxies
110110
111-
There a couple cases when it is useful to setup multiple proxies:
112-
* Multi-region failover with DC-aware load balancing policy.
113-
* Compatibility with drivers that require a replication factor number of nodes (proxies) in a cluster for token-aware load balancing. This is not a problem for most drivers as they print a warning when there's less than replication factor nodes, and fallback to round-robin load balancing. The `gocql` driver is a notable exception, it panics when there's not enough proxies. In this case, it is best to configure the round-robin load balancing policy, but if that can't be done then multiple proxies should be used.
111+
Multi-region failover with DC-aware load balancing policy is the most useful case for a multiple proxy setup.
114112
115113
When configuration `peers:` it is required to set `--rpc-address` (or `rpc-address:` in the yaml) for each proxy and it must match is correspond `peers:` entry. Also, `peers:` is only available in the configuration file and cannot be set using a command-line flag.
116114
@@ -142,32 +140,6 @@ peers:
142140
143141
*Note:* It's okay for the `peers:` to contain entries for the current proxy itself because they'll just be omitted.
144142
145-
##### Token-aware bypass setup
146-
147-
This setup is similar to the multi-region setup but is simpler because all proxy instances share the same data center value which can just use the default value (`dc1`). Replication factor is often set to `3`, so it will require creating three instances of the proxy, but this may be different for your application.
148-
149-
```sh
150-
cql-proxy --astra-token <astra-token> --astra-database-id <astra-database-id> \
151-
--bind 127.0.0.1:9042 --rpc-address 127.0.0.1 --config proxy.yaml
152-
```
153-
154-
```sh
155-
cql-proxy --astra-token <astra-token> --astra-database-id <astra-database-id> \
156-
1 --bind 127.0.0.2:9042 --rpc-address 127.0.0.2 --config proxy.yaml
157-
```
158-
159-
```sh
160-
cql-proxy --astra-token <astra-token> --astra-database-id <astra-database-id> \
161-
--bind 127.0.0.3:9042 --rpc-address 127.0.0.3 --config proxy.yaml
162-
```
163-
164-
```yaml
165-
peers:
166-
- rpc-address: 127.0.0.1
167-
- rpc-address: 127.0.0.2
168-
- rpc-address: 127.0.0.3
169-
```
170-
171143
## Getting started
172144
173145
There are three methods for using `cql-proxy`:

0 commit comments

Comments
 (0)