From 06c11ecb618f9256abd2bdb2c58902af522a1eb6 Mon Sep 17 00:00:00 2001 From: Justin Chadwell Date: Fri, 29 Jul 2022 14:50:55 +0100 Subject: [PATCH] docs: add minimal docker driver docs Mostly for completeness, this patch adds basic documentation for the docker driver. Signed-off-by: Justin Chadwell --- docs/guides/drivers/docker.md | 50 +++++++++++++++++++++++++++++++++++ docs/guides/drivers/index.md | 2 +- 2 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 docs/guides/drivers/docker.md diff --git a/docs/guides/drivers/docker.md b/docs/guides/drivers/docker.md new file mode 100644 index 00000000..4a23755b --- /dev/null +++ b/docs/guides/drivers/docker.md @@ -0,0 +1,50 @@ +# Docker driver + +The buildx docker driver is the default builtin driver, that uses the BuildKit +server components built directly into the docker engine. + +No setup should be required for the docker driver - it should already be +configured for you: + +```console +$ docker buildx ls +NAME/NODE DRIVER/ENDPOINT STATUS BUILDKIT PLATFORMS +default docker + default default running 20.10.17 linux/amd64, linux/386 +``` + +This builder is ready to build with out-of-the-box, requiring no extra setup, +so you can get going with a `docker buildx build` as soon as you like. + +Depending on your personal setup, you may find multiple builders in your list +the use the docker driver. For example, on a system that runs both a package +managed version of dockerd, as well as Docker Desktop, you might have the +following: + +```console +NAME/NODE DRIVER/ENDPOINT STATUS BUILDKIT PLATFORMS +default docker + default default running 20.10.17 linux/amd64, linux/386 +desktop-linux * docker + desktop-linux desktop-linux running 20.10.17 linux/amd64, linux/arm64, linux/riscv64, linux/ppc64le, linux/s390x, linux/386, linux/arm/v7, linux/arm/v6 +``` + +This is because the docker driver builders are automatically pulled from +the available [Docker Contexts](https://docs.docker.com/engine/context/working-with-contexts/). +When you add new contexts using `docker context create`, these will appear in +your list of buildx builders. + +Unlike the [other drivers](../index.md), builders using the docker driver +cannot be manually created, and can only be automatically created from the +docker context. Additionally, they cannot be configured to a specific BuildKit +version, and cannot take any extra parameters, as these are both preset by the +Docker engine internally. + +If you want the extra configuration and flexibility without too much more +overhead, then see the help page for the [docker-container driver](./docker-container.md). + +## Further reading + +For more information on the docker driver, see the [buildx reference](https://docs.docker.com/engine/reference/commandline/buildx_create/#driver). + + diff --git a/docs/guides/drivers/index.md b/docs/guides/drivers/index.md index 898b6946..66ae38d7 100644 --- a/docs/guides/drivers/index.md +++ b/docs/guides/drivers/index.md @@ -8,7 +8,7 @@ Currently, we support the following drivers: - The `docker` driver, that uses the BuildKit library bundled into the Docker daemon. - ([reference](https://docs.docker.com/engine/reference/commandline/buildx_create/#driver)) + ([guide](./docker.md), [reference](https://docs.docker.com/engine/reference/commandline/buildx_create/#driver)) - The `docker-container` driver, that launches a dedicated BuildKit container using Docker, for access to advanced features. ([guide](./docker-container.md), [reference](https://docs.docker.com/engine/reference/commandline/buildx_create/#driver))