Skip to main content
The cache section enables the BuildBuddy cache and configures how and where it will store data.
This section is optional.

​
Configuration Options

​
Common Options

​
max_size_bytes
integer
How big to allow the cache to be (in bytes).
​
in_memory
boolean
Whether or not to use the in_memory cache.
​
zstd_transcoding_enabled
boolean
Whether or not to enable cache compression capabilities. You need to use --experimental_remote_cache_compression to activate it on your build.

​
Disk Cache

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

​
Enterprise-Only Options

​
redis_target
string
A redis target for improved RBE performance.
Enterprise only
​
gcs
object
The GCS section configures Google Cloud Storage based blob storage.
Enterprise only
​
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.
​
gcs.ttl_days
integer
The period after which cache files should be TTLd. Disabled if 0.
​
s3
object
The AWS section configures AWS S3 storage.
Enterprise only
​
s3.region
string
required
The AWS region
​
s3.bucket
string
required
The AWS S3 bucket (will be created automatically)
​
s3.credentials_profile
string
If a profile other than default is chosen, use that one.
​
s3.ttl_days
integer
The period after which cache files should be TTLd. Disabled if 0.
By default, the S3 blobstore will rely on environment variables, shared credentials, or IAM roles. See AWS Go SDK docs for more information.

​
Example Configurations

cache:
  max_size_bytes: 10000000000 # 10 GB
  disk:
    root_directory: /tmp/buildbuddy-cache

Build docs developers (and LLMs) love

Get started for freeTalk to us