Merge pull request #36 from devzero-inc/staging

Staging
devzero-inc · Jun 21, 2024 · 473875a · 473875a
2 parents 99454cc + 99c4a2f
commit 473875a
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 4 deletions.
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -45,13 +45,14 @@
 * [Hosting](admin/hosting.md)
 * [Single-Sign On (SSO)](admin/sso.md)
 
-## 📝 How-to Guides
+## 📚 How-to Guides
 
 * [Connecting to AWS](how-to-guides/connecting-to-aws.md)
 * [Connect to an RDS Instance](product-guides/how-tos/connect-to-an-rds-instance.md)
 * [Connect to an S3 Bucket](product-guides/how-tos/connect-to-an-s3-bucket.md)
 * [Run GitHub Actions in a DevBox](how-to-guides/run-github-actions-in-a-devbox.md)
 * [Docker Remote Build & Cache](how-to-guides/docker-remote-build-cache.md)
+* [Bazel remote execution/cache](how-to-guides/bazel-remote-execution-cache.md)
 
 ## 🛠️ Troubleshooting
 
@@ -62,7 +63,7 @@
 * [Visual Studio Code](troubleshooting/vs-code.md)
 * [JetBrains](troubleshooting/jetbrains.md)
 
-## 📚 References
+## 🔎 References
 
 * [Terminology](references/terminology.md)
 * [CLI Reference](references/cli-man-page/README.md)

diff --git a/how-to-guides/bazel-remote-execution-cache.md b/how-to-guides/bazel-remote-execution-cache.md
@@ -0,0 +1,36 @@
+# Bazel remote execution/cache
+
+### Installation (using Helm)
+
+Make sure both kubectl and helm are installed.
+
+When creating a new workspace, take a look at the [Kubectl](../references/starter-templates/infra/kubectl.md) recipe and the [Helm](../references/starter-templates/infra/helm.md) recipe.
+
+Install bazel buildfarm on your k8s cluster using the official helm chart:
+
+```
+helm install \
+  -n bazel-buildfarm \
+  --create-namespace \
+  bazel-buildfarm \
+  oci://ghcr.io/bazelbuild/buildfarm \
+  --version "0.2.4"
+```
+
+Forward the k8s port to your DevBox:
+
+```
+kubectl port-forward service/bazel-buildfarm-server -n bazel-buildfarm 8980:8980 --address 0.0.0.0
+```
+
+### Remote execution
+
+```
+bazel build --remote_executor=grpc://<your-devbox>:8980 :main
+```
+
+### Remote caching
+
+```
+bazel build --remote_cache=grpc://<your-devbox>:8980 :main
+```
diff --git a/how-to-guides/run-github-actions-in-a-devbox.md b/how-to-guides/run-github-actions-in-a-devbox.md
@@ -82,7 +82,7 @@ To create one:
 3. In the "scopes" section, select `repo` and optionally `admin:org` for organization runners.
 4. Copy your new Personal Access Token.
 
-Create a new recipe that resembles the following:
+Create a new recipe installing kubectl, helm and GitHub ARC:
 
 {% hint style="info" %}
 Make sure to adjust the `INSTALLATION_NAME`, `NAMESPACE`, `GITHUB_CONFIG_URL`, and `GITHUB_PAT` variables as needed.

diff --git a/references/recipe-syntax.md b/references/recipe-syntax.md
@@ -201,7 +201,7 @@ You can provide environment variables to a single command only. The syntax for t
     - type: command
       command: make
       directory: project
-      env:
+      environment:
         - name: CXX
           value: ccache
 ```