terraform-provider-docker/docs/resources/buildx_builder.md

---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "docker_buildx_builder Resource - terraform-provider-docker"
subcategory: ""
description: |-
  Manages a Docker Buildx builder instance. This resource allows you to create a  buildx builder with various configurations such as driver, nodes, and platform settings. Please see https://github.com/docker/buildx/blob/master/docs/reference/buildx_create.md for more documentation
---

# docker_buildx_builder (Resource)

Manages a Docker Buildx builder instance. This resource allows you to create a  buildx builder with various configurations such as driver, nodes, and platform settings. Please see https://github.com/docker/buildx/blob/master/docs/reference/buildx_create.md for more documentation



<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- `append` (Boolean) Append a node to builder instead of changing it
- `bootstrap` (Boolean) Automatically boot the builder after creation. Defaults to `false`
- `buildkit_config` (String) BuildKit daemon config file
- `buildkit_flags` (String) BuildKit flags to set for the builder.
- `docker_container` (Block List, Max: 1) Configuration block for the Docker-Container driver. (see [below for nested schema](#nestedblock--docker_container))
- `driver` (String) The driver to use for the Buildx builder (e.g., docker-container, kubernetes).
- `driver_options` (Map of String) Additional options for the Buildx driver in the form of `key=value,...`. These options are driver-specific.
- `kubernetes` (Block List, Max: 1) Configuration block for the Kubernetes driver. (see [below for nested schema](#nestedblock--kubernetes))
- `name` (String) The name of the Buildx builder. IF not specified, a random name will be generated.
- `node` (String) Create/modify node with given name
- `platform` (List of String) Fixed platforms for current node
- `remote` (Block List, Max: 1) Configuration block for the Remote driver. (see [below for nested schema](#nestedblock--remote))
- `use` (Boolean) Set the current builder instance as the default for the current context.

### Read-Only

- `id` (String) The ID of this resource.

<a id="nestedblock--docker_container"></a>
### Nested Schema for `docker_container`

Optional:

- `cgroup_parent` (String) Sets the cgroup parent of the container if Docker is using the "cgroupfs" driver.
- `cpu_period` (String) Sets the CPU CFS scheduler period for the container.
- `cpu_quota` (String) Imposes a CPU CFS quota on the container.
- `cpu_shares` (String) Configures CPU shares (relative weight) of the container.
- `cpuset_cpus` (String) Limits the set of CPU cores the container can use.
- `cpuset_mems` (String) Limits the set of CPU memory nodes the container can use.
- `default_load` (Boolean) Automatically load images to the Docker Engine image store. Defaults to `false`
- `env` (Map of String) Sets environment variables in the container.
- `image` (String) Sets the BuildKit image to use for the container.
- `memory` (String) Sets the amount of memory the container can use.
- `memory_swap` (String) Sets the memory swap limit for the container.
- `network` (String) Sets the network mode for the container.
- `restart_policy` (String) Sets the container's restart policy.


<a id="nestedblock--kubernetes"></a>
### Nested Schema for `kubernetes`

Optional:

- `annotations` (String) Sets additional annotations on the deployments and pods.
- `default_load` (Boolean) Automatically load images to the Docker Engine image store. Defaults to `false`
- `image` (String) Sets the image to use for running BuildKit.
- `labels` (String) Sets additional labels on the deployments and pods.
- `limits` (Block List, Max: 1) Resource limits for CPU, memory, and ephemeral storage. (see [below for nested schema](#nestedblock--kubernetes--limits))
- `loadbalance` (String) Load-balancing strategy (sticky or random).
- `namespace` (String) Sets the Kubernetes namespace.
- `nodeselector` (String) Sets the pod's nodeSelector label(s).
- `qemu` (Block List, Max: 1) QEMU emulation configuration. (see [below for nested schema](#nestedblock--kubernetes--qemu))
- `replicas` (Number) Sets the number of Pod replicas to create.
- `requests` (Block List, Max: 1) Resource requests for CPU, memory, and ephemeral storage. (see [below for nested schema](#nestedblock--kubernetes--requests))
- `rootless` (Boolean) Run the container as a non-root user.
- `schedulername` (String) Sets the scheduler responsible for scheduling the pod.
- `serviceaccount` (String) Sets the pod's serviceAccountName.
- `timeout` (String) Set the timeout limit for pod provisioning.
- `tolerations` (String) Configures the pod's taint toleration.

<a id="nestedblock--kubernetes--limits"></a>
### Nested Schema for `kubernetes.limits`

Optional:

- `cpu` (String) CPU limit for the Kubernetes pod.
- `ephemeral_storage` (String) Ephemeral storage limit for the Kubernetes pod.
- `memory` (String) Memory limit for the Kubernetes pod.


<a id="nestedblock--kubernetes--qemu"></a>
### Nested Schema for `kubernetes.qemu`

Optional:

- `image` (String) Sets the QEMU emulation image.
- `install` (Boolean) Install QEMU emulation for multi-platform support.


<a id="nestedblock--kubernetes--requests"></a>
### Nested Schema for `kubernetes.requests`

Optional:

- `cpu` (String) CPU limit for the Kubernetes pod.
- `ephemeral_storage` (String) Ephemeral storage limit for the Kubernetes pod.
- `memory` (String) Memory limit for the Kubernetes pod.



<a id="nestedblock--remote"></a>
### Nested Schema for `remote`

Optional:

- `cacert` (String) Absolute path to the TLS certificate authority used for validation.
- `cert` (String) Absolute path to the TLS client certificate to present to buildkitd.
- `default_load` (Boolean) Automatically load images to the Docker Engine image store. Defaults to `false`
- `key` (String) Sets the TLS client key.
- `servername` (String) TLS server name used in requests.