@@ -24,6 +24,7 @@ commodity hardware and AWS servers. Outgoing bandwidth can exceed 15 Gbit/s on t
2424## HTTP/1.1 REST API
2525
2626Cache entries are set and retrieved by key, and there are two types of keys that can be used:
27+
27281 . Content addressed storage (CAS), where the key is the lowercase SHA256 hash of the entry.
2829 The REST API for these entries is: ` /cas/<key> ` or with an optional but ignored instance name:
2930 ` /<instance>/cas/<key> ` .
@@ -60,6 +61,7 @@ for GET requests and `Content-type: application/json` for PUT requests.
6061** /status**
6162
6263Returns the cache status/info.
64+
6365```
6466$ curl http://localhost:8080/status
6567{
@@ -78,6 +80,7 @@ $ curl http://localhost:8080/status
7880
7981The empty CAS blob is always available, even if the cache is empty. This can be used to test that
8082a bazel-remote instance is running and accepting requests.
83+
8184```
8285$ curl --head --fail http://localhost:8080/cas/e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
8386HTTP/1.1 200 OK
@@ -487,7 +490,6 @@ max_size: 100
487490# use unix:///path/to/socket.sock, where /path/to/socket.sock can be
488491# either an absolute or relative path to a socket path.
489492http_address : 0.0.0.0:8080
490-
491493# The server listener address for gRPC (unix sockets are also supported
492494# as described above):
493495# grpc_address: 0.0.0.0:9092
@@ -633,7 +635,7 @@ http_address: 0.0.0.0:8080
633635# auth_method: environment_credential
634636#
635637# auth_method: default
636-
638+
637639# If set to a valid port number, then serve /debug/pprof/* URLs here:
638640# profile_port: 7070
639641# IP address to use, if profiling is enabled:
@@ -689,16 +691,16 @@ See [examples/docker-compose.yml](examples/docker-compose.yml) for an example co
689691
690692### Kubernetes notes
691693
692- * See [ examples/kubernetes.yml] ( examples/kubernetes.yml ) for an example
694+ - See [ examples/kubernetes.yml] ( examples/kubernetes.yml ) for an example
693695 configuration.
694696
695- * Don't name your deployment ` bazel-remote ` !
696-
697+ - Don't name your deployment ` bazel-remote ` !
698+
697699 Kubernetes sets some environment variables based on this name, which conflict
698700 with the ` BAZEL_REMOTE_* ` environment variables that bazel-remote tries to
699701 parse.
700702
701- * bazel-remote supports the ` /grpc.health.v1.Health/Check ` service, which you can
703+ - bazel-remote supports the ` /grpc.health.v1.Health/Check ` service, which you can
702704 configure like so:
703705 ```
704706 alb.ingress.kubernetes.io/backend-protocol: HTTP
@@ -715,9 +717,9 @@ See [examples/docker-compose.yml](examples/docker-compose.yml) for an example co
715717The command below will build a docker image from source and install it into your local docker registry.
716718
717719``` bash
718- $ bazel run :bazel-remote-image-tarball
720+ $ bazel run :bazel-remote-image-amd64- tarball
719721# Ensure /your/path/to/data exists and is writable (e.g. by UID 65532)
720- $ docker run -v /your/path/to/data:/data buchgr/ bazel-remote-cache:tmp-amd64 --max_size 5 --dir /data
722+ $ docker run -v /your/path/to/data:/data bazel-remote-cache:tmp-amd64 --max_size 5 --dir /data
721723```
722724
723725### ARM64 docker image
@@ -729,7 +731,7 @@ To build a docker image for ARM64:
729731``` bash
730732$ bazel run :bazel-remote-image-arm64-tarball
731733# Ensure /your/path/to/data exists and is writable (e.g. by UID 65532)
732- $ docker run -v /your/path/to/data:/data buchgr/ bazel-remote-cache:tmp-arm64 --max_size 5 --dir /data
734+ $ docker run -v /your/path/to/data:/data bazel-remote-cache:tmp-arm64 --max_size 5 --dir /data
733735```
734736
735737## Build a standalone Linux binary
@@ -852,6 +854,7 @@ To avoid leaking your password in log files, you can place this flag in a
852854
853855To use mutual TLS with bazel, use a ` grpcs ` URL for the ` --remote_cache `
854856argument, and add the following flags:
857+
855858``` bash
856859 --tls_certificate=path/to/ca.cert
857860 --tls_client_certificate=path/to/client/cert.cert
0 commit comments