Skip to content

Commit e3c4829

Browse files
committed
docs(boil): Add remote cache section to README
1 parent bba099d commit e3c4829

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

rust/boil/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,28 @@ boil image list
3131
# Display a list of versions of the image located in the 'airflow' folder
3232
boil image list airflow
3333
```
34+
35+
## Advanced Building Options
36+
37+
### Use Remote Cache
38+
39+
> [!NOTE]
40+
> The default builder (with the `docker` driver) doesn't support the registry cache storage backend. You must create
41+
> a new builder using the `docker-container` driver and either set this new builder as the default or pass
42+
> `-- --builder <NAME>` to use it:
43+
>
44+
> ```shell
45+
> docker builder create --name container --driver=docker-container
46+
> boil build airflow --cache-registry oci.example.org -- --builder container
47+
> ```
48+
49+
boil offers to option to automatically pull from and push to a remote cache. This feature can be
50+
enabled by using the `--cache-registry` (and the optional `--cache-namespace`) argument:
51+
52+
```shell
53+
# This will use `oci.example.org/<NAMESPACE>-cache/airflow` to store and retrieve cached layers
54+
boil build airflow --cache-registry oci.example.org
55+
56+
# This will use `oci.example.org/foo/airflow` to store and retrieve cached layers
57+
boil build airflow --cache-registry oci.example.org --cache-namespace foo
58+
```

0 commit comments

Comments
 (0)