Import changes for goma server

  - a702111367735f8c0a46225ea9146dc57b3ba713 Should refer env_file_for_docker in WORK_DIR instead of c...
  - 9ee4ac3baa2bfe9a6c51292aa04763b31a6371a9 remoteexec: ExecuteAndWait returns error of resp status.
  - 18366bdf014af5e6e7cb79ed274ac86ad90182f0 remoteexec: don't add . for wrapper on windows
  - 7ee036e7a320085d751425b91f5fafd2949496bb remoteexec: fix retry by ExecuteResponse status
  - bc9eb1ff4b5995e32bedc0626580c1322b21dab2 roll from 0.41.0 to 0.43.0
  - 4bc2b91a156363be0d2404c150fd787d808d375d remoteexec: update request metadata name
  - c670f55ebb2dd5f2cb9ae58b406109f6424a212c User environment should directly goes to where the compil...
  - e839bb6deafc14cc6ddbd2390a9f77923b85ed34 roll from 1.3.1 to 1.3.2
  - c8c02f1a5bd9f80f73dffd1d6599a8288d7daac3 use go 1.12.7
  - 8c85c6baeac7addfda80134578d2ac5304837ab7 Use "pwd -P" instead of pwd to get current working direct...
  - b2d77a97fd319e5bec7e8de559a79fd895bbc018 roll from 1.21.1 to 1.22.0
  - a506584bd95b470c908698c1be2ecb94d2620aa0 roll from 0.40.0 to 0.41.0
  - 96a8f21ee37900a200b3e7021d7b3cdb95e17035 remoteexec: reduce log volume
  - c713279d342b08cffe62fb266c6890c9fd46598b remoteexec: set rpc id
  - 8640543157f9b1cab6be2e9b5970101c248f0329 remoteexec_proxy: add document how to deploy it on appeng...
  - f9dc9f386b2dc522458f68e71af052f88a184f00 nsjail: add dummy HOME directory.
  - 64808c917652706de338b858213626dda987b17c nsjail: make /dev/null available.
  - f0a4ba0be368a4edcbd259193d725b8700418914 nsjail: set up PATH env from ExecReq::ToolchainSpec.
  - f1a01e793953c325c69576f75af614b9bbe03174 roll from 0.6.0 to 0.7.0

GitOrigin-RevId: 509e19eb587f2a5deb66290e1e70b5665b9a50d5
Change-Id: I7c08d57a3bbe51ff6c199228308ff13c0f320a49,
19 files changed
tree: 7bf546e2e59e7b0c16c3ec518942edcd0b0ca592
  1. auth/
  2. backend/
  3. bytestreamio/
  4. cache/
  5. cmd/
  6. command/
  7. exec/
  8. execlog/
  9. file/
  10. frontend/
  11. fswatch/
  12. hash/
  13. httprpc/
  14. infra/
  15. log/
  16. profiler/
  17. proto/
  18. remoteexec/
  19. rpc/
  20. server/
  21. .gitignore
  23. cipd_manifest.txt
  24. cipd_manifest.versions
  26. go.mod
  27. go.sum

Goma server

Goma is a distributed compiler service for open-source project such as Chromium and Android. It's some kind of replacement of distcc+ccache.

This is reference implementation of server code to be used with Goma client.


The Goma server uses a backend service that implements the Remote Execution API to distribute compile requests across a collection of worker machines and to cache the results of compilations. The Remote Execution API is an open-source standard, with multiple service implementations. The Goma server has been tested with Google's Remote Build Execution service, but could use other service implementations with some minor tweaks to the service code.

To learn more about Remote Build Execution, which is currently an alpha service, you can view the whitelisted documentation by joining this group. If you would like to try using Goma with Remote Build Execution, you can follow these instructions. (note: you must join the documentation whitelist group to view the instructions).

How to build

Goma server can be built on Linux.

$ GO111MODULE=on go get

You will get the binary in $(go env GOPATH)/bin.

How to run

remoteexec_proxy is a single server that acts as proxy server between Goma client and Remote Execution API.

$ remoteexec_proxy --port $PORT \
   --platform-container-image "docker://...@sha256:..." \
   --remoteexec-addr $REMOTEEXEC_ADDR \
   --remote-instance-name $REMOTE_INSTANCE_NAME

for chromium, platform container image should be created with

Example Dockerfile

FROM ubuntu:14.04
ENV DEBIAN_FRONTEND noninteractive

ADD /tmp/
RUN base64 -d /tmp/ > /tmp/ \
  && \
  apt-get -y update \
  && \
  apt-get install -f -y build-essential gcc-4.8 g++-4.8 \
  && \
  bash /tmp/ --lib32 --no-prompt \
     --no-chromeos-fonts \
  && \
  rm -rf /var/lib/apt/lists/*

If Remote Execution API requires service account, specify service account JSON file for Remote Execution API by --service-account-json.

Running user is granted by default. If you need to allow other users, you need to specify them by --whitelisted-users.

Log messages will be output to stderr. OpenCensus z-pages ara available at http://localhost:$PORT/debug/

How to use

Install goma client. We provide prebuilt binary with cipd, which is available in depot_tools.

$ cipd install infra/goma/client/linux-amd64 -root ${HOME}/goma

or follow the build instructions to build your own local version of Goma client before running the server code, and install it in $HOME/goma.

Need to authenticate Goma client before use.

$ $HOME/goma/ login

Specify hostname in $GOMA_SERVER_HOST and port in $GOMA_SERVER_PORT, along with a few other environment flags.

$ export GOMA_SERVER_HOST='host-of-remoteexec_proxy-running'
$ export GOMA_SERVER_PORT='port-of-remoteexec_proxy-running'
$ export GOMA_USE_SSL=false

For example, if you are running remoteexec_proxy locally with --port 5050, use:

$ export GOMA_SERVER_HOST=localhost
$ export GOMA_SERVER_PORT=5050

Finally, start Goma client:

$ $HOME/goma/ ensure_start

and in chromium tree.

$ rm -f out/Release/obj/base/base/base64.o
$ GOMA_USE_LOCAL=false autoninja -C out/Release obj/base/base/base64.o