BuildBuddy Enterprise allows configuration of many features that are not available in the open-core version. Below you’ll find examples for configuring some of these features. If you don’t see what you’re looking for below, please don’t hesitate to ask us! For a full overview of what can be configured, see our Configuration docs.
BuildBuddy uses a SQL connection string to specify the database it will connect to. An example string is:
To connect BuildBuddy to your own MySQL server:
- Create a new database on your MySQL server
- Create a new user with full access to that database
- Put the username, password, IP address of your MySQL server, and database name into the BuildBuddy data_source connection string:
If using the BuildBuddy Enterprise Helm charts, MySQL can be configured for you using the
By default, BuildBuddy will cache objects and store uploaded build events on the local disk. If you want to store them in a shared durable location, like a Google Cloud Storage bucket, you can do that by configuring a GCS cache or storage backend.
If your BuildBuddy instance is running on a machine with Google Default Credentials, no credentials file will be necessary. If not, you should create a service account with permissions to write to cloud storage, and download the credentials .json file.
We also recommend providing a Redis instance for improved remote build execution & small file performance. This can be configured automatically using the BuildBuddy Enterprise Helm charts with the
The configuration below configures Redis & GCS storage bucket to act as a storage backend and cache:
If using Amazon S3, you can configure your storage and cache similarly:
BuildBuddy supports OpenID Connect (OIDC) as a way of interacting with an Auth Provider like Google, Okta, or similar to authenticate your users when they log in. Configuring this is easy, below is an example of using BuildBuddy with Okta. Configuring your Auth Provider to support OIDC is outside the scope of this doc, but we’ve done it for Google, Okta, and others, and are happy to lend a helping hand if you’re stuck.
Here’s another example of Google login using credentials obtained from: https://console.developers.google.com/apis/credentials
Your users can authenticate to BuildBuddy using an API key or they can use Certificate based authentication over mTLS. To configure mTLS, you must generate a new server certificate authority and key. You can do this using the
openssl command, for example:
Then, you can use the generated ca.csr and ca.pem files in your BuildBuddy configuration like this:
To enable Remote Build Execution, you'll need to add the following to your config.yaml:
You'll also need to deploy executors to handle remote builds. The recommended way of deploying these is using our Enterprise Helm Chart.
For more information on configuring on-prem RBE, see our enterprise on-prem RBE setup docs.
Here’s what a fully-featured config.yaml looks like which includes all of the features listed above.