Skip to content

Commit 5ad6255

Browse files
committed
update README with loading OCI images
Signed-off-by: Taylor Silva <[email protected]>
1 parent e19559a commit 5ad6255

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,12 @@ _(As a convention in the list below, all task parameters are specified with a
6262
to build.
6363

6464
* `$BUILDKIT_SSH` your ssh key location that is mounted in your `Dockerfile`. This is
65-
generally used for pulling dependencies from private repositories.
65+
generally used for pulling dependencies from private repositories.
6666

6767
For Example. In your `Dockerfile`, you can mount a key as
6868
```
6969
RUN --mount=type=ssh,id=github_ssh_key pip install -U -r ./hats/requirements-test.txt
70-
```
70+
```
7171
7272
Then in your Concourse YAML configuration:
7373
```
@@ -122,10 +122,11 @@ _(As a convention in the list below, all task parameters are specified with a
122122
`(( mysecret ))` expands to in `/run/secrets/mysecret`.
123123

124124
* `$IMAGE_ARG_*`: params prefixed with `IMAGE_ARG_*` point to image tarballs
125-
(i.e. `docker save` format) to preload so that they do not have to be fetched
126-
during the build. An image reference will be provided as the given build arg
127-
name. For example, `IMAGE_ARG_base_image=ubuntu/image.tar` will set
128-
`base_image` to a local image reference for using `ubuntu/image.tar`.
125+
(i.e. `docker save` format) or path to images in OCI layout format, to preload
126+
so that they do not have to be fetched during the build. An image reference
127+
will be provided as the given build arg name. For example,
128+
`IMAGE_ARG_base_image=ubuntu/image.tar` will set `base_image` to a local image
129+
reference for using `ubuntu/image.tar`.
129130

130131
This must be accepted as an argument for use; for example:
131132

@@ -134,10 +135,10 @@ _(As a convention in the list below, all task parameters are specified with a
134135
FROM ${base_image}
135136
```
136137

137-
* `$IMAGE_PLATFORM`: Specify the target platform to build the image for. For
138-
example `IMAGE_PLATFORM=linux/arm64` will build the image for the Linux OS
139-
and `arm64` architecture. By default, images will be built for the current
140-
worker's platform that the task is running on.
138+
* `$IMAGE_PLATFORM`: Specify the target platform(s) to build the image for. For
139+
example `IMAGE_PLATFORM=linux/arm64,linux/amd64` will build the image for the
140+
Linux OS and architectures `arm64` and `amd64`. By default, images will be
141+
built for the current worker's platform that the task is running on.
141142

142143
* `$LABEL_*`: params prefixed with `LABEL_` will be set as image labels.
143144
For example `LABEL_foo=bar`, will set the `foo` label to `bar`.

0 commit comments

Comments
 (0)