Skip to content

Commit 2d17c85

Browse files
committed
update readme
1 parent 6e84d63 commit 2d17c85

1 file changed

Lines changed: 33 additions & 31 deletions

File tree

deploy/helm/airflow-operator/README.md

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -17,45 +17,47 @@ make compile-chart
1717
helm install airflow-operator deploy/helm/airflow-operator
1818
```
1919

20-
## Publish The Chart To Multiple Registries
20+
## Publish The Chart
2121

22-
This chart is structured so the operator image can be sourced from different registries without
23-
duplicating templates.
22+
The Helm chart is published to two different repositories:
2423

25-
- `values.yaml` contains the default image coordinates (`image.registry` and `image.repository`).
26-
- `values.registry-oci.yaml` sets defaults for chart artifacts published to `oci.stackable.tech`.
27-
- `values.registry-quay.yaml` sets defaults for chart artifacts published to `quay.io`.
24+
- oci.stackable.tech
25+
- quay.io
2826

29-
Package each artifact with a registry-specific `values.yaml` so users of each chart registry
30-
automatically pull images from the same source registry.
27+
Each chart version references images from it's corresponding repository.
3128

32-
`helm package` does not accept a values overlay directly, so create a temporary chart copy per
33-
target and merge values before packaging:
29+
Package and publish both variants:
3430

3531
```bash
36-
# Package chart with oci.stackable.tech defaults
37-
tmp_oci="$(mktemp -d)"
38-
cp -r deploy/helm/airflow-operator "${tmp_oci}/"
39-
yq ea '. as $item ireduce ({}; . * $item )' \
40-
"${tmp_oci}/airflow-operator/values.yaml" \
41-
"${tmp_oci}/airflow-operator/values.registry-oci.yaml" \
42-
> "${tmp_oci}/airflow-operator/values.yaml.new"
43-
mv "${tmp_oci}/airflow-operator/values.yaml.new" "${tmp_oci}/airflow-operator/values.yaml"
44-
helm package "${tmp_oci}/airflow-operator" --destination /tmp/charts-oci
45-
46-
# Package chart with quay.io defaults
47-
tmp_quay="$(mktemp -d)"
48-
cp -r deploy/helm/airflow-operator "${tmp_quay}/"
49-
yq ea '. as $item ireduce ({}; . * $item )' \
50-
"${tmp_quay}/airflow-operator/values.yaml" \
51-
"${tmp_quay}/airflow-operator/values.registry-quay.yaml" \
52-
> "${tmp_quay}/airflow-operator/values.yaml.new"
53-
mv "${tmp_quay}/airflow-operator/values.yaml.new" "${tmp_quay}/airflow-operator/values.yaml"
54-
helm package "${tmp_quay}/airflow-operator" --destination /tmp/charts-quay
32+
make chart-package-all
33+
make chart-publish-all
5534
```
5635

57-
Then push the packaged chart from `/tmp/charts-oci` to `oci.stackable.tech` and the packaged chart
58-
from `/tmp/charts-quay` to `quay.io`.
36+
Package and publish for oci.stackable.tech:
37+
38+
```bash
39+
make chart-package-oci
40+
make chart-publish-oci
41+
```
42+
43+
Package and publish for quay.io:
44+
45+
```bash
46+
make chart-package-quay
47+
make chart-publish-quay
48+
```
49+
50+
Install from oci.stackable.tech:
51+
52+
```bash
53+
helm install airflow-operator oci://oci.stackable.tech/sdp/charts/airflow-operator --version 0.0.0-dev
54+
```
55+
56+
Install from quay.io:
57+
58+
```shell
59+
helm install airflow-operator oci://quay.io/stackable/charts/airflow-operator --version 0.0.0-dev
60+
```
5961

6062
## Usage of the CRDs
6163

0 commit comments

Comments
 (0)