Skip to main content
The Storage section configures where and how BuildBuddy will store blob data.
This section is required for BuildBuddy to function.

​
Configuration Options

One of the following storage backend sections is required.

​
Disk Storage

​
disk
object
The Disk section configures disk-based blob storage.
​
disk.root_directory
string
required
The root directory to store all blobs in, if using disk based storage. This directory must be readable and writable by the BuildBuddy process. The directory will be created if it does not exist.

​
Google Cloud Storage (GCS)

​
gcs
object
The GCS section configures Google Cloud Storage based blob storage.
​
gcs.bucket
string
required
The name of the GCS bucket to store files in. Will be created if it does not already exist.
​
gcs.credentials_file
string
required
A path to a JSON credentials file that will be used to authenticate to GCS.
​
gcs.project_id
string
required
The Google Cloud project ID of the project owning the above credentials and GCS bucket.

​
AWS S3

​
aws_s3
object
The AWS section configures AWS S3 storage.
​
aws_s3.region
string
required
The AWS region
​
aws_s3.bucket
string
required
The AWS S3 bucket (will be created automatically)
​
aws_s3.credentials_profile
string
If a profile other than default is chosen, use that one.
By default, the S3 blobstore will rely on environment variables, shared credentials, or IAM roles. See AWS Go SDK docs for more information.

​
Azure Storage

​
azure
object
The Azure section configures Azure Storage.
​
azure.account_name
string
required
The name of the Azure storage account
​
azure.account_key
string
required
The key for the Azure storage account
​
azure.container_name
string
required
The name of the Azure storage container.

​
Optional Settings

​
chunk_file_size_bytes
integer
How many bytes to buffer in memory before flushing a chunk of build protocol data to disk.

​
Example Configurations

storage:
  ttl_seconds: 86400 # One day in seconds.
  chunk_file_size_bytes: 3000000 # 3 MB
  disk:
    root_directory: /tmp/buildbuddy

Build docs developers (and LLMs) love

Get started for freeTalk to us