docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

build(hb): add circle ci and shell examples 

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
David Karlsson 2023-08-31 22:04:59 +02:00
parent a821026511
commit c40d191638
1 changed files with 120 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

179
content/build/hydrobuild.md
View File

@ -129,14 +129,7 @@ builds:
`<org>` should be the same as for first builder, but this time `<org>` should be the same as for first builder, but this time
use `linux-arm64` for the platform suffix. use `linux-arm64` for the platform suffix.
## Use Hydrobuild ## Use Hydrobuild from the CLI
To build your applications with Hydrobuild, you can:
- [Use the Docker CLI](#cli) to build from your local development machine
- [Use GitHub Actions](#github-actions) to build with Hydrobuild in CI
### CLI
To run a build using Hydrobuild, invoke a build command and specify the To run a build using Hydrobuild, invoke a build command and specify the
name of the builder using the `--builder` flag. name of the builder using the `--builder` flag.
@ -198,32 +191,28 @@ $ docker buildx use hydrobuild --global
> `docker buildx install` to make the default `docker build` command behave > `docker buildx install` to make the default `docker build` command behave
> like `docker buildx build`, without discrepancies. > like `docker buildx build`, without discrepancies.
### GitHub Actions ## Use Hydrobuild in CI
You can use GitHub Actions in combination with Hydrobuild to achieve faster Using Hydrobuild in CI can speed up your build pipelines, which means less time
build times, while still leveraging the convenience of GitHub Action workflows. spent waiting and context switching. You control your CI workflows as usual,
and delegate the build execution to Hydrobuild.
With this approach, your CI workflows run on a GitHub Actions runner, and the Building with Hydrobuild in CI involve the following steps:
runner calls out to the builder to build the image.
To use Hydrobuild with GitHub Actions, you must first sign in with your Docker 1. Sign in to a Docker account.
ID, and then use the `lab` channel of `setup-buildx-action`: 2. Set up Buildx and create the builder.
3. Run the build.
```yaml When using Hydrobuild in CI, it's recommended that you push the result to a
- name: Log in to Docker Hub registry directly, rather than loading the image and then pushing it. Pushing
uses: docker/login-action@v2 directly speeds up your builds and avoids unnecessary file transfers.
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v2
with:
version: "lab:latest"
driver: cloud
endpoint: "<org>/default"
```
The following example shows a basic workflow for GitHub Actions with Hydrobuild. If you just want to build and discard the output, export the results to the
build cache using `--output type=cacheonly`, or build without a `tag`.
Hydrobuild automatically loads the build result if you build a tagged image.
{{< tabs >}}
{{< tab name="GitHub Actions" >}}
```yaml ```yaml
name: ci name: ci
@ -254,39 +243,111 @@ jobs:
uses: docker/build-push-action@v4 uses: docker/build-push-action@v4
with: with:
context: . context: .
push: true tags: "<org>/<image>"
tags: user/app:latest # For pull requests, export results to the build cache.
# Otherwise, push to a registry.
outputs: ${{ github.event_name == 'pull_request' && 'type=cacheonly' || 'type=registry,push=true' }}
``` ```
This invokes the build from a GitHub Actions workflow, runs the build on {{< /tab >}}
Hydrobuild, and pushes the image to a Docker Hub registry. {{< tab name="CircleCI" >}}
> **Note** ```yaml
> version: 2.1
> The previous example uses a `push: true` configuration for the _Build and
> push_ GitHub Action. This ensures that the build result is pushed to a jobs:
> registry directly, rather than being loaded back to the image store of the # Build multi-platform image and push to a registry
> GitHub Actions runner. When using Hydrobuild in CI, this is the recommended build_push:
> workflow, because it speeds up your builds and avoids unnecessary file machine:
> transfers. image: ubuntu-2204:current
> steps:
> If you're not using `push: true`, and if you build an image with a `tag`, - checkout
> Hydrobuild automatically loads the build results back to the client. If you
> only want to build the artifact without loading the results (as a validation - run: |
> step in pull requests, for example), you can add `outputs: type=cacheonly` to mkdir -vp ~/.docker/cli-plugins/
> the action configuration: ARCH=amd64
> BUILDX_URL=$(curl -s https://raw.githubusercontent.com/docker/actions-toolkit/main/.github/buildx-lab-releases.json | jq -r ".latest.assets[] | select(endswith(\"linux-$ARCH\"))")
> ```yaml curl --silent -L --output ~/.docker/cli-plugins/docker-buildx $BUILDX_URL
> - name: Build and push chmod a+x ~/.docker/cli-plugins/docker-buildx
> uses: docker/build-push-action@v4
> with: - run: echo "$DOCKER_PASS" | docker login --username $DOCKER_USER --password-stdin
> context: . - run: docker buildx create --use --driver cloud "<org>/default"
> tags: user/app:latest
> # if this runs in a pull request, export results to build cache - run: |
> outputs: ${{ github.event_name == 'pull_request' && 'type=cacheonly' || '' }} docker buildx build \
> # if this doesn't run in a pull request, push to a registry --platform linux/amd64,linux/arm64 \
> push: ${{ github.event_name != 'pull_request' }} --push \
> ``` --tag "<org>/<image>" .
# Build an image and discard the result
build_cache:
machine:
image: ubuntu-2204:current
steps:
- checkout
- run: |
mkdir -vp ~/.docker/cli-plugins/
ARCH=amd64
BUILDX_URL=$(curl -s https://raw.githubusercontent.com/docker/actions-toolkit/main/.github/buildx-lab-releases.json | jq -r ".latest.assets[] | select(endswith(\"linux-$ARCH\"))")
curl --silent -L --output ~/.docker/cli-plugins/docker-buildx $BUILDX_URL
chmod a+x ~/.docker/cli-plugins/docker-buildx
- run: echo "$DOCKER_PASS" | docker login --username $DOCKER_USER --password-stdin
- run: docker buildx create --use --driver cloud "<org>/default"
- run: |
docker buildx build \
--tag temp \
--output type=cacheonly \
.
workflows:
pull_request:
jobs:
- build_cache
release:
jobs:
- build_push
```
{{< /tab >}}
{{< tab name="Shell" >}}
```bash
#!/bin/bash
# Get download link for latest buildx binary. Set $ARCH to the CPU architecture (e.g. amd64, arm64)
ARCH=amd64
BUILDX_URL=$(curl -s https://raw.githubusercontent.com/docker/actions-toolkit/main/.github/buildx-lab-releases.json | jq -r ".latest.assets[] | select(endswith(\"linux-$ARCH\"))")
# Download docker buildx with Hyrdobuild support
mkdir -vp ~/.docker/cli-plugins/
curl --silent -L --output ~/.docker/cli-plugins/docker-buildx $BUILDX_URL
chmod a+x ~/.docker/cli-plugins/docker-buildx
# Login to Docker Hub. For security reasons $DOCKER_PASS should be a Personal Access Token. See https://docs.docker.com/docker-hub/access-tokens/
echo "$DOCKER_PASS" | docker login --username $DOCKER_USER --password-stdin
# Connect to your builder and set it as the default builder
docker buildx create --use --driver cloud "<org>/default"
# Cache-only image build
docker buildx build \
--tag temp \
--output type=cacheonly \
.
# Build, tag, and push a multi-arch docker image
docker buildx build \
--platform linux/amd64,linux/arm64 \
--push \
--tag "<org>/<image>" \
.
```
{{< /tab >}}
{{< /tabs >}}
## Hydrobuild in Docker Desktop ## Hydrobuild in Docker Desktop