Update examples for Brainstore (#26)

Example code updated with relevant brainstore configs and docs

Author: mdeeks

assets/Brainstore-License-Key.png

@@ -1,17 +1,35 @@
-A standard Braintrust data plane deployment. Copy this directory to a new directory in your own repository and modify the files to match your environment.
+This is an example of a standard Braintrust data plane deployment. Copy this directory to a new directory in your own repository and modify the files to match your environment.
 
+## Configure Terraform
 * `provider.tf` should be modified to use your AWS account and region.
 * `terraform.tf` should be modified to use the remote backend that your company uses. Typically this is an S3 bucket and DynamoDB table.
 * `main.tf` should be modified to meet your needs for the Braintrust deployment. The defaults are sensible only for a small development deployment.
+* Brainstore requires a license key which you can find in the Braintrust UI under Settings > API
+![Brainstore License Key](../../assets/Brainstore-License-Key.png)
+* It isn't recommended that you commit this license key to your git repo. You can safely pass this key into terraform multiple ways:
+  * Set `TF_VAR_brainstore_license_key=your-key` in your terraform environment
+  * Pass it into terraform as a flag `terraform apply -var 'brainstore_license_key=your-key'`
+  * Add it to an uncommitted `terraform.tfvars` or `.auto.tfvars` file.
 
-After applying this configuration, you will have a Braintrust data plane deployed in your AWS account. You can then run `terraform output` to get the API URL you need to enter into the Braintrust UI for your Organization.
+## Pointing your Organization to your data plane
 
-If you are testing, it is HIGHLY recommended that you create a new Braintrust Organization for testing purposes. If you change your live Organization's API URL, you might break users who are currently using it.
+After applying this configuration you will have a Braintrust data plane deployed in your AWS account. You can then run `terraform output` to get the API URL you need to enter into the Braintrust UI for your Organization.
+```
+❯ terraform output
+api_url = "https://dx6ntff6gocr6.cloudfront.net"
+```
 
 To configure your Organization to use your new data plane, click your user icon on the top right > Settings > API URL.
 
+> [!WARNING]
+> If you are testing, it is HIGHLY recommended that you create a new Braintrust Organization for testing purposes. If you change your live Organization's API URL, you might break users who are currently using it.
+
 ![Setting the API URL in Braintrust](/assets/Braintrust-API-URL.png)
 
 Paste the API URL into the text field and click Save. Click to copy the test ping command and run it in your terminal to verify that your data plane is working.
 
 ![Verifying the API URL in Braintrust](/assets/Braintrust-API-URL-2.png)
+
+Copy the Brainstore license key.
+
+

examples/braintrust-data-plane/README.md

@@ -1,4 +1,4 @@
-# tflint-ignore-file: terraform_module_version
+# tflint-ignore-file: terraform_module_pinned_source
 
 locals {
   # This is primarily used for tagging and naming resources in your AWS account.
@@ -7,18 +7,12 @@ locals {
 }
 
 module "braintrust-data-plane" {
-  source = "braintrustdata/data-plane/braintrust"
-  # Uncomment the version line to lock to a specific version of the module.
-  # version = "1.1.0"
+  source = "github.com/braintrustdata/terraform-braintrust-data-plane"
+  # Append '?ref=<version_tag>' to lock to a specific version of the module.
 
   deployment_name     = local.deployment_name
   braintrust_org_name = "" # Add your organization name from the Braintrust UI here
 
-  ## Additional optional parameters:
-
-  # The number API Handler instances to provision and keep alive. This reduces cold start times and improves latency, with some increase in cost.
-  # api_handler_provisioned_concurrency   = 0
-
   ### Postgres configuration
   # The default is small for development and testing purposes. Recommended db.r8g.2xlarge for production.
   # postgres_instance_type                = "db.t4g.xlarge"
@@ -40,6 +34,21 @@ module "braintrust-data-plane" {
   # PostgreSQL engine version for the RDS instance.
   # postgres_version                      = "15.7"
 
+  ### Brainstore configuration
+  # Enable Brainstore for faster analytics
+  enable_brainstore = false
+
+  # The license key for the Brainstore instance. You can get this from the Braintrust UI in Settings > API URL.
+  brainstore_license_key = var.brainstore_license_key
+
+  # The instance type to use for the Brainstore. Must be a Graviton instance type. Preferably with 16GB of memory and a local SSD for cache data.
+  # The default value is for tiny deployments. Recommended for production deployments is c7gd.8xlarge.
+  # brainstore_instance_type             = "c7gd.xlarge"
+
+  # The number of Brainstore instances to provision
+  # brainstore_instance_count            = 1
+
+
   ### Redis configuration
   # Default is acceptable for small production deployments. Recommended cache.m7g.large for larger deployments.
   # redis_instance_type                   = "cache.t4g.small"
@@ -56,6 +65,9 @@ module "braintrust-data-plane" {
   # quarantine_vpc_cidr                   = "10.176.0.0/16"
 
   ### Advanced configuration
+  # The number API Handler instances to provision and keep alive. This reduces cold start times and improves latency, with some increase in cost.
+  # api_handler_provisioned_concurrency   = 0
+
   # List of origins to whitelist for CORS
   # whitelisted_origins                   = []
 
@@ -77,4 +89,5 @@ module "braintrust-data-plane" {
 
   # Enable the Quarantine VPC to run user defined functions in an isolated environment. If disabled, user defined functions will not be available.
   # enable_quarantine_vpc                = true
+
 }

examples/braintrust-data-plane/main.tf

@@ -3,12 +3,13 @@
 #   backend "s3" {
 #     # Example: "us-east-1"
 #     region         = "<your AWS region>"
-#     # Example: "terraform-state-lock"
-#     dynamodb_table = "<your-dynamodb-table-name>"
+
 #     # Example: "yourcompany-terraform-state"
 #     bucket         = "<s3-bucket-name>"
+#     use_lockfile = true
 #     # The path in S3 to store the state of this terraform directory.
-#     key = "braintrust"
+#     # Change this for each environment you deploy to.
+#     key = "braintrust.tfstate"
 #   }
 # }
 

examples/braintrust-data-plane/terraform.tf

@@ -0,0 +1,9 @@
+variable "brainstore_license_key" {
+  description = "The license key for the Brainstore instance. You can get this from the Braintrust UI in Settings > API URL."
+  type        = string
+  validation {
+    condition     = var.brainstore_license_key != null && var.brainstore_license_key != ""
+    error_message = "The brainstore_license_key must be set."
+  }
+}
+

examples/braintrust-data-plane/variables.tf

@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.9.0"
+  required_version = ">= 1.10.0"
   required_providers {
     aws = {
       source  = "hashicorp/aws"

examples/braintrust-data-plane/versions.tf

@@ -1,6 +1,6 @@
 output "api_url" {
   description = "The primary endpoint for the dataplane API. This is the value that should be entered into the braintrust dashboard under API URL."
-  value       = aws_cloudfront_distribution.dataplane.domain_name
+  value       = "https://${aws_cloudfront_distribution.dataplane.domain_name}"
 }
 
 output "ai_proxy_url" {