config.json.commented: document bind mounts
Change-Id: I970b4f0bf0d69314540fe4f93126c9cac1c12484
Reviewed-on: https://go-review.googlesource.com/c/pkgsite-metrics/+/476198
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Zvonimir Pavlinovic <zpavlinovic@google.com>
Run-TryBot: Jonathan Amsterdam <jba@google.com>
diff --git a/config.json.commented b/config.json.commented
index 5dc0da1..cb210de 100644
--- a/config.json.commented
+++ b/config.json.commented
@@ -91,9 +91,16 @@
"ro"
]
},
+ # Bind mounts. These let us map directories inside the sandbox
+ # (the destination) to directories outside (the source).
+ # If the source doesn't exist, you'll get the (obscure) error
+ # "cannot read client sync file".
+ # If the destination already exists, that's not an error, but the
+ # files in that directory will be hidden to code running inside the
+ # sandbox.
{
# Mount /tmp/binaries inside the sandbox to
- # the same directory outside.
+ # the same directory outside.
"destination": "/tmp/binaries",
"type": "none",
"source": "/tmp/binaries",
@@ -101,7 +108,7 @@
},
{
# Mount /tmp/modules inside the sandbox to
- # the same directory outside.
+ # the same directory outside.
"destination": "/tmp/modules",
"type": "none",
"source": "/tmp/modules",
