From c13d86fac0daf00d41b1d4c6c310b1f6d2585439 Mon Sep 17 00:00:00 2001 From: Aaron Ploetz Date: Mon, 15 Aug 2022 08:25:05 -0500 Subject: [PATCH 1/5] adding Homebrew install instructions. --- README.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 05f8ee8..728008b 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,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 @@ -155,11 +155,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`. @@ -216,6 +218,12 @@ 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: @@ -236,26 +244,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: @@ -279,6 +287,7 @@ Using Kubernetes with `cql-proxy` requires a number of steps: ```sh kubectl logs ``` + ## Known issues ### Token-aware load balancing From 9e7cd0e92e386e03803efc0f5d76a7136e8b07d2 Mon Sep 17 00:00:00 2001 From: Aaron Ploetz Date: Mon, 15 Aug 2022 08:27:16 -0500 Subject: [PATCH 2/5] adding Homebrew install instructions. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 728008b..40a5616 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ - [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) + - [Homebrew on a Mac](https://github.com/datastax/cql-proxy#homebrew-on-a-mac) - [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) @@ -219,6 +220,7 @@ There are four 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 From 89c0f1f1ce18d8add4ba4bd2c5e09a62b4840e21 Mon Sep 17 00:00:00 2001 From: Aaron Ploetz Date: Mon, 15 Aug 2022 08:30:50 -0500 Subject: [PATCH 3/5] adding relative URLs to table of contents. --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 40a5616..c27053a 100644 --- a/README.md +++ b/README.md @@ -4,16 +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) - - [Homebrew on a Mac](https://github.com/datastax/cql-proxy#homebrew-on-a-mac) - - [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 the cql-proxy?](#what-is-cqlproxy) +- [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`? From c29afc462bedb8ef50f810545e6233e8513e3f22 Mon Sep 17 00:00:00 2001 From: Aaron Ploetz Date: Mon, 15 Aug 2022 08:32:08 -0500 Subject: [PATCH 4/5] adding relative URLs to table of contents. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c27053a..b710bfa 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ## Table of Contents -- [What is the cql-proxy?](#what-is-cqlproxy) +- [What is cql-proxy?](#what-is-cqlproxy) - [When to use cql-proxy](#when-to-use-cql-proxy) - [Configuration](#configuration) - [Getting started](#getting-started) @@ -16,7 +16,7 @@ - [Token-aware load balancing](#token-aware-load-balancing) -## What is `cql-proxy`? +## What is cql-proxy? ![cql-proxy](cql-proxy.png) From e856c3f78718abb68c37905817ddff688f53b676 Mon Sep 17 00:00:00 2001 From: Aaron Ploetz Date: Mon, 15 Aug 2022 08:33:14 -0500 Subject: [PATCH 5/5] adding relative URLs to table of contents. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b710bfa..054e6b5 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ## Table of Contents -- [What is cql-proxy?](#what-is-cqlproxy) +- [What is cql-proxy?](#what-is-cql-proxy) - [When to use cql-proxy](#when-to-use-cql-proxy) - [Configuration](#configuration) - [Getting started](#getting-started) @@ -16,7 +16,7 @@ - [Token-aware load balancing](#token-aware-load-balancing) -## What is cql-proxy? +## What is `cql-proxy`? ![cql-proxy](cql-proxy.png)