Skip to content

Latest commit

 

History

History
77 lines (52 loc) · 3.6 KB

SETUP.md

File metadata and controls

77 lines (52 loc) · 3.6 KB
Raw

Installing and Configuring BuildBuddy

Setting up BuildBuddy to view your own logs is easy! Your two options are:

We support both!

Cloud BuildBuddy

Cloud BuildBuddy is run as a service in multiple datacenters around the world.

To upload your own logs, you just need to configure bazel to point to a BuildBuddy instance. The easiest way to do this is with a .bazelrc file in the root of your project.

You can view a sample .bazelrc here. For basic, unauthenticated uploads, create a .bazelrc file in your project root (or edit the existing one) and add the following lines:

build --bes_results_url=https://app.buildbuddy.io/invocation/
build --bes_backend=grpcs://events.buildbuddy.io:1986

Now, when you build or test with bazel, it will print a url where you can view your build or test results. For example:

tylerw@lunchbox:~/buildbuddy-io/buildbuddy$ bazel build server:all
INFO: Streaming build results to: https://app.buildbuddy.io/invocation/24a37b8f-4cf2-4909-9522-3cc91d2ebfc4
INFO: Analyzed 13 targets (0 packages loaded, 0 targets configured).
INFO: Found 13 targets...
INFO: Elapsed time: 0.212s, Critical Path: 0.01s
INFO: 0 processes.
INFO: Streaming build results to: https://app.buildbuddy.io/invocation/24a37b8f-4cf2-4909-9522-3cc91d2ebfc4
INFO: Build completed successfully, 1 total action
tylerw@lunchbox:~/buildbuddy-io/buildbuddy$

On Premise

We've designed BuildBuddy to be easy to run on-premise for those use cases where data absolutely must not leave a company's servers. The software itself is open-source and easy to audit.

We can also help you run BuildBuddy in your own custom environment. Reach out if you want help getting set up!

Bazel Run

The simplest method of running BuildBuddy on your own computer is to download and run it with "bazel run". Doing that is simple:

  • Get the source

    git clone "https://github.com/buildbuddy-io/buildbuddy"

  • Build and run using bazel

    cd buildbuddy && bazel run -c opt server:buildbuddy

We recommend using a tool like Bazelisk that respects the repo's .bazelversion file.

Docker Image

We publish a Docker image with every release that contains a pre-configured BuildBuddy. To run it:

docker pull gcr.io/flame-public/buildbuddy-app-onprem:latest && docker run -p 1985:1985 -p 8080:8080 gcr.io/flame-public/buildbuddy-app-onprem:latest

If you'd like to pass a custom configuration file to BuildBuddy running in a Docker image - see the config docs on using Docker's -v flag.

Kubernetes

If you run or have access to a Kubernetes cluster, and you have the "kubectl" command configured, we provide a shell script that will deploy BuildBuddy to your cluster, namespaced under the "buildbuddy" namespace. This script uses this deployment file, if you want to see the details of what is being configured.

bash k8s_on_prem.sh

Configuring BuildBuddy

For documentation on all BuildBuddy configuration options, check out CONFIG.md.