Add remote driver documentation

jedevc · jedevc · commit 97e79d125395 · 2022-04-25T18:08:18.000+01:00
diff --git a/README.md b/README.md
@@ -184,14 +184,18 @@ are not yet available for regular `docker build` like building manifest lists,
 distributed caching, and exporting build results to OCI image tarballs.
 
 Buildx is supposed to be flexible and can be run in different configurations
-that are exposed through a driver concept. Currently, we support a
-[`docker` driver](docs/reference/buildx_create.md#docker-driver) that uses
-the BuildKit library bundled into the Docker daemon binary, a
-[`docker-container` driver](docs/reference/buildx_create.md#docker-container-driver)
-that automatically launches BuildKit inside a Docker container and a
-[`kubernetes` driver](docs/reference/buildx_create.md#kubernetes-driver) to
-spin up pods with defined BuildKit container image to build your images. We
-plan to add more drivers in the future.
+that are exposed through a driver concept. Currently, we support:
+
+- a [`docker` driver](docs/reference/buildx_create.md#docker-driver) that uses
+  the BuildKit library bundled into the Docker daemon binary,
+- a [`docker-container` driver](docs/reference/buildx_create.md#docker-container-driver)
+  that automatically launches BuildKit inside a Docker container,
+- a [`kubernetes` driver](docs/reference/buildx_create.md#kubernetes-driver) to
+  spin up pods with defined BuildKit container image to build your images.
+- a [`remote` driver](docs/reference/buildx_create.md#remote-driver) to
+  connect to manually provisioned and managed buildkitd instances.
+  
+We plan to add more drivers in the future.
 
 The user experience of using buildx is very similar across drivers, but there
 are some features that are not currently supported by the `docker` driver,
diff --git a/docs/reference/buildx_create.md b/docs/reference/buildx_create.md
@@ -15,7 +15,7 @@ Create a new builder instance
 | `--bootstrap` |  |  | Boot builder after creation |
 | [`--buildkitd-flags`](#buildkitd-flags) | `string` |  | Flags for buildkitd daemon |
 | [`--config`](#config) | `string` |  | BuildKit config file |
-| [`--driver`](#driver) | `string` |  | Driver to use (available: `docker`, `docker-container`, `kubernetes`) |
+| [`--driver`](#driver) | `string` |  | Driver to use (available: `docker`, `docker-container`, `kubernetes`, `remote`) |
 | [`--driver-opt`](#driver-opt) | `stringArray` |  | Options for the driver |
 | [`--leave`](#leave) |  |  | Remove a node from builder instead of changing it |
 | [`--name`](#name) | `string` |  | Builder instance name |
@@ -118,6 +118,16 @@ Unlike `docker` driver, built images will not automatically appear in
 `docker images` and [`build --load`](buildx_build.md#load) needs to be used
 to achieve that.
 
+#### `remote` driver
+
+Uses a remote instance of buildkitd over an arbitrary connection. With this
+driver, you manually create and manage instances of buildkit yourself, and
+configure buildx to point at it.
+
+Unlike `docker` driver, built images will not automatically appear in
+`docker images` and [`build --load`](buildx_build.md#load) needs to be used
+to achieve that.
+
 ### <a name="driver-opt"></a> Set additional driver-specific options (--driver-opt)
 
 ```
@@ -145,6 +155,11 @@ Passes additional driver-specific options. Details for each driver:
   - `loadbalance=(sticky|random)` - Load-balancing strategy. If set to "sticky", the pod is chosen using the hash of the context path. Defaults to "sticky"
   - `qemu.install=(true|false)` - Install QEMU emulation for multi platforms support.
   - `qemu.image=IMAGE` - Sets the QEMU emulation image. Defaults to `tonistiigi/binfmt:latest`
+- `remote`
+  - `key=KEY` - Sets the TLS client key.
+  - `cert=CERT` - Sets the TLS client certificate to present to buildkitd.
+  - `cacert=CACERT` - Sets the TLS certificate authority used for validation.
+  - `servername=SERVER` - Sets the TLS server name to be used in requests (defaults to the endpoint hostname).
 
 Note: When using quoted values for example for the `nodeselector` or `tolerations` options, ensure that quotes are escaped 
 correctly for your shell.
