Skip to content

Commit ee3c4ee

Browse files
authored
chore: Remove mentions of bake-related terms (#1260)
* chore: Split main README into several sub READMEs * chore: Remove mentions of "bake", "conf.py", and "versions.py" * chore: Remove unused enumerate-product-versions.py script
1 parent 3cb5520 commit ee3c4ee

26 files changed

+251
-321
lines changed

.github/ISSUE_TEMPLATE/add-product.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ assignees: ''
1717
- [ ] Create a README.md file outlining special considerations required to
1818
update or run the product. See existing README files as a guide of
1919
reference.
20-
- [ ] Add a `versions.py` file to the folder. Add all required key-value pairs.
20+
- [ ] Add a `boil-config.toml` file to the folder. Add all required local image
21+
dependencies and build arguments.
2122
- [ ] Add a new "Update Product" issue template in `.github/ISSUE_TEMPLATE/`
2223
folder. See existing ones as a guide of reference.
2324
- [ ] Add a new `build_<PRODUCT>.yml` GitHub Action workflow in the

.github/ISSUE_TEMPLATE/update-base-java.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ we should also make new versions of Java available for use.
4141
4242
## Update tasks
4343

44-
- [ ] Add any new versions of java to both `java-base/versions.py` and `java-devel/versions.py`
45-
- [ ] Remove versions when there are no long any references (eg: `grep java- **/versions.py | grep "1.8.0"`)
44+
- [ ] Add any new versions of java to both `java-base/boil-config.toml` and `java-devel/boil-config.toml`
45+
- [ ] Remove versions when there are no long any references (eg: `grep java- **/boil-config.toml | grep "1.8.0"`)
4646

4747
## Related Pull Requests
4848

@@ -55,18 +55,16 @@ we should also make new versions of Java available for use.
5555
> checked, the issue can be moved into _Development: Done_.
5656
5757
- [ ] Can build a product image that uses the new version(s)
58-
- [ ] Both `java-base` and `java-devel` have the same Java versions in `versions.py`
58+
- [ ] Both `java-base` and `java-devel` have the same Java versions in `boil-config.toml`
5959
- [ ] Kuttl smoke test passes locally for a product using the new Java version
6060

6161
<details>
6262
<summary>Testing instructions</summary>
6363

6464
```shell
65-
# See the latest version at https://pypi.org/project/image-tools-stackabletech/
66-
pip install image-tools-stackabletech==0.0.16
67-
68-
# Test a product image can build, eg: ZooKeeper
69-
bake --product zookeeper=x.y.z # where x.y.z is a valid product version using the newly added Java version
65+
# Test a product image can build, eg: ZooKeeper where x.y.z is a valid product
66+
# version using the newly added Java version
67+
boil build zookeeper=x.y.z --strip-architecture --load
7068

7169
kind load docker-image oci.stackable.tech/sdp/zookeeper:x.y.z-stackable0.0.0-dev
7270

.github/ISSUE_TEMPLATE/update-base-stackable.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,8 @@ Part of <https://github.com/stackabletech/issues/issues/xxx>.
5555
<summary>Testing instructions</summary>
5656

5757
```shell
58-
# See the latest version at https://pypi.org/project/image-tools-stackabletech/
59-
pip install image-tools-stackabletech==0.0.16
60-
61-
bake --product vector=x.y.z # where x.y.z is a valid version
58+
# Where x.y.z is a valid version
59+
boil build vector=x.y.z --strip-architecture --load
6260
```
6361

6462
</details>

.github/ISSUE_TEMPLATE/update-base-vector.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ Add/Change/Remove anything that isn't applicable anymore
3333
3434
## Update tasks
3535

36-
- [ ] Update `versions.py` to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
37-
- [ ] Update all `versions.py` files which reference vector.
36+
- [ ] Update `boil-config.toml` to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
37+
- [ ] Update all `boil-config.toml` files which reference vector.
3838
- [ ] Upload new version (see `vector/upload_new_vector_version.sh`).
3939
- [ ] Update other dependencies if applicable (eg: inotify_tools, etc).
4040
- [ ] Check other operators (getting_started / kuttl / supported-versions) for usage of the versions. Add the PR(s) to the list below.
@@ -68,10 +68,8 @@ Add/Change/Remove anything that isn't applicable anymore
6868
<summary>Testing instructions</summary>
6969

7070
```shell
71-
# See the latest version at https://pypi.org/project/image-tools-stackabletech/
72-
pip install image-tools-stackabletech==0.0.16
73-
74-
bake --product vector=x.y.z # where x.y.z is the new version added in this PR
71+
# Where x.y.z is the new version added in this PR
72+
boil build vector=x.y.z --strip-architecture --load
7573

7674
kind load docker-image oci.stackable.tech/sdp/vector:x.y.z-stackable0.0.0-dev
7775

.github/ISSUE_TEMPLATE/update-product-airflow.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Add/Change/Remove anything that isn't applicable anymore
2727
2828
## Update tasks
2929

30-
- [ ] Update `versions.py` to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
30+
- [ ] Update `boil-config.toml` to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
3131
- [ ] Download new constraints file (see `airflow/download_constraints.sh`).
3232
- [ ] Update other dependencies if applicable (eg: python, statsd_exporter, cyclonedx-bom, etc).
3333
- [ ] Check other operators (getting_started / kuttl / supported-versions) for usage of the versions. Add the PR(s) to the list below.
@@ -62,10 +62,8 @@ Add/Change/Remove anything that isn't applicable anymore
6262
<summary>Testing instructions</summary>
6363

6464
```shell
65-
# See the latest version at https://pypi.org/project/image-tools-stackabletech/
66-
pip install image-tools-stackabletech==0.0.16
67-
68-
bake --product airflow=x.y.z # where x.y.z is the new version added in this PR
65+
# Where x.y.z is the new version added in this PR
66+
boil build airflow=x.y.z --strip-architecture --load
6967

7068
kind load docker-image oci.stackable.tech/sdp/airflow:x.y.z-stackable0.0.0-dev
7169

.github/ISSUE_TEMPLATE/update-product-druid.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ Add/Change/Remove anything that isn't applicable anymore
2828
## Update tasks
2929

3030
- [ ] Release a new version of [druid-opa-authorizer](https://github.com/stackabletech/druid-opa-authorizer)
31-
- [ ] Update `versions.py` to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
31+
- [ ] Update `boil-config.toml` to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
3232
- [ ] Update the [druid-opa-authorizer](https://github.com/stackabletech/druid-opa-authorizer/) with the new set of versions.
3333
- [ ] Upload new version (see `druid/upload_new_druid_version.sh`).
3434
- [ ] Create a file: `druid/stackable/patches/x.y.z/.gitkeep`, add patches if applicable.
3535
- [ ] Delete old patch directories.
36-
- [ ] Update `versions.py` to the latest supported version of JVM (base and devel).
36+
- [ ] Update `boil-config.toml` to the latest supported version of JVM (base and devel).
3737
- [ ] Check other operators (getting_started / kuttl / supported-versions) for usage of the versions. Add the PR(s) to the list below.
3838
- [ ] Ensure prerequisites are up to date (required-external-components.adoc).
3939
- [ ] Update the version in demos. Add the PR(s) to the list below.
@@ -67,10 +67,8 @@ Add/Change/Remove anything that isn't applicable anymore
6767
<summary>Testing instructions</summary>
6868

6969
```shell
70-
# See the latest version at https://pypi.org/project/image-tools-stackabletech/
71-
pip install image-tools-stackabletech==0.0.16
72-
73-
bake --product druid=x.y.z # where x.y.z is the new version added in this PR
70+
# Where x.y.z is the new version added in this PR
71+
boil build druid=x.y.z --strip-architecture --load
7472

7573
kind load docker-image oci.stackable.tech/sdp/druid:x.y.z-stackable0.0.0-dev
7674

.github/ISSUE_TEMPLATE/update-product-hbase-phoenix-omid.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,17 @@ Add/Change/Remove anything that isn't applicable anymore
2929

3030
### HBase and Phoenix
3131

32-
- [ ] Update `versions.py` to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
32+
- [ ] Update `boil-config.toml` to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
3333
- [ ] Upload new versions (see the `hbase/*.sh` scripts).
34-
- [ ] Update `versions.py` to the latest supported version of JVM (base and devel).
34+
- [ ] Update `boil-config.toml` to the latest supported version of JVM (base and devel).
3535
- [ ] Update other dependencies if applicable (eg: phoenix, opa_authorizer, etc).
3636
- [ ] Check other operators (getting_started / kuttl / supported-versions) for usage of the versions. Add the PR to the list below.
3737

3838
### Omid
3939

40-
- [ ] Update `omid/versions.py`to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
40+
- [ ] Update `omid/boil-config.toml`to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
4141
- [ ] Upload new version (see `omid/upload_new_omid_version.sh`).
42-
- [ ] Update `versions.py` to the latest supported version of JVM (base and devel).
42+
- [ ] Update `boil-config.toml` to the latest supported version of JVM (base and devel).
4343
- [ ] Update other dependencies if applicable (eg: jmx_exporter, etc).
4444

4545
## Related Pull Requests
@@ -70,11 +70,9 @@ Add/Change/Remove anything that isn't applicable anymore
7070
<summary>Testing instructions</summary>
7171

7272
```shell
73-
# See the latest version at https://pypi.org/project/image-tools-stackabletech/
74-
pip install image-tools-stackabletech==0.0.16
75-
76-
bake --product hbase=x.y.z # where x.y.z is the new version added in this PR
77-
bake --product omid=x.y.z # where x.y.z is the new version added in this PR
73+
# Where x.y.z is the new version added in this PR
74+
boil build hbase=x.y.z --strip-architecture --load
75+
boil build omid=x.y.z --strip-architecture --load
7876

7977
kind load docker-image oci.stackable.tech/sdp/hbase:x.y.z-stackable0.0.0-dev
8078
kind load docker-image oci.stackable.tech/sdp/omid:x.y.z-stackable0.0.0-dev

.github/ISSUE_TEMPLATE/update-product-hdfs.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ Add/Change/Remove anything that isn't applicable anymore
2727
2828
## Update tasks
2929

30-
- [ ] Update `versions.py` to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
30+
- [ ] Update `boil-config.toml` to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
3131
- [ ] Upload new version (see `hadoop/upload_new_hadoop_version.sh`).
32-
- [ ] Update `versions.py` to the latest supported version of JVM (base and devel).
32+
- [ ] Update `boil-config.toml` to the latest supported version of JVM (base and devel).
3333
- [ ] Update other dependencies if applicable (eg: hdfs_utils, jmx_exporter, protobuf, etc).
3434
- [ ] Check other operators (getting_started / kuttl / supported-versions) for usage of the versions. Add the PR(s) to the list below.
3535
- [ ] Update the version in demos. Add the PR(s) to the list below.
@@ -63,10 +63,8 @@ Add/Change/Remove anything that isn't applicable anymore
6363
<summary>Testing instructions</summary>
6464

6565
```shell
66-
# See the latest version at https://pypi.org/project/image-tools-stackabletech/
67-
pip install image-tools-stackabletech==0.0.16
68-
69-
bake --product hadoop=x.y.z # where x.y.z is the new version added in this PR
66+
# Where x.y.z is the new version added in this PR
67+
boil build hadoop=x.y.z --strip-architecture --load
7068

7169
kind load docker-image oci.stackable.tech/sdp/hadoop:x.y.z-stackable0.0.0-dev
7270

.github/ISSUE_TEMPLATE/update-product-hive.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ Add/Change/Remove anything that isn't applicable anymore
2727
2828
## Update tasks
2929

30-
- [ ] Update `versions.py` to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
30+
- [ ] Update `boil-config.toml` to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
3131
- [ ] Upload new version (see `hive/upload_new_hive_version.sh`).
32-
- [ ] Update `versions.py` to the latest supported version of JVM (base and devel).
32+
- [ ] Update `boil-config.toml` to the latest supported version of JVM (base and devel).
3333
- [ ] Update other dependencies if applicable (eg: jmx_exporter, aws_java_sdk_bundle, etc).
3434
- [ ] Check other operators (getting_started / kuttl / supported-versions) for usage of the versions. Add the PR(s) to the list below.
3535
- [ ] Ensure prerequisites are up to date (required-external-components.adoc).
@@ -63,10 +63,8 @@ Add/Change/Remove anything that isn't applicable anymore
6363
<summary>Testing instructions</summary>
6464

6565
```shell
66-
# See the latest version at https://pypi.org/project/image-tools-stackabletech/
67-
pip install image-tools-stackabletech==0.0.16
68-
69-
bake --product hive=x.y.z # where x.y.z is the new version added in this PR
66+
# Where x.y.z is the new version added in this PR
67+
boil build hive=x.y.z --strip-architecture --load
7068

7169
kind load docker-image oci.stackable.tech/sdp/hive:x.y.z-stackable0.0.0-dev
7270

.github/ISSUE_TEMPLATE/update-product-kafka.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ Add/Change/Remove anything that isn't applicable anymore
2929

3030
### Kafka
3131

32-
- [ ] Update `versions.py` to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
32+
- [ ] Update `boil-config.toml` to reflect the agreed upon versions in the spreadsheet (including the removal of old versions).
3333
- [ ] Upload new version (see `kafka/upload_new_kafka_version.sh`).
34-
- [ ] Update `versions.py` to the latest supported version of JVM (base and devel).
34+
- [ ] Update `boil-config.toml` to the latest supported version of JVM (base and devel).
3535
- [ ] Update other dependencies if applicable (eg: jmx_exporter, kcat, scala, etc).
3636
- [ ] Check other operators (getting_started / kuttl / supported-versions) for usage of the versions. Add the PR(s) to the list below.
3737
- [ ] Update the version in demos. Add the PR(s) to the list below.
@@ -40,10 +40,10 @@ Add/Change/Remove anything that isn't applicable anymore
4040

4141
<!-- todo: ensure this is the correct procedure -->
4242

43-
- [ ] Update `kcat/versions.py`.
44-
- [ ] Update `kafka-testing-tools/versions.py`.
43+
- [ ] Update `kcat/boil-config.toml`.
44+
- [ ] Update `kafka-testing-tools/boil-config.toml`.
4545
- [ ] Upload new version (see `.scripts/upload_new_kcat_version.sh`).
46-
- [ ] Update `versions.py` to the latest supported version of JVM (base and devel).
46+
- [ ] Update `boil-config.toml` to the latest supported version of JVM (base and devel).
4747
- [ ] Check other operators (getting_started / kuttl / supported-versions) for usage of the versions. Add the PR(s) to the list below.
4848
- [ ] Update the version in demos. Add the PR(s) to the list below.
4949

@@ -75,11 +75,11 @@ Add/Change/Remove anything that isn't applicable anymore
7575
<summary>Testing instructions</summary>
7676

7777
```shell
78-
# See the latest version at https://pypi.org/project/image-tools-stackabletech/
79-
pip install image-tools-stackabletech==0.0.16
78+
# Where x.y.z is the new version added in this PR
79+
boil build kafka=x.y.z --strip-architecture --load
8080

81-
bake --product kafka=x.y.z # where x.y.z is the new version added in this PR
82-
bake --product kafka-testing-tools=1.0.0 # This version doesn't change
81+
# This version doesn't change
82+
boil build kafka-testing-tools=1.0.0 --strip-architecture --load
8383

8484
kind load docker-image oci.stackable.tech/sdp/kafka:x.y.z-stackable0.0.0-dev
8585
kind load docker-image oci.stackable.tech/sdp/kafka-testing-tools:1.0.0-stackable0.0.0-dev

0 commit comments

Comments
 (0)