Bufstream Terraform Modules

Note

Using the Terraform Modules in this repository requires a Bufstream key. If you don't have one, contact us to start a trial.

This repository compliments Bufstream's documentation.

Within, you'll find a collection of modules that assist with deploying a Kubernetes cluster in either Amazon Web Services (AWS) or Google Cloud Platform (GCP). These modules generate necessary resources and then deploy Bufstream. The cluster created is meant to be used as a demo environment for those who would like to test Bufstream but don't have an existing Kubernetes cluster.

The repo includes a convenience wrapper, install.sh, that requires you to set some environment variables. To run it, you need to create a tfvars file that includes the required Terraform variables and any desired overrides. See below for the required variables. There is a README for each module with more details on the variables that can be set.

Required environment variables:

Variable	Description
BUFSTREAM_KEYFILE	Path to file containing Bufstream base64 encoded key from Buf
BUFSTREAM_VERSION	The version of Bufstream to deploy
BUFSTREAM_CLOUD	Which cloud to deploy to. Must be aws or gcp
BUFSTREAM_TFVARS	Path to the tfvars file

Example of running the install script:

BUFSTREAM_KEYFILE=$PWD/keyfile \
BUFSTREAM_VERSION=0.3.10 \
BUFSTREAM_CLOUD=gcp \
BUFSTREAM_TFVARS=$PWD/bufstream.tfvars \
install.sh

Because the script doesn't auto-apply the Terraform, you can review the Terraform plan before the resources are deployed. As part of the deployment, the script generates a kubeconfig file in the gen/ directory. Use it to inspect the deployment or for troubleshooting.

# Assuming the namespace Bufstream was deployed to is "bufstream"
kubectl --kubeconfig gen/kubeconfig get pods -n bufstream

AWS

By default, the module creates all resources necessary to deploy an auto mode Kubernetes cluster to the desired account. It also creates some specific resources required for Bufstream: an S3 bucket and a role that the Bufstream service account can assume to access the bucket using EKS Pod Identity.

Required variables in tfvars:

Variable	Description
region	Which region to deploy resources in
vpc_name	Name of the VPC to create (or use)
bucket_name	Name of s3 bucket, must be globally unique
profile	AWS profile to use for Terraform

Recommended variables in tfvars:

Variable	Description
eks_cluster_name	Name for the EKS cluster
eks_cluster_version	Version of the EKS cluster

GCP

By default, the module creates all resources necessary to deploy a Kubernetes cluster to the desired project. It also creates some specific resources required for Bufstream: a storage bucket and a role that the service account can assume to access the bucket.

Required variables in tfvars:

Variable	Description
project_id	ID of the project to deploy to
region	Which region to deploy resources to
bucket_name	Name of the bucket to use, must be globally unique

Recommended variables in tfvars:

Variable	Description
cluster_name	Name for the GKE cluster