Braintrust Terraform Google Module

This module is used to create the VPC, Databases, Redis, Storage, IAM, and associated resources for the self-hosted Braintrust data plane on Google using Google Kubernetes Engine.

Module Configuration

Module input variables are defined in variables.tf and outputs are defined in outputs.tf.

How to use this module

To use this module, copy the examples/braintrust-data-plane directory to a new Terraform directory in your own repository. Follow the instructions in the README.md file in that directory to configure the module for your environment.

Please review the README.md in the examples for all Pre-deployment and Post-Deployment steps in order to deploy Braintrust on Google.

The default configuration is a large production-sized deployment. Please consider that when testing and adjust the configuration to use smaller sized resources.

Development Setup

This section is only relevant if you are a contributor who wants to make changes to this module. All others can skip this section.

1. Clone the repository

2. Install mise:

   curl https://mise.run | sh
   echo 'eval "$(mise activate zsh)"' >> "~/.zshrc"
   echo 'eval "$(mise activate zsh --shims)"' >> ~/.zprofile
   exec $SHELL

3. Run mise install to install required tools

4. Run mise run setup to install pre-commit hooks

TODO

• This module will fail the first time it is deployed due to timing issue with the private connection for the VPC. Exploring ways to fix this still without adding a module depends on which causes issues.
• Explore customer support module like AWS module
• Explore using Terraform to enable google services instead of CLI/GUI