Skip to content

Commit 6cd98d5

Browse files
authored
Include prebuilt images in README
1 parent f627a2a commit 6cd98d5

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,30 @@ Currently there are two types of images - a "base" image that contains the core
66

77
# Getting container images
88

9+
## Prebuilt Images
10+
11+
The simplest way to start using these container images is with the prebuilt images provided by the project. Images are automatically generated using Github Actions and hosted on the Github Container Registry (GHCR.) GHCR is functionally equivalent to Dockerhub and can be used with standard tools like the Docker CLI.
12+
13+
The project follows an evergreen strategy, meaning only the latest SDK release is maintained. Older SDKs are still hosted but it is recommended to build images locally in order to guarantee the latest packages and security updates are included.
14+
15+
### Using prebuilt images
16+
17+
The full list of prebuilt images can be found [here](https://github.com/embeddedcontainers/zephyr/pkgs/container/zephyr/versions?filters%5Bversion_type%5D=tagged).
18+
19+
For example, the image for the `arm` toolchain can be found [here](https://github.com/embeddedcontainers/zephyr/pkgs/container/zephyr/292819795?tag=arm-0.17.0SDK).
20+
21+
To install via the Docker CLI:
22+
23+
```
24+
$ docker pull ghcr.io/embeddedcontainers/zephyr:arm-0.17.0SDK
25+
```
26+
27+
Use as base image in Dockerfile:
28+
29+
```
30+
FROM ghcr.io/embeddedcontainers/zephyr:arm-0.17.0SDK
31+
```
32+
933
## Build images locally
1034

1135
Building images locally ensures you can trust the source of the image, as well as allow you to modify the container image configuration.
@@ -36,4 +60,4 @@ _There is a different Dockerfile for Posix target like `native_sim`. To build:_
3660

3761
```
3862
docker build --build-arg BASE_IMAGE="zephyr:base-0.17.0SDK" -f "./zephyr-posix/Dockerfile" -t zephyr:posix-0.17.0SDK "./zephyr-posix"
39-
```
63+
```

0 commit comments

Comments
 (0)