Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating table of contents: #102

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Updating table of contents: #102

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c13d86f
adding Homebrew install instructions.
aar0np Aug 15, 2022
9e7cd0e
adding Homebrew install instructions.
aar0np Aug 15, 2022
89c0f1f
adding relative URLs to table of contents.
aar0np Aug 15, 2022
c29afc4
adding relative URLs to table of contents.
aar0np Aug 15, 2022
e856c3f
adding relative URLs to table of contents.
aar0np Aug 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 29 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,16 @@

## Table of Contents

- [What is the cql-proxy?](https://github.com/datastax/cql-proxy#what-is-cqlproxy)
- [When to use cql-proxy](https://github.com/datastax/cql-proxy#when-to-use-cql-proxy)
- [Configuration](https://github.com/datastax/cql-proxy#configuration)
- [Getting started](https://github.com/datastax/cql-proxy#getting-started)
- [Locally build and run](https://github.com/datastax/cql-proxy#locally-build-and-run)
- [Run a `cql-proxy` docker image](https://github.com/datastax/cql-proxy#run-a-cql-proxy-docker-image)
- [Use Kubernetes](https://github.com/datastax/cql-proxy#use-kubernetes)
- [Known issues](https://github.com/datastax/cql-proxy#known-issues)
- [Token-aware load balancing](https://github.com/datastax/cql-proxy#token-aware-load-balancing)
- [What is cql-proxy?](#what-is-cql-proxy)
- [When to use cql-proxy](#when-to-use-cql-proxy)
- [Configuration](#configuration)
- [Getting started](#getting-started)
- [Locally build and run](#locally-build-and-run)
- [Run a `cql-proxy` docker image](#run-a-cql-proxy-docker-image)
- [Homebrew on a Mac](#homebrew-on-a-mac)
- [Use Kubernetes](#use-kubernetes)
- [Known issues](#known-issues)
- [Token-aware load balancing](#token-aware-load-balancing)


## What is `cql-proxy`?
Expand All @@ -27,7 +28,7 @@ The `cql-proxy` sidecar enables unsupported CQL drivers to work with [DataStax A

`cql-proxy` also enables applications that are currently using [Apache Cassandra][cassandra] or [DataStax Enterprise (DSE)][dse] to use Astra without requiring any code changes. Your application just needs to be configured to use the proxy.

If you're building a new application using DataStax [drivers], `cql-proxy` is not required, as the drivers can communicate directly with Astra. DataStax drivers have excellent support for Astra out-of-the-box, and are well-documented in the [driver-guide] guide.
If you're building a new application using DataStax [drivers], `cql-proxy` is not required, as the drivers can communicate directly with Astra. DataStax drivers have excellent support for Astra out-of-the-box, and are well-documented in the [driver-guide] guide.

## Configuration

Expand Down Expand Up @@ -155,11 +156,13 @@ peers:

## Getting started

There are three methods for using `cql-proxy`:
There are four methods for using `cql-proxy`:

- Locally build and run `cql-proxy`
- Run a docker image that has `cql-proxy` installed
- Locally install on your Mac with Homebrew
- Use a Kubernetes container to run `cql-proxy`

### Locally build and run

1. Build `cql-proxy`.
Expand Down Expand Up @@ -216,6 +219,13 @@ There are three methods for using `cql-proxy`:
```
If you wish to have the docker image removed after you are done with it, add `--rm` before the image name `datastax/cql-proxy:v0.1.3`.

### Homebrew on a Mac

Install with one simple command:
```bash
brew install cql-proxy
```

### Use Kubernetes

Using Kubernetes with `cql-proxy` requires a number of steps:
Expand All @@ -236,26 +246,26 @@ Using Kubernetes with `cql-proxy` requires a number of steps:
volumeMounts:
- name: my-cm-vol
mountPath: /tmp/


- Volume: Modify the `configMap` filename as required. In this example, it is named `cql-proxy-configmap`. Use the same name for the `volumes` that you used for the `volumeMounts`.

- Volume: Modify the `configMap` filename as required. In this example, it is named `cql-proxy-configmap`. Use the same name for the `volumes` that you used for the `volumeMounts`.

volumes:
- name: my-cm-vol
configMap:
name: cql-proxy-configmap

3. Create a configmap. Use the same secure bundle that was specified in the `cql-proxy.yaml`.

```sh
kubectl create configmap cql-proxy-configmap --from-file /tmp/scb.zip
kubectl create configmap cql-proxy-configmap --from-file /tmp/scb.zip
```

4. Check the configmap that was created.
4. Check the configmap that was created.

```sh
kubectl describe configmap cql-proxy-configmap

Name: cql-proxy-configmap
Namespace: default
Labels: <none>
Expand All @@ -279,6 +289,7 @@ Using Kubernetes with `cql-proxy` requires a number of steps:
```sh
kubectl logs <deployment-name>
```

## Known issues

### Token-aware load balancing
Expand Down