04b56c7331
This fleshes out the documentation to include information along with examples and detailed use cases for the cache backends. The general format and style follows from the style of the build driver docs. Eventually, these docs will be included on docs.docker.com along with the rest of the build docs. Signed-off-by: Justin Chadwell <me@jedevc.com>
2.4 KiB
Azure Blob Storage cache storage
Warning
The
azblobcache is currently unreleased. You can use it today, by using themoby/buildkit:masterimage in your Buildx driver.
The azblob cache store uploads your resulting build cache to
Azure's blob storage service.
Note
The
azblobcache storage backend requires using a different driver than the defaultdockerdriver - see more information on selecting a driver here. To create a new docker-container driver (which can act as a simple drop-in replacement):docker buildx create --use --driver=docker-container
To import and export your cache using the azblob storage backend we use the
--cache-to and --cache-from flags and point it to our desired blob using
the required account_url and name parameters:
$ docker buildx build --push -t <user>/<image> \
--cache-to type=azblob,account_url=https://myaccount.blob.core.windows.net,name=my_image \
--cache-from type=azblob,account_url=https://myaccount.blob.core.windows.net,name=my_image
Authentication
To authenticate to Azure to read from and write to the cache, the following parameters are required:
secret_access_key: secret access key- specifies the primary or secondary account key for your Azure Blob Storage account. Azure Blob Storage account keys
While these can be manually provided, if left unspecified, then the credentials for Azure will be pulled from the BuildKit server's environment following the environment variables scheme for the Azure Go SDK.
Warning
These environment variables must be specified on the BuildKit server, not the
buildxclient.
Cache options
The azblob cache has lots of parameters to adjust its behavior.
Cache mode
See Registry - Cache mode for more information.
Further reading
For an introduction to caching see Optimizing builds with cache management.
For more information on the azblob cache backend, see the BuildKit README.