Skip to content

Commit 84184ec

Browse files
committed
chore: Update README to mention boil
1 parent edaacb9 commit 84184ec

1 file changed

Lines changed: 13 additions & 30 deletions

File tree

README.md

Lines changed: 13 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -15,45 +15,28 @@ This repository contains Dockerfiles and scripts to build base images for use wi
1515

1616
## Prerequisites
1717

18-
* [Stackable Image Tools](https://github.com/stackabletech/image-tools) (`pip install image-tools-stackabletech`)
18+
* [boil](./rust/boil//README.md) (`cargo boil`)
1919
* Docker including the [`buildx` plugin](https://github.com/docker/buildx)
2020
* Optional: [OpenShift preflight tool](https://github.com/redhat-openshift-ecosystem/openshift-preflight) to verify an image for OpenShift
2121

22-
## Build Product Images
22+
## Build Images
2323

24-
Product images are published to the `oci.stackable.tech` registry under the `sdp` organization by default.
24+
Images are published to the `oci.stackable.tech` registry under the `sdp` organization by default.
2525

26-
### Build single products locally
26+
### Build images locally
2727

28-
To build and push product images to the default repository use this command:
28+
Consult the [boil README](./rust/boil//README.md) which contains a broad selection of different commands to build images locally.
2929

30-
```sh
31-
bake --product zookeeper --image 0.0.0-dev --push
32-
```
33-
34-
This will build images for Apache ZooKeeper versions as defined in the `conf.py` file, tag them with the `image-version` 0.0.0-dev and push them to the registry.
35-
36-
You can select a specific version of a product to build using the syntax `product=version` e.g. to build Hive 3.1.3 you can use this command:
37-
38-
```sh
39-
bake --product hive=3.1.3 -i 0.0.0-dev
40-
```
41-
42-
> [!NOTE]
43-
> `-i` is the shorthand for `--image` (i.e. the resulting image tag)
44-
45-
### Build all products locally
46-
47-
To build all products in all versions locally you can use this command
48-
49-
```sh
50-
bake --image-version 0.0.0-dev
51-
```
30+
### Build images via GitHub Actions
5231

53-
### Build everything in GitHub
32+
There are individual GHA workflows (one for each image) which use a
33+
[reusable workflow](.github/workflows/reusable_build_image.yaml) to build all specified versions for
34+
both `amd64` and `arm64`. The workflow is triggered
5435

55-
The GitHub action called `Build (and optionally publish) 0.0.0-dev images` can be triggered manually to do build all images in all versions.
56-
When triggered manually it will _not_ push the images to the registry.
36+
* by pushes to `main` to produce `0.0.0-dev` versions of the images,
37+
* by a regular schedule to rebuild `0.0.0-dev` versions of the images to avoid staleness,
38+
* by tag pushes to produce (release candidate) images for a particular SDP,
39+
* and by manual workflow dispatches.
5740

5841
## Patches
5942

0 commit comments

Comments
 (0)