From b28adcc463c12f245f7af000bbc9da204c2a3ec5 Mon Sep 17 00:00:00 2001 From: Techassi Date: Wed, 23 Apr 2025 12:28:27 +0200 Subject: [PATCH 1/3] chore: Rework and split pre-release issue templates --- .../pre-release-from-scratch-testing.md | 87 ++++++++++++ .../pre-release-upgrade-testing.md | 130 ++++++------------ 2 files changed, 128 insertions(+), 89 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/pre-release-from-scratch-testing.md diff --git a/.github/ISSUE_TEMPLATE/pre-release-from-scratch-testing.md b/.github/ISSUE_TEMPLATE/pre-release-from-scratch-testing.md new file mode 100644 index 00000000..0263015f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/pre-release-from-scratch-testing.md @@ -0,0 +1,87 @@ +--- +name: Pre-Release Demo Nightly Testing +about: | + This template can be used to track the testing of nightly demos from scratch + leading up to the next Stackable release. +title: "chore(tracking): Test demos on nightly versions for YY.M.X" +labels: ['epic'] +assignees: '' +--- + + + +Part of + +This is testing that the _nightly_ release of the operators and products do not negatively impact +the products. + +> [!NOTE] +> Record the results (issues, anomalies, or success) during the process in a comment on this issue. +> Eg: +> +> ```md +> :green_circle: **airflow-scheduled-job** +> +> The CRD had been updated and I needed to change the following in the manifest: +> ... +> ``` +> +> The following emojis can be used to indicate the status: +> +> - `hourglass`: In progress / waiting +> - `red_circle`: In progress with errors +> - `orange_circle`: Completed with minor issues or anomalies +> - `green_circle`: Completed without issues or errors + +## List of demos + +Replace the items in the lists below with the applicable Pull Requests (if any). Also put your +GitHub handle next to the demo to indicate a particular demo was picked up for testing. + + + + + +- [ ] [airflow-scheduled-job](https://docs.stackable.tech/home/nightly/demos/airflow-scheduled-job) +- [ ] [data-lakehouse-iceberg-trino-spark](https://docs.stackable.tech/home/nightly/demos/data-lakehouse-iceberg-trino-spark) +- [ ] [end-to-end-security](https://docs.stackable.tech/home/nightly/demos/end-to-end-security) +- [ ] [hbase-hdfs-load-cycling-data](https://docs.stackable.tech/home/nightly/demos/hbase-hdfs-load-cycling-data) +- [ ] [jupyterhub-keycloak](https://docs.stackable.tech/home/nightly/demos/jupyterhub-keycloak) +- [ ] [jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data](https://docs.stackable.tech/home/nightly/demos/jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data) +- [ ] [logging](https://docs.stackable.tech/home/nightly/demos/logging) +- [ ] [nifi-kafka-druid-earthquake-data](https://docs.stackable.tech/home/nightly/demos/nifi-kafka-druid-earthquake-data) +- [ ] [nifi-kafka-druid-water-level-data](https://docs.stackable.tech/home/nightly/demos/nifi-kafka-druid-water-level-data) +- [ ] [signal-processing](https://docs.stackable.tech/home/nightly/demos/signal-processing) +- [ ] [spark-k8s-anomaly-detection-taxi-data](https://docs.stackable.tech/home/nightly/demos/spark-k8s-anomaly-detection-taxi-data) +- [ ] [trino-iceberg](https://docs.stackable.tech/home/nightly/demos/trino-iceberg) +- [ ] [trino-taxi-data](https://docs.stackable.tech/home/nightly/demos/trino-taxi-data) + +## Nightly from Scratch Testing Instructions + +These instructions are for deploying and completing the nightly demo from scratch. + + + +> [!TIP] +> Be sure to select the _nightly_ docs version on . + +```shell +# Install demo (stable operators) for the nightly release. +stackablectl demo install --release dev + +# --- IMPORTANT --- +# Run through the nightly demo instructions (refer to the list above). +``` diff --git a/.github/ISSUE_TEMPLATE/pre-release-upgrade-testing.md b/.github/ISSUE_TEMPLATE/pre-release-upgrade-testing.md index aec0f11e..2552bd83 100644 --- a/.github/ISSUE_TEMPLATE/pre-release-upgrade-testing.md +++ b/.github/ISSUE_TEMPLATE/pre-release-upgrade-testing.md @@ -1,9 +1,9 @@ --- -name: Pre-Release Demo and Upgrade Testing +name: Pre-Release Demo Upgrade Testing about: | This template can be used to track the upgrade testing of demos from stable to - nightly and nightly from scratch leading up to the next Stackable release. -title: "chore(tracking): Test demos on nightly versions for YY.M.X" + nightly leading up to the next Stackable release. +title: "chore(tracking): Test demo upgrades on nightly versions for YY.M.X" labels: ['epic'] assignees: '' --- @@ -13,33 +13,33 @@ assignees: '' you change the filename. --> - - -## Pre-Release Demo Testing on Nightly - Part of -This is testing: - -1. That upgrades from the _stable_ release to the _nightly_ release of the operators and products do - not negatively impact the products. -2. That _nightly_ demos work as documented from scratch. +This is testing that upgrades from the _stable_ release to the _nightly_ release of the operators +and products do not negatively impact the products. > [!NOTE] -> Record any issues or anomalies during the process in a comment on this issue. +> Record the results (issues, anomalies, or success) during the process in a comment on this issue. > Eg: > -> ```plain +> ```md > :green_circle: **airflow-scheduled-job** > > The CRD had been updated and I needed to change the following in the manifest: > ... > ``` +> +> The following emojis can be used to indicate the status: +> +> - `hourglass`: In progress / waiting +> - `red_circle`: In progress with errors +> - `orange_circle`: Completed with minor issues or anomalies +> - `green_circle`: Completed without issues or errors -Replace the items in the task lists below with the applicable Pull Requests (if any). +## List of demos + +Replace the items in the lists below with the applicable Pull Requests (if any). Also put your +GitHub handle next to the demo to indicate a particular demo was picked up for testing. -```[tasklist] -### Testing Demos on Nightly -- [ ] [airflow-scheduled-job](https://docs.stackable.tech/home/nightly/demos/airflow-scheduled-job) -- [ ] [data-lakehouse-iceberg-trino-spark](https://docs.stackable.tech/home/nightly/demos/data-lakehouse-iceberg-trino-spark) -- [ ] [end-to-end-security](https://docs.stackable.tech/home/nightly/demos/end-to-end-security) -- [ ] [hbase-hdfs-load-cycling-data](https://docs.stackable.tech/home/nightly/demos/hbase-hdfs-load-cycling-data) -- [ ] [jupyterhub-keycloak](https://docs.stackable.tech/home/nightly/demos/jupyterhub-keycloak) -- [ ] [jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data](https://docs.stackable.tech/home/nightly/demos/jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data) -- [ ] [logging](https://docs.stackable.tech/home/nightly/demos/logging) -- [ ] [nifi-kafka-druid-earthquake-data](https://docs.stackable.tech/home/nightly/demos/nifi-kafka-druid-earthquake-data) -- [ ] [nifi-kafka-druid-water-level-data](https://docs.stackable.tech/home/nightly/demos/nifi-kafka-druid-water-level-data) -- [ ] [signal-processing](https://docs.stackable.tech/home/nightly/demos/signal-processing) -- [ ] [spark-k8s-anomaly-detection-taxi-data](https://docs.stackable.tech/home/nightly/demos/spark-k8s-anomaly-detection-taxi-data) -- [ ] [trino-iceberg](https://docs.stackable.tech/home/nightly/demos/trino-iceberg) -- [ ] [trino-taxi-data](https://docs.stackable.tech/home/nightly/demos/trino-taxi-data) -``` + -### Stable to Nightly Upgrade Testing Instructions +- [ ] [airflow-scheduled-job](https://docs.stackable.tech/home/stable/demos/airflow-scheduled-job) +- [ ] [data-lakehouse-iceberg-trino-spark](https://docs.stackable.tech/home/stable/demos/data-lakehouse-iceberg-trino-spark) +- [ ] [end-to-end-security](https://docs.stackable.tech/home/stable/demos/end-to-end-security) +- [ ] [hbase-hdfs-load-cycling-data](https://docs.stackable.tech/home/stable/demos/hbase-hdfs-load-cycling-data) +- [ ] [jupyterhub-keycloak](https://docs.stackable.tech/home/stable/demos/jupyterhub-keycloak) +- [ ] [jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data](https://docs.stackable.tech/home/stable/demos/jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data) +- [ ] [logging](https://docs.stackable.tech/home/stable/demos/logging) +- [ ] [nifi-kafka-druid-earthquake-data](https://docs.stackable.tech/home/stable/demos/nifi-kafka-druid-earthquake-data) +- [ ] [nifi-kafka-druid-water-level-data](https://docs.stackable.tech/home/stable/demos/nifi-kafka-druid-water-level-data) +- [ ] [signal-processing](https://docs.stackable.tech/home/stable/demos/signal-processing) +- [ ] [spark-k8s-anomaly-detection-taxi-data](https://docs.stackable.tech/home/stable/demos/spark-k8s-anomaly-detection-taxi-data) +- [ ] [trino-iceberg](https://docs.stackable.tech/home/stable/demos/trino-iceberg) +- [ ] [trino-taxi-data](https://docs.stackable.tech/home/stable/demos/trino-taxi-data) + +## Stable to Nightly Upgrade Testing Instructions These instructions are for deploying and completing the stable demo, and then -upgading operators, CRDs, and products to the nightly versions well as upgrading +upgrading operators, CRDs, and products to the nightly versions well as upgrading the operators and CRDS. - -> [!TIP] -> Be sure to select the _nightly_ docs version on . - -```shell -# Install demo (stable operators) for the nightly release. -# Until https://github.com/stackabletech/stackable-cockpit/issues/310 is merged, -# this will need to be done by pointing stackablectl to local files checked out -# from the main branch. -git checkout main -git pull -stackablectl --stack-file=stacks/stacks-v2.yaml --demo-file=demos/demos-v2.yaml demo install - -# --- IMPORTANT --- -# Run through the nightly demo instructions (refer to the tasklist above). -``` From f34379c58fe0035bb61b367b3028f4bf09e833f5 Mon Sep 17 00:00:00 2001 From: Techassi Date: Wed, 23 Apr 2025 15:55:22 +0200 Subject: [PATCH 2/3] chore: Update release demo testing issue template --- .../ISSUE_TEMPLATE/release-upgrade-testing.md | 111 +++--------------- 1 file changed, 19 insertions(+), 92 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/release-upgrade-testing.md b/.github/ISSUE_TEMPLATE/release-upgrade-testing.md index d9e7a17c..cde8bf61 100644 --- a/.github/ISSUE_TEMPLATE/release-upgrade-testing.md +++ b/.github/ISSUE_TEMPLATE/release-upgrade-testing.md @@ -13,33 +13,32 @@ assignees: '' you change the filename. --> - - -## Pre-Release Demo Testing - Part of -This is testing: - -1. That upgrades from the outgoing _stable_ release to the new release of the operators and products do - not negatively impact the products. -2. That the new release demos work as documented from scratch. +This is testing that the new release demos work as documented from scratch. > [!NOTE] -> Record any issues or anomalies during the process in a comment on this issue. +> Record the results (issues, anomalies, or success) during the process in a comment on this issue. > Eg: > -> ```plain +> ```md > :green_circle: **airflow-scheduled-job** > > The CRD had been updated and I needed to change the following in the manifest: > ... > ``` +> +> The following emojis can be used to indicate the status: +> +> - `hourglass`: In progress / waiting +> - `red_circle`: In progress with errors +> - `orange_circle`: Completed with minor issues or anomalies +> - `green_circle`: Completed without issues or errors + +## List of demos -Replace the items in the task lists below with the applicable Pull Requests (if any). +Replace the items in the lists below with the applicable Pull Requests (if any). Also put your +GitHub handle next to the demo to indicate a particular demo was picked up for testing. > [!NOTE] -> At this point, the new release docs are still versoined as _nightly_. +> At this point, the new release docs are still versioned as _nightly_. -```[tasklist] -### Testing Demos on Nightly - [ ] [airflow-scheduled-job](https://docs.stackable.tech/home/nightly/demos/airflow-scheduled-job) - [ ] [data-lakehouse-iceberg-trino-spark](https://docs.stackable.tech/home/nightly/demos/data-lakehouse-iceberg-trino-spark) - [ ] [end-to-end-security](https://docs.stackable.tech/home/nightly/demos/end-to-end-security) @@ -69,75 +66,10 @@ Replace the items in the task lists below with the applicable Pull Requests (if - [ ] [spark-k8s-anomaly-detection-taxi-data](https://docs.stackable.tech/home/nightly/demos/spark-k8s-anomaly-detection-taxi-data) - [ ] [trino-iceberg](https://docs.stackable.tech/home/nightly/demos/trino-iceberg) - [ ] [trino-taxi-data](https://docs.stackable.tech/home/nightly/demos/trino-taxi-data) -``` - -### Outgoing Stable to new YY.M Upgrade Testing Instructions - -These instructions are for deploying and completing the outgoing stable demo, and then -upgading operators, CRDs, and products to the nightly versions well as upgrading -the operators and CRDS. - - - -> [!TIP] -> Be sure to select the _stable_ docs version on . - -```shell -# Install demo (stable operators) for the stable release (YY.M). -# Until https://github.com/stackabletech/stackable-cockpit/issues/310 is merged, -# this will need to be done by pointing stackablectl to local files checked out -# from the outgoing stable release branch. -git checkout release-OUTGOING_STABLE -git pull -stackablectl --stack-file=stacks/stacks-v2.yaml --demo-file=demos/demos-v2.yaml demo install - -# --- IMPORTANT --- -# Run through the stable demo instructions (refer to the tasklist above). - -# Get a list of installed operators -stackablectl operator installed --output=plain - -# --- OPTIONAL --- -# Sometimes it is necessary to upgrade Helm charts. Look for other Helm Charts -# which might need updating. - -# First, see which charts are installed. You can ignore the stackable-operator -# charts, or anything that might have been installed outside of this demo. -helm list - -# Next, add the applicable Helm Chart repositories. For example: -helm repo add minio https://charts.min.io/ -helm repo add bitnami https://charts.bitnami.com/bitnami - -# Finally, upgrade the Charts to what is defined in `main`. -# For example: -helm upgrade minio minio/minio --version x.x.x -helm upgrade postgresql-hive bitnami/postgresql --version x.x.x -# --- OPTIONAL END --- - -# Uninstall operators for the stable release (OUTGOING_STABLE) -stackablectl release uninstall OUTGOING_STABLE - -# At this point, we assume release.yml has been updated with the new YY.M release. -# if it hasn't, you will need to point stackablectl at a locally updated file using --release-file - -# Update CRDs to nightly version (on release-YY.M) -# Repeat this for every operator used by the demo (use the list from the earlier step before deleting the operators) -kubectl replace -f https://raw.githubusercontent.com/stackabletech/commons-operator/release-YY.M/deploy/helm/commons-operator/crds/crds.yaml -kubectl replace -f https://raw.githubusercontent.com/stackabletech/...-operator/release-YY.M/deploy/helm/...-operator/crds/crds.yaml - -# Install new release operators (use the list from the earlier step before deleting the operators) -stackablectl operator install commons=YY.M ... - -# Optionally update the product versions in the CRDs (to the latest non-experimental version for the new release), e.g.: -kubectl patch hbaseclusters/hbase --type='json' -p='[{"op": "replace", "path": "/spec/image/productVersion", "value":"x.x.x"}]' # changed -``` -### YY.M from Scratch Testing Instructions +### YY.M.X from Scratch Testing Instructions -These instructions are for deploying and completing the YY.M demo from scratch. +These instructions are for deploying and completing the YY.M.X demo from scratch.