README.md

Using Temporal (temporal.io) on Astra

• Create an Astra DB at https://astra.datastax.com/

• Add two keyspaces in the Astra DB UI via "Add Keyspace": temporal and temporal_visibility Note: If you have existing temporal and temporal_visibility keyspaces you may need to remove and recreate them.

• Create a new Astra token and get your DB's identifier

  • DB identifer is the last ID in the URL when your DB is selected (the "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" part)
    • https://astra.datastax.com/org/.../database/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  • Or the "Datacenter ID" without the -1 at the end (you'll have to copy and remove that trailing -1)

• Clone this repo

git clone https://github.com/mpenick/temporal-astra-cql-proxy.git
cd temporal-astra-cql-proxy

• Update .env with your Astra token and DB identifier

# Update these
ASTRA_TOKEN=updateme
ASTRA_DATABASE_ID=updateme

Make sure you are running a modern version of docker-compose (v2.3.3+ recommended)

• Update the Temporal schema by running ./schema.sh OR run these commands:

docker-compose -f docker-compose-schema.yaml run temporal-admin-tools \
  -ep cql-proxy -k temporal setup-schema -v 0.0
docker-compose -f docker-compose-schema.yaml run temporal-admin-tools \
  -ep cql-proxy -k temporal update-schema -d schema/cassandra/temporal/versioned/

docker-compose -f docker-compose-schema.yaml run temporal-admin-tools \
  -ep cql-proxy -k temporal_visibility setup-schema -v 0.0
docker-compose -f docker-compose-schema.yaml run temporal-admin-tools \
  -ep cql-proxy -k temporal_visibility update-schema -d schema/cassandra/visibility/versioned/

• Start up Temporal!

docker-compose up

Note: The current version of the Temporal schema has issues because the clustering order does contain the full clustering key. The Temporal Cassandra schema has been copied to this repo and modified to work with Astra. This change should be pushed upstream because the schema is technically underspecified.

diff --git a/schema/cassandra/visibility/versioned/v1.0/schema.cql b/schema/cassandra/visibility/versioned/v1.0/schema.cql
index 5fcad40cc..de8b4fe2e 100644
--- a/schema/cassandra/visibility/versioned/v1.0/schema.cql
+++ b/schema/cassandra/visibility/versioned/v1.0/schema.cql
@@ -10,7 +10,7 @@ CREATE TABLE open_executions (
   encoding             text,
   task_queue            text,
   PRIMARY KEY  ((namespace_id, namespace_partition), start_time, run_id)
-) WITH CLUSTERING ORDER BY (start_time DESC)
+) WITH CLUSTERING ORDER BY (start_time DESC, run_id DESC)
   AND COMPACTION = {
     'class': 'org.apache.cassandra.db.compaction.LeveledCompactionStrategy',
     'tombstone_threshold': 0.4
@@ -37,7 +37,7 @@ CREATE TABLE closed_executions (
   encoding             text,
   task_queue            text,
   PRIMARY KEY  ((namespace_id, namespace_partition), close_time, run_id)
-) WITH CLUSTERING ORDER BY (close_time DESC)
+) WITH CLUSTERING ORDER BY (close_time DESC, run_id DESC)
   AND COMPACTION = {
     'class': 'org.apache.cassandra.db.compaction.LeveledCompactionStrategy'
   }