Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions _docs/pipelines/steps/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ step_name:
| `ssh` | Available when using [Buildkit](#buildkit-support) for ssh keys. See [more info](https://docs.docker.com/engine/reference/commandline/buildx_build/#ssh){:target="\_blank"}| Optional |
| `secrets` | Available when using [Buildkit](#buildkit-support) for secret mounting. See [more info](https://docs.docker.com/engine/reference/commandline/buildx_build/#secret){:target="\_blank"}| Optional |
| `platform` | The [target platform or platforms](https://docs.docker.com/build/building/multi-platform/){:target="\_blank"} to which to push the image. For example, `linux/amd64`. To target multiple platforms, separate them with commas, as in `linux/amd64,linux/arm64`. <br>NOTE: To use this property, you must enable `buildx`. | Optional |
| `progress` | Set type of progress output. Available options: `auto` \| `quiet` \| `plain` \| `tty` \| `rawjson`. Defaults to `plain`. If specified, BuildKit will be enabled implicitly. | Optional |
| `buildx` |Build and push Docker images, including multi-platform images, with <a href="https://github.com/docker/buildx" target="_blank">Buildx</a>. Disabled by default. {::nomarkdown}<ul><li>To enable with default configuration, set to <code class="highlighter-rouge">true</code>. You do not have to add any other parameters.</li>When set to <code class="highlighter-rouge">true</code>, caching is disabled.</li><li>To enable with custom configuration, set to an object with custom configuration. With custom configuration, you can configure settings for <code class="highlighter-rouge">qemu</code> and <code class="highlighter-rouge">builder</code>.<ul><li><code class="highlighter-rouge">qemu</code><ul><li><code class="highlighter-rouge">image</code>: The image to use to install the <a href="https://github.com/qemu/qemu" target="_blank">QEMU</a> static binaries. If not specified, uses the <code class="highlighter-rouge">tonistiigi/binfmt</code> Docker image, and installs the binaries from the <code class="highlighter-rouge">tonistiigi/binfmt:latest</code> Docker image. {:/} <br>To use additional trusted QEMU images, see [Defining trusted QEMU images](#defining-trusted-qemu-images).{::nomarkdown}</li><li><code class="highlighter-rouge">platforms</code>: The binaries of platform emulators to install with the Docker image defined for <code class="highlighter-rouge">image</code>. The default value is <code class="highlighter-rouge">all</code>.</li></ul><li><code class="highlighter-rouge">builder</code>: <ul><li><code class="highlighter-rouge">driver</code>: The builder driver to use. By default, uses <code class="highlighter-rouge">docker-container</code> <a href="https://docs.docker.com/build/building/drivers/docker-container" target="_blank">driver</a> to build multi-platform images and export cache using a <a href="https://github.com/moby/buildkitBuildKit" target="_blank">BuildKit</a> container.<li><code class="highlighter-rouge">driver_opts</code>: Additional driver-specific configuration options to customize the driver. For example, <code class="highlighter-rouge">image=moby/buildkit:master</code>.</li></ul></li></ul>{:/} | Optional |


Expand Down Expand Up @@ -651,21 +652,19 @@ steps:
buildkit: true
```

<!---- `Buildkit` is also automatically enabled if you use any of its features such as the `progress` property: -->
`Buildkit` is also automatically enabled if you use any of its features such as the `progress` property:

`codefresh.yml`

```yaml
version: '1.0'
steps:
BuildMyImage:
title: Building My Docker image
image_name: my-app-image
image_name: my-app-image
type: build
progress: tty
```

<!--- commenting out as not supported currently. When supported add this line to the code snippet above and remove comments: type: build
progress: ttyPossible values for `progress` are `tty` and `plain`. -->

For secrets, you can either mention them in a single line:

`codefresh.yml`
Expand Down Expand Up @@ -761,7 +760,7 @@ steps:

{% endraw %}

You can combine all options (`ssh`, <!--- `progress`,--> `secrets`) in a single build step if desired.
You can combine all options (`ssh`, `progress`, `secrets`) in a single build step if desired.

## Defining trusted QEMU images
The `build` step supports other QEMU images in addition to the default image.
Expand Down