a96c7a7f2c
<!--Delete sections as needed -->
## Description
This PR updates the Docker Build Cloud CI documentation to clarify the
use of builder and credential variables.
**Key changes:**
- Standardizes the use of `DOCKER_ACCOUNT`, `DOCKER_ACCESS_TOKEN`, and
`CLOUD_BUILDER_NAME` in all CI/CD examples.
- Updates template string syntax for builder endpoints (e.g., `${{
vars.DOCKER_ACCOUNT }}/${{ vars.CLOUD_BUILDER_NAME }}` in GitHub
Actions).
- Adds explicit call outs that the cloud builder has to be created
first.
- Improves instructions for naming and referencing cloud builders in
both the dashboard and CLI steps.
- Ensures all code comments and documentation are consistent and clear
for users setting up Docker Build Cloud in CI.
These changes make it easier for users to configure their CI/CD
pipelines correctly and reduce confusion around builder and credential
setup.
## Related issues or tickets
https://docker.atlassian.net/browse/DCL-248
## Reviews
<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->
- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
---------
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
3.0 KiB
title, linkTitle, weight, description, keywords, aliases
| title | linkTitle | weight | description | keywords | aliases | |
|---|---|---|---|---|---|---|
| Docker Build Cloud setup | Setup | 10 | How to get started with Docker Build Cloud | build, cloud build |
|
Before you can start using Docker Build Cloud, you must add the builder to your local environment.
Prerequisites
To get started with Docker Build Cloud, you need to:
- Download and install Docker Desktop version 4.26.0 or later.
- Create a cloud builder on the Docker Build Cloud Dashboard.
- When you create the builder, choose a name for it (for example,
default). You will use this name asBUILDER_NAMEin the CLI steps below.
- When you create the builder, choose a name for it (for example,
Use Docker Build Cloud without Docker Desktop
To use Docker Build Cloud without Docker Desktop, you must download and install
a version of Buildx with support for Docker Build Cloud (the cloud driver).
You can find compatible Buildx binaries on the releases page of
this repository.
If you plan on building with Docker Build Cloud using the docker compose build command, you also need a version of Docker Compose that supports Docker
Build Cloud. You can find compatible Docker Compose binaries on the releases
page of this repository.
Steps
You can add a cloud builder using the CLI, with the docker buildx create
command, or using the Docker Desktop settings GUI.
{{< tabs >}} {{< tab name="CLI" >}}
-
Sign in to your Docker account.
$ docker login -
Add the cloud builder endpoint.
$ docker buildx create --driver cloud <ORG>/<BUILDER_NAME>Replace
<ORG>with the Docker Hub namespace of your Docker organization (or your username if you are using a personal account), and<BUILDER_NAME>with the name you chose when creating the builder in the dashboard.This creates a local instance of the cloud builder named
cloud-ORG-BUILDER_NAME.Note
If your organization is
acmeand you named your builderdefault, use:$ docker buildx create --driver cloud acme/default
{{< /tab >}} {{< tab name="Docker Desktop" >}}
-
Sign in to your Docker account using the Sign in button in Docker Desktop.
-
Open the Docker Desktop settings and navigate to the Builders tab.
-
Under Available builders, select Connect to builder.
{{< /tab >}} {{< /tabs >}}
The builder has native support for the linux/amd64 and linux/arm64
architectures. This gives you a high-performance build cluster for building
multi-platform images natively.
Firewall configuration
To use Docker Build Cloud behind a firewall, ensure that your firewall allows traffic to the following addresses:
What's next
- See Building with Docker Build Cloud for examples on how to use Docker Build Cloud.
- See Use Docker Build Cloud in CI for examples on how to use Docker Build Cloud with CI systems.