Skip to content

Latest commit

 

History

History

buildbuddy-enterprise

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
charts
charts
 
 
dashboards
dashboards
 
 
templates
templates
 
 
.helmignore
.helmignore
 
 
Chart.yaml
Chart.yaml
 
 
README.md
README.md
 
 
requirements.lock
requirements.lock
 
 
requirements.yaml
requirements.yaml
 
 
values.yaml
values.yaml
 
 

README.md

BuildBuddy Enterprise

BuildBuddy Enterprise is an open source Bazel build event viewer, result store, remote cache, and remote build execution platform.

TL;DR

helm repo add buildbuddy https://helm.buildbuddy.io
helm install buildbuddy buildbuddy/buildbuddy-enterprise \
  --set mysql.mysqlUser=sampleUser \
  --set mysql.mysqlPassword=samplePassword

Introduction

This chart creates a BuildBuddy Enterprise deployment on a Kubernetes cluster using the Helm package manager.

Prerequisites

  • Kubernetes 1.19+ with Beta APIs enabled
  • Helm v2/v3
  • Tiller (the Helm v2 server-side component) installed on the cluster

Installing the Chart

To install the chart with the release name my-release:

$ helm install my-release buildbuddy/buildbuddy-enterprise

Helm v2 command

$ helm install --name my-release buildbuddy/buildbuddy-enterprise

The command deploys BuildBuddy on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

Uninstalling the Chart

To uninstall/delete the my-release deployment:

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Updating your release

If you change configuration, you can update your deployment:

$ helm upgrade my-release -f my-values.yaml buildbuddy/buildbuddy-enterprise

Writing deployment to a file

You can write your Kubernetes deployment configuration to a file with release name my-release:

$ helm template my-release buildbuddy/buildbuddy-enterprise > buildbuddy-deploy.yaml

You can then check this configuration in to your source repository, or manually apply it to your cluster with:

$ kubectl apply -f buildbuddy-deploy.yaml

Configuration

The following table lists the configurable parameters of the BuildBuddy Open Source chart and their default values.

Parameter Description Default
config The config.yaml configuration to be used by the BuildBuddy server. The values you provide will by using Helm's merging behavior override individual default values only. See the example configurations and the BuildBuddy documentation for details. See config in values.yaml
image.repository Container image repository gcr.io/flame-public/buildbuddy-app-enterprise
image.tag Container image tag enterprise-v2.67.0
image.imagePullPolicy Container image pull policy IfNotPresent
disk.data.enabled Whether to enable a persistent volume disk mounted at /data true
disk.data.size The size of the persistent volume disk 10Gi
service.type The type of service we're exposing LoadBalancer
service.externalHTTPPort The port on which to expose our http load balancer 80
service.externalGRPCPort The port on which to expose our grpc load balancer 1985
service.externalHTTPSPort The port on which to expose our https load balancer 443
service.externalGRPCSPort The port on which to expose our grpcs load balancer 1986
service.internalHTTPPort The port on our docker image that serves http traffic 8080
service.internalGRPCPort The port on our docker image that serves grpc traffic 1985
service.internalHTTPSPort The port on our docker image that serves https traffic 8081
service.internalGRPCSPort The port on our docker image that serves grpcs traffic 1986
service.internalMetricsPort The port on our docker image that serves prometheus metrics 9090
service.annotations Service annotations []
service.loadBalancerIP A user-specified IP address for service type LoadBalancer to use as External IP (if supported) nil
service.loadBalancerSourceRanges list of IP CIDRs allowed access to load balancer (if supported) []
ingress.enabled If true, an ingress is created false
ingress.sslEnabled If true, ssl is enabled for the ingress (certmanager should also be enabled for automatic cert configuration) false
ingress.httpHost The hostname that will handle http traffic [buildbuddy.example.com]
ingress.grpcHost The hostname that will handle grpc traffic [buildbuddy-grpc.example.com]
ingress.controller.enabled If true, an ingress controller is created. If undefined (default), ingress.enabled is used instead to decide this. undefined (defaults to ingress.enabled)
certmanager.enabled If true, an cert-manager will be installed (kubectl apply --validate=false -f https://github.com/jetstack/cert-manager/releases/download/v0.16.1/cert-manager.crds.yaml) must be run before deploying to create necessary CRDs false
certmanager.emailAddress The email address to use for letsencrypt cert registration your-email@gmail.com
mysql.enabled Enables deployment of a mysql server false
mysql.mysqlRootPassword Root Password for Mysql (Optional) ""
mysql.mysqlUser Username for Mysql (Required) ""
mysql.mysqlPassword User Password for Mysql (Required) ""
mysql.mysqlDatabase Database name (Required) "buildbuddy"
redis.enabled Enables deployment of a redis as a caching layer for smaller artifacts false
extraPodAnnotations Extra pod annotations to be used in the deployments []
extraPodLabels Extra pod labels to be used in the deployments []
extraPodSpec Extra pod spec to be used in the deployments []
extraEnvVars Extra environments variables to be used in the deployments []
extraInitContainers Additional init containers []
initContainerImage.repository Init container image repository appropriate/curl
initContainerImage.tag Init container image tag latest
initContainerImage.imagePullPolicy Container image pull policy IfNotPresent
executor.enabled Enables deployment of BuildBuddy executors. Any buildbuddy-executor chart configuration options can be passed into the executor block. false

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install my-release \
  --set image.tag=enterprise-v2.67.0 \
  --set mysql.mysqlUser=sampleUser \
  --set mysql.mysqlPassword=samplePassword \
  buildbuddy/buildbuddy-enterprise

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

$ helm install my-release -f values.yaml buildbuddy/buildbuddy-enterprise

Example configurations

Below are some examples of .yaml files with values that could be passed to the helm command with the -f or --values flag to get started.

Example MySQL configuration

mysql:
  enabled: true
  mysqlUser: "sampleUser"
  mysqlPassword: "samplePassword"

Example external database configuration

mysql:
  enabled: false

config:
  database:
    ## mysql:     "mysql://<USERNAME>:<PASSWORD>@tcp(<HOST>:3306)/<DATABASE_NAME>"
    ## sqlite:    "sqlite3:///tmp/buildbuddy-enterprise.db"
    data_source: "" # Either set this or mysql.enabled, not both!

Example ingress and certs configuration

Note: make sure to run kubectl apply --validate=false -f https://github.com/jetstack/cert-manager/releases/download/v0.16.1/cert-manager.crds.yaml to install CRDs before deploying this configuration.

ingress:
  enabled: true
  sslEnabled: true
  httpHost: buildbuddy.example.com
  grpcHost: buildbuddy-grpc.example.com

mysql:
  enabled: true
  mysqlUser: "sampleUser"
  mysqlPassword: "samplePassword"

certmanager:
  enabled: true
  emailAddress: your-email@gmail.com

config:
  app:
    build_buddy_url: "https://buildbuddy.example.com"
    events_api_url: "grpcs://buildbuddy-grpc.example.com"
    cache_api_url: "grpcs://buildbuddy-grpc.example.com"
  ssl:
    enable_ssl: true

Example with auth (required for enterprise features)

Auth can be configured with any provider that supports OpenID Connect (OIDC) including Google GSuite, Okta, Auth0 and others.

ingress:
  enabled: true
  sslEnabled: true
  httpHost: buildbuddy.example.com
  grpcHost: buildbuddy-grpc.example.com

mysql:
  enabled: true
  mysqlUser: "sampleUser"
  mysqlPassword: "samplePassword"

certmanager:
  enabled: true
  emailAddress: your-email@gmail.com

config:
  app:
    build_buddy_url: "https://buildbuddy.example.com"
    events_api_url: "grpcs://buildbuddy-grpc.example.com"
    cache_api_url: "grpcs://buildbuddy-grpc.example.com"
  auth:
    ## To use Google auth, get client_id and client_secret here:
    ## https://console.developers.google.com/apis/credentials
    oauth_providers:
      - issuer_url: "https://accounts.google.com" # OpenID Connect Discovery URL
        client_id: "MY_CLIENT_ID"
        client_secret: "MY_CLIENT_SECRET"
  ssl:
    enable_ssl: true

Example with Remote Build Execution

executor:
  enabled: true
  replicas: 3
  # Size these resources to roughly fill one machine.
  # The below config works well for 8cpu 32gb executors.
  resources:
    requests:
      cpu: "7000m"
      memory: 20Gi
    limits:
      cpu: "7500m"
      memory: 30Gi
redis:
  enabled: true
config:
  remote_execution:
    enable_remote_exec: true

Example with executor autoscaling on custom metrics

executor:
  enabled: true
  autoscaler:
    enabled: true
    minReplicas: 3
    maxReplicas: 100
    averageCPU: 90
    averageMemory: 50
    averageQueueLength: 5
prometheus:
  enabled: true
redis:
  enabled: true
config:
  remote_execution:
    enable_remote_exec: true

Example with Prometheus & Grafana

Make sure you change your Grafana password or configure more advanced auth.

Your Grafana dashboards will be accessible at buildbuddy.example.com/grafana

grafana:
  enabled: true
  adminUser: admin
  adminPassword: mysuperstrongpassword

prometheus:
  enabled: true

ingress:
  enabled: true
  httpHost: buildbuddy.example.com
  grpcHost: buildbuddy-grpc.example.com

certmanager:
  enabled: true
  emailAddress: your-email@gmail.com

config:
  app:
    build_buddy_url: "http://buildbuddy.example.com"
    events_api_url: "grpc://buildbuddy-grpc.example.com"
    cache_api_url: "grpc://buildbuddy-grpc.example.com"

For more information on configuring RBE, see our enterprise RBE configuration docs.

More examples

For more example config: blocks, see our configuration docs.

Local development

For local testing use minikube

Create local cluster using with specified Kubernetes version (e.g. 1.15.6)

$ minikube start --kubernetes-version v1.15.6

Initialize helm

$ helm init

Above command is not required for Helm v3

Get dependencies

$ helm dependency update

Perform local installation

$ helm install . \
    --set image.tag=5.12.4 \
    --set mysql.mysqlUser=sampleUser \
    --set mysql.mysqlPassword=samplePassword

Helm v3 command

$ helm install . \
    --generate-name \
    --set image.tag=5.12.4 \
    --set mysql.mysqlUser=sampleUser \
    --set mysql.mysqlPassword=samplePassword