Using Terraform to Configure BioT

Terraform is an open-source Infrastructure-as-Code (IaC) tool that enables configuration to be managed through version-controlled code instead of manual updates in the BioT Console. Using Terraform with BioT provides a structured, automated way to define and maintain templates across multiple environments, such as development, staging, and production.

Terraform also allows you to sync any changes made in the BioT Console back into your Terraform state, keeping your configuration up to date and aligned.

Terraform should be used by developers responsible for configuring and maintaining environment templates.

Why Use Terraform with BioT

Terraform supports managing BioT templates as versioned configuration files. This approach introduces several significant benefits:

  • Ensures all environments remain aligned
  • Allows controlled promotion of changes from development to staging and production
  • Reduces manual configuration effort and human error
  • Allows review and approval of changes before applying them

Terraform becomes the single source of truth for BioT’s template configuration.

Working with Multiple Environments

Changes to templates are created and tested first in the development environment. Once validated, the same configuration can be safely applied to staging and production without having to recreate template settings manually.

Manual editing in the BioT Console should be limited to development only, and only when experimenting or testing behavior.

If a change is made in the Console during testing, it must be synchronized back into Terraform so the code remains accurate and environments do not drift.

Staging and production environments must be managed exclusively through Terraform.

Reference Implementation & Documentation

To support the use of Terraform with BioT, we provide a fully working sample project that you can use as a starting point for your own infrastructure management:

BioT Terraform Sample Project

Here is a link to the BioT Terraform sample project.

This repository includes everything required to set up and manage BioT templates through Terraform, including:

  • Folder structure and modules for multiple environments (dev, staging, prod)
  • Scripts for importing existing templates and generating Terraform resources
  • Example configuration files and environment variables
  • Automated synchronization between BioT and Terraform

Inside the project, you will find a detailed README that explains:

  • Required tools and installation instructions
  • How to initialize the project with your BioT environment
  • How to create and update templates using Terraform workflows
  • How to promote changes between environments safely
  • Best practices to ensure alignment with the BioT Console

Please follow the README carefully for all technical setup and operational procedures.

Best Practices

To maintain stable and aligned environments:

  • Manage template configuration primarily through Terraform
  • Allow console updates only in development for testing and sync them back into code
  • Use separate credentials per environment and keep them secured
  • Store only Terraform configuration in version control (secrets must be excluded)

Adopting these practices ensures predictable deployments and maintainable configuration throughout your BioT solution lifecycle.