Amazon Keyspaces (for Apache Cassandra) developer toolkit

This repository provides common tooling for Amazon Keyspaces for functional testing, light operations, and data migration. The tooling is packaged as a Docker image or python package to simplify setup and configuration. The toolkit is optimized for Amazon Keyspaces, but will also work with Apache Cassandra clusters.

Amazon Keyspaces (for Apache Cassandra)

Amazon Keyspaces is a scalable, highly available, and managed Apache Cassandra–compatible database service. Amazon Keyspaces is serverless, so you pay for only the resources you use and the service can automatically scale tables up and down in response to application traffic.

What's included

This container extends from awscli container and includes the following Cassandra components:

3.11.6 Apache Cassandra distribution of CQLSH
cqlsh expansion that integrates sigv4 authentication
Amazon Web Services pem file for SSL connectivity
CQLSHRC file with best practices
Helpers/examples to perform to common task
AWS CLI. Official Documentation See How to use the AWSCLI Container

Architecture

CQLSHRC file is located at root directory of this project
Toolkit scripts located in /bin directory of this project
Keyspaces PEM file is downloaded when creating the image
Apache Cassandra 3.11 branch CQLSH scripts
Extends from AWS CLI Container Image and can be accessed via overriding the entrypoint parameter

TLDR;

The following steps to connect to Amazon Keyspaces using the Toolkit.

Docker

Clone the github repoistory, Build Docker Image, Connect to Keyspaces, and Go!

docker build --tag amazon/amazon-keyspaces-toolkit --build-arg CLI_VERSION=latest https://github.com/aws-samples/amazon-keyspaces-toolkit.git

docker run --rm -ti amazon/amazon-keyspaces-toolkit cassandra.us-east-1.amazonaws.com 9142 -u "SERVICEUSERNAME" -p "SERVICEPASSWORD" --ssl

Python

pip install --user cqlsh-expansion

cqlsh-expansion.init

cqlsh cassandra.us-east-1.amazonaws.com 9142 --ssl -u mike-user-99 -p user-pass-01

Using Sigv4 Authentication with cqlsh

The toolkit contains a version of cqlsh that extends Authentication functionality to leverage the Sigv4 athentication plugin for the Python Cassandra driver. This plugin enables IAM users, roles, and federated identities to add authentication information to Amazon Keyspaces (for Apache Cassandra) API requests using the AWS Signature Version 4 Process (SigV4). You can leverage this functionality by passing the --auth-provider "SigV4AuthProvider" flag to the cqlsh-expansion process. You can use the docker container host's credentials by mounting the AWS CLI configuration directory to the container using the mount command -v. If your AWS configuration is stored in ~/.aws then the Docker mount command would be -v ~/.aws:/root/.aws.

Docker

docker build --tag amazon/amazon-keyspaces-toolkit --build-arg CLI_VERSION=latest https://github.com/aws-samples/amazon-keyspaces-toolkit.git

docker run -ti --rm -v ~/.aws:/root/.aws amazon/amazon-keyspaces-toolkit cassandra.us-east-1.amazonaws.com --ssl --auth-provider "SigV4AuthProvider"

Python

pip install --user cqlsh-expansion

cqlsh-expansion.init

cqlsh-expansion cassandra.us-east-1.amazonaws.com 9142 --ssl --auth-provider "SigV4AuthProvider"

Prerequisites

Generate Service Specific Credentials

If you are using the Service-specific credentials for IAM users to access Amazon Keyspaces. See official documentation for IAM user Generated service-specific credentials for Amazon Keyspaces

Setup Docker

Containers add a level of platform independence allowing for installation on various operating systems including Linux, Mac, and Windows. Find your operating system below, and follow the installation process. After installing, you will have access to the docker terminal from the command line terminal.

Windows: Visit Windows Download and Tutorial
Mac: Visit Mac Download and Tutorial
Linux: Visit Linux Download and Tutorial

Run

The following section will provide examples of CQLSH usage with Apache Cassandra and Amazon Keyspaces.

Clone this repo

The following command will clone this repository and pull down submodules

  git clone https://github.com/aws-samples/amazon-keyspaces-toolkit

Use an alias

In this section we will assign the previous command to an alias. In simplifying the setup introduced additional commands for Docker. To reduce the extra Docker commands we can leverage an alias (or DOSKEY for windows) to replace a bulk for the command. The alias acts as a shortcut replacing the text of the Docker command with an alias keyword.

We do not recommend you store the user name and password in the alias. Later in this document we will show you how to leverage AWS Secrets Manager. to avoid using plain text credentials with CQLSH.

Parameters for alias

-v "$(pwd)" :/source mount the current directory of the host. Useful for importing and exporting data with COPY or using the CQLSH --file command to load external CQLSH scripts -v "${HOME}/.cassandra/cqlsh_history" Maintain cqlsh history across sessions

#!/bin/bash

alias cqlsh='touch ${HOME}/.cassandra/cqlsh_history && docker run --rm -ti -v "$(pwd)":/source -v "${HOME}/.cassandra/cqlsh_history":/root/.cassandra/cqlsh_history amazon/amazon-keyspaces-toolkit'

You can now connect to Amazon Keyspaces using CQLSH alias and pass in the host port and user name and password.

cqlsh cassandra.us-east-1.amazonaws.com 9142 --ssl \
-u "SERVICEUSERNAME" -p "SERVICEPASSWORD" --ssl

Executing statements

We can also use this container to execute commands using the --execute parameter. For a list of CQLSH commands see the following resource: List of CQLSH commands. This will allow you to embed this functionality in existing scripts.

cqlsh cassandra.us-east-1.amazonaws.com 9142 --ssl \
-u "SERVICEUSERNAME" -p "SERVICEPASSWORD" --ssl \
--execute "CREATE KEYSPACE \"amazon\" WITH REPLICATION = {'class': 'SingleRegionStrategy'}"

Executing files

We can also use this container to execute commands using the --file parameter. Since we mounted the current directory with the alias statement we can now utilize scripts on the host machine.

cqlsh cassandra.us-east-1.amazonaws.com 9142 \
-u "SERVICEUSERNAME" -p "SERVICEPASSWORD" --ssl \
--file "/source/my_script.cql"

Connecting to Apache Cassandra

To connect to Apache Cassandra override the default CQLSHRC file.

Change the endpoint to the local cassandra clusters

cqlsh localhost 9042 -u "cassandra" -p "cassandra"

or using the mount established previous example to load a different CQLSHRC file with the --cqlshrc paramter

cqlsh --cqlshrc '/source/.local-cassandra/cqlshrc'

Toolkit

In this section we will describe usage for the helpers found in the /bin directory. Each example can be used by changing the entrypoint to the container.

AWS CLI

The keyspaces-toolkit extends the AWS CLI Docker image making the keyspaces- toolkit extremely light-weight. Since you may already have the AWS CLI Docker image in your local repository, the keyspaces-toolkit adds only an additional 10mb layer extension of the AWS CLI.

Changing the entry point to aws will allow you to access the AWS CLI. Mounting the .aws directory of the host machine will allow you to leverage the credentials stored on the host machine.

docker run --rm -ti \
-v ~/.aws:/root/.aws \
--entrypoint aws \
amazon/amazon-keyspaces-toolkit
configure list-profiles

AWS Secrets Manager Wrapper

When using Generated service-specific credentials it is common practice to store the username and password in AWS Secrets Manager. This allows you to use the AWS CLI to retrieve the credentials and not expose the credentials in plain text. The following script will use the AWS CLI config profile to grab stored service credentials from AWS Secrets Manager.

Store Generated User Credentials in Amazon Secrets Manager

AWS Secrets Manager helps you protect secrets needed to access your applications, services, and IT resources. The service enables you to easily rotate, manage, and retrieve database credentials, API keys, and other secrets throughout their lifecycle. Replace SERVICEUSERNAME and SERVICEPASSWORD with the generated values. The --name parameter signifies the key used to access credentials in later examples keyspaces-credentials

aws secretsmanager create-secret --name keyspaces-credentials \
--description "Store Amazon Keyspaces Generated Service Credentials" \
--secret-string "{\"username\":\"SERVICEUSERNAME\", \"password\":\"SERVICEPASSWORD\"}"

Execute Secrets Manager Wrapper Entrypoint

The container provides a script aws-sm-cqlsh.sh which will call out to the secrets manager and append the user and password to your CQLSH statement. It requires AWS CLI to be installed and configured on host or setup within container. The -v parameter is used in the example below to locate the awscli configuration on the host instance.

Parameters

--rm - removes the container after ending the CQLSH session
-ti - interactive bash shell in the container
-v - mount a volume from existing directory
- ~/.aws:/root/.aws in the example is the location of the host awscli configuration on localhost:container
--entrypoint - choses a wrapper script for CQLSH with the username and password extracted from AWS Secrets Manager.

aws-sm-cqlsh.sh Parameters

First parameter will be the AWS Secrets Manager key we created in the Prerequisites step. Every parameter following the secrets key will be passed into CQLSH command

Example: open cqlsh shell

docker run --rm -ti \
-v ~/.aws:/root/.aws \
--entrypoint aws-sm-cqlsh.sh \
 amazon/amazon-keyspaces-toolkit keyspaces-credentials \
 cassandra.us-east-1.amazonaws.com 9142 --ssl

Example: execute statement

docker run --rm -ti \
-v ~/.aws:/root/.aws \
--entrypoint aws-sm-cqlsh.sh  \
 amazon/amazon-keyspaces-toolkit keyspaces-credentials \
 cassandra.us-east-1.amazonaws.com 9142 --ssl \
 --execute "CREATE TABLE aws.workshop(
	id text,
	time timeuuid,
	event blob,
	PRIMARY KEY(id, time))
  WITH CUSTOM_PROPERTIES = {'capacity_mode':{'throughput_mode':'PAY_PER_REQUEST'}}"

Exponential Backoff Wrapper

Keyspace and table creation are Asynchronous in Amazon Keyspaces. This asynchronous functionality is different than Apache Cassandra where table creation is synchronous. We have been told by customers that some existing scripts require synchronous behavior when creating a table. A common solution is to add an exponential backoff describe statement to notify users when the table is created. This container contains an exponential backoff helper that will attempt multiple times until the CQL statement succeeds.

Parameters

$1 maximum time for program to run in seconds
$2 maximum number of attempts to run
$3 CQL Statement to run

#!/bin/bash

#create a table
docker run -ti --name createtablec amazon/amazon-keyspaces-toolkit \
cassandra.us-east-1.amazonaws.com 9142 \
-u "SERVICEUSERNAME" -p "SERVICEPASSWORD" --ssl \
--execute "CREATE TABLE aws.workshop_backofftest(
 id text,
 time timeuuid,
 event blob,
 PRIMARY KEY(id, time))
 WITH CUSTOM_PROPERTIES = {'capacity_mode':{'throughput_mode':'PAY_PER_REQUEST'}}"

# Check the error code of container.
# Make sure to drop the --rm statement from the previous run command.
docker inspect createtablec --format='{{.State.ExitCode}}'

#ok to remove
docker rm createtablec

#exponential backoff describe
#run for 30 seconds or 120 attempts which ever comes first
docker run --rm -ti --entrypoint aws-cqlsh-expo-backoff.sh amazon/amazon-keyspaces-toolkit \
 30 120 \
 cassandra.us-east-1.amazonaws.com 9142 \
 --ssl -u "SERVICEUSERNAME" -p "SERVICEPASSWORD" \
 --execute "DESCRIBE TABLE aws.workshop_backofftest"

Cheatsheet

--- Docker ---
#Logs
$> docker logs CONTAINERID

#Remove Image
$> docker rmi amazon/amazon-keyspaces-toolkit

#exit code
docker inspect createtablec --format='{{.State.ExitCode}}'


--- CQL ---
#Describe keyspace
DESCRIBE KEYSPACE keyspace_name;

#Select Samples
SELECT * FROM keyspace_name.table_name LIMIT 10;

--- Serverless ---
#Change Provisioned Capacity
ALTER TABLE aws.workshop WITH custom_properties={'capacity_mode':{'throughput_mode': 'PROVISIONED', 'read_capacity_units': 4000, 'write_capacity_units': 3000}} ;

#Describe current capacity mode
SELECT keyspace_name, table_name, custom_properties FROM system_schema_mcs.tables where keyspace_name = 'aws_cassandra_ws';

--- Linux ---
#Line count of multiple/all files in the current directory
find . -type f | wc -l

#Remove header from csv
sed -i '1d' myData.csv

Popular Keyspaces Repositories

Monitoring

This repository provides CloudFormation templates to quickly set up CloudWatch Metrics for Amazon Keyspaces. Using this template will allow you to get started more easily by providing deployable prebuilt CloudWatch dashboards with commonly observed metrics. https://github.com/aws-samples/amazon-keyspaces-cloudwatch-cloudformation-templates

Java Driver Helpers

This repository contains driver policies, examples, and best practices when using the DataStax Java Driver with Amazon Keyspaces (for Apache Cassandra) https://github.com/aws-samples/amazon-keyspaces-java-driver-helpers

Security

See CONTRIBUTING for more information.

License

This library is licensed under the MIT-0 License. See the LICENSE file.

Name		Name	Last commit message	Last commit date
Latest commit History 147 Commits
.github/ISSUE_TEMPLATE		.github/ISSUE_TEMPLATE
aws-cloudshell		aws-cloudshell
bin		bin
content/static		content/static
cqlsh-expansion		cqlsh-expansion
docker		docker
.dockerignore		.dockerignore
.gitattributes		.gitattributes
.gitignore		.gitignore
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
THIRD-PARTY-LICENSES.txt		THIRD-PARTY-LICENSES.txt

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Amazon Keyspaces (for Apache Cassandra) developer toolkit