summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorNicolas Lacasse <nlacasse@google.com>2019-04-05 15:47:36 -0700
committerShentubot <shentubot@google.com>2019-04-05 15:48:32 -0700
commitf44f2f73b068658ddf632586e2178e372fcd1cbd (patch)
tree14ab34a7d7c64cc779dd0732fde171cff6ab026e /README.md
parent252f877f3d0ccc3f1aeb7de0e13d71fb3d4e7284 (diff)
Make it easier for humans to use RBE, and maintain our bazelrc.
This CL merges all RBE-specific configuration from .bazelrc_rbe into .bazelrc so that it will be picked up by default by users running bazel. It also checks in a bazelrc from the upstream bazel-toolchains repository, and imports that into our repo-specific .bazelrc. This makes it easier to maintain and update the bazelrc going forward. Documentation was added to the README. PiperOrigin-RevId: 242208733 Change-Id: Iea32de9be85b024bd74f88909b56b2a8ab34851a
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5e7d4e3f9..e960614ff 100644
--- a/README.md
+++ b/README.md
@@ -314,6 +314,28 @@ Run your container again, and inspect the files under `/tmp/runsc`. The log file
with name `boot` will contain the strace logs from your application, which can
be useful for identifying missing or broken system calls in gVisor.
+### Building/testing with Remote Execution
+
+If you have a [Remote Build Execution][rbe] environment, you can use it to speed
+up gVisor build and test cycles.
+
+You must authenticate with the project first:
+
+```
+gcloud auth application-default login --no-launch-browser
+```
+
+Then invoke bazel with the following flags:
+
+```
+--config=remote
+--project_id=$PROJECT
+--remote_instance_name=projects/$PROJECT/instances/default_instance
+```
+
+You can also add those flags to your local ~/.bazelrc to avoid needing to
+specify them each time on the command line.
+
### Enabling network passthrough
For high-performance networking applications, you may choose to disable the user
@@ -455,6 +477,7 @@ See [Contributing.md](CONTRIBUTING.md).
[netstack]: https://github.com/google/netstack
[oci]: https://www.opencontainers.org
[python]: https://python.org
+[rbe]: https://blog.bazel.build/2018/10/05/remote-build-execution.html
[runsc-nightly-sha]: https://storage.googleapis.com/gvisor/releases/nightly/latest/runsc.sha512
[runsc-nightly]: https://storage.googleapis.com/gvisor/releases/nightly/latest/runsc
[sandbox]: https://en.wikipedia.org/wiki/Sandbox_(computer_security)