diff --git a/.github/ISSUE_TEMPLATE/pre-release-demos-nightly.md b/.github/ISSUE_TEMPLATE/pre-release-demos-nightly.md index 0b027a7..c32f0c9 100644 --- a/.github/ISSUE_TEMPLATE/pre-release-demos-nightly.md +++ b/.github/ISSUE_TEMPLATE/pre-release-demos-nightly.md @@ -8,7 +8,7 @@ assignees: '' + +```[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-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) +``` + +
+Instructions + +These instructions are for deploying the nightly demo, as well as upgrading the operators and CRDS. + ```shell -# Install demo (stable) +# Install demo (stable operators) stackablectl demo install +# --- IMPORTANT --- +# Run through the nightly demo instructions (refer to the tasklist below). + # Get a list of installed operators stackablectl operator installed --output=plain @@ -70,31 +117,6 @@ stackablectl operator install commons ... # Optionally update the product versions in the CRDs, e.g.: kubectl patch hbaseclusters/hbase --type='json' -p='[{"op": "replace", "path": "/spec/image/productVersion", "value":"x.x.x"}]' # changed - ``` - - -```[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-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) -``` +
diff --git a/.github/ISSUE_TEMPLATE/pre-release-getting-started-scripts.md b/.github/ISSUE_TEMPLATE/pre-release-getting-started-scripts.md index de58bc2..928e998 100644 --- a/.github/ISSUE_TEMPLATE/pre-release-getting-started-scripts.md +++ b/.github/ISSUE_TEMPLATE/pre-release-getting-started-scripts.md @@ -58,29 +58,30 @@ Replace the items in the task lists below with the applicable Pull Requests (if ```[tasklist] ### Getting Started Script Checks and Updates -- [ ] [Update getting-started script for airflow-operator](https://github.com/stackabletech/airflow-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7) -- [ ] [Update getting-started script for commons-operator](https://github.com/stackabletech/commons-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7) -- [ ] [Update getting-started script for druid-operator](https://github.com/stackabletech/druid-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7) -- [ ] [Update getting-started script for edc-operator](https://github.com/stackabletech/edc-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7) -- [ ] [Update getting-started script for hbase-operator](https://github.com/stackabletech/hbase-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7) -- [ ] [Update getting-started script for hdfs-operator](https://github.com/stackabletech/hdfs-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7) -- [ ] [Update getting-started script for hello-world-operator](https://github.com/stackabletech/hello-world-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7) -- [ ] [Update getting-started script for hive-operator](https://github.com/stackabletech/hive-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7) -- [ ] [Update getting-started script for kafka-operator](https://github.com/stackabletech/kafka-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7) -- [ ] [Update getting-started script for listener-operator](https://github.com/stackabletech/listener-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7) -- [ ] [Update getting-started script for nifi-operator](https://github.com/stackabletech/nifi-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7) -- [ ] [Update getting-started script for opa-operator](https://github.com/stackabletech/opa-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7) -- [ ] [Update getting-started script for secret-operator](https://github.com/stackabletech/secret-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7) -- [ ] [Update getting-started script for spark-k8s-operator](https://github.com/stackabletech/spark-k8s-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7) -- [ ] [Update getting-started script for superset-operator](https://github.com/stackabletech/superset-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7) -- [ ] [Update getting-started script for trino-operator](https://github.com/stackabletech/trino-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7) -- [ ] [Update getting-started script for zookeeper-operator](https://github.com/stackabletech/zookeeper-operator/compare/main..fix/getting-started-pre-24.7?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.7) +- [ ] [Update getting-started script for airflow-operator](https://github.com/stackabletech/airflow-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11) +- [ ] [Update getting-started script for commons-operator](https://github.com/stackabletech/commons-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11) +- [ ] [Update getting-started script for druid-operator](https://github.com/stackabletech/druid-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11) +- [ ] [Update getting-started script for edc-operator](https://github.com/stackabletech/edc-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11) +- [ ] [Update getting-started script for hbase-operator](https://github.com/stackabletech/hbase-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11) +- [ ] [Update getting-started script for hdfs-operator](https://github.com/stackabletech/hdfs-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11) +- [ ] [Update getting-started script for hello-world-operator](https://github.com/stackabletech/hello-world-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11) +- [ ] [Update getting-started script for hive-operator](https://github.com/stackabletech/hive-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11) +- [ ] [Update getting-started script for kafka-operator](https://github.com/stackabletech/kafka-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11) +- [ ] [Update getting-started script for listener-operator](https://github.com/stackabletech/listener-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11) +- [ ] [Update getting-started script for nifi-operator](https://github.com/stackabletech/nifi-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11) +- [ ] [Update getting-started script for opa-operator](https://github.com/stackabletech/opa-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11) +- [ ] [Update getting-started script for secret-operator](https://github.com/stackabletech/secret-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11) +- [ ] [Update getting-started script for spark-k8s-operator](https://github.com/stackabletech/spark-k8s-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11) +- [ ] [Update getting-started script for superset-operator](https://github.com/stackabletech/superset-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11) +- [ ] [Update getting-started script for trino-operator](https://github.com/stackabletech/trino-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11) +- [ ] [Update getting-started script for zookeeper-operator](https://github.com/stackabletech/zookeeper-operator/compare/main...fix/getting-started-pre-24.11?quick_pull=1&template=pre-release-getting-started-script.md&title=fix%28docs%29%3A+Update+getting-started+script+pre-24.11) ``` diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index bd55ac6..dffbf2e 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.github/ISSUE_TEMPLATE/release.md @@ -1,7 +1,7 @@ --- -name: Release -about: This template can be used to track the release process at Stackable -title: Release XX.(X)X +name: Release Tracking +about: This template can be used to track the progress of the SDP +title: "chore(tracking): Release SDP XX.(X)X" labels: ['epic'] assignees: '' @@ -16,22 +16,43 @@ assignees: '' > [!IMPORTANT] > Important dates: -> - +> - ... - Release planning +> - ... - Lock product versions +> - ... - Target release date ## Release checklists +Replace the items in the task lists below with the applicable Pull Requests / Issues + +### General Pre-Requisites (before Feature Freeze) + +> [!TIP] +> These tasks should be done earlier in the process to lessen the burden at Pre-release time. + ```[tasklist] -### General pre-requisites (before feature freeze) -- [ ] Bump operator-rs to latest version in all operators. This should be done early in the release cycle to leave sufficient time for testing etc. -- [ ] Check Rust and e.g. cargo deps versions -- [ ] Run/check getting-started scripts -- [ ] Run/check demos with dev release and main branch and create draft PR for release-related changes -- [ ] Update demo docs and screenshots +### Early Pre-release tasks +- [ ] [Update and release operator-rs workspace members](https://github.com/stackabletech/operator-rs/issues/new?template=release-workspace-members.md) +- [ ] [Update Rust toolchain of operators](https://github.com/stackabletech/operator-templating/issues/new?template=pre-release.md) +- [ ] [Update Rust dependencies of operators](https://github.com/stackabletech/issues/issues/new?template=pre-release-operator-rust-deps.md) +- [ ] [Update Container Images](https://github.com/stackabletech/docker-images/issues/new?template=pre-release.md) +``` + +> [!TIP] +> These tasks should be done a week or so before the release date. + +```[tasklist] +### Pre-release +- [ ] Run all of the test suites in Jenkins (with all product versions, not just "nightly") +- [ ] [Check and update getting-started script](https://github.com/stackabletech/issues/issues/new?template=pre-release-getting-started-scripts.md) +- [ ] [Test and update demos stable to nightly](https://github.com/stackabletech/issues/issues/new?template=pre-release-demos-nightly.md) - [ ] Ensure integration tests are successful on OpenShift -- [ ] Test SDP release upgrade against several demos (i.e. install release, run demo, bump release, check what needs to be patched) -- [ ] Run all of the test suites (with all product versions, not just "nightly") +- [ ] Check stackable-utils scripts in dry-run mode work ``` +### Other Pre-Requisites (before Feature Freeze) + +Search for open issues labeleded with [`scheduled-for/20XX-X`](https://github.com/search?q=org%3Astackabletech+label%3Ascheduled-for%2F20XX-X&type=issues&state=open) + ```[tasklist] ### Other release-specific pre-requisites - [ ] ... @@ -45,20 +66,18 @@ This will not be so crucial with release branches, but is nonetheless sensible a ```[tasklist] #### Technical tasks -- [ ] Test stackable-utils scripts in dry-run mode (this can be done a week or so before the release) - [ ] Temporarily remove branch protection before pushing the release branches/tags - [ ] Create release branches for docker-images (see stackable-utils for script to create branches) - [ ] Create release tag(s) for docker-images (see stackable-utils for scripts to create tags) - [ ] Create release branches for operators (see stackable-utils for script to create branches) - [ ] Create release tag(s) for operators (see stackable-utils for scripts to create tags) - [ ] Create release tag for stackable-cockpit (optional, highly experimental, requires manual tag creation) -- [ ] Update changelogs in main branches (see stackable-utils for script to do this) +- [ ] Update release version in changelogs on main branches (see stackable-utils for script to do this) - [ ] Generate CRD docs [website](https://crds.stackable.tech/) for the new release by following these [instructions](https://github.com/stackabletech/crddocs) -- [ ] Check (selected) integration tests -- [ ] Check getting started scripts (use a table in Nuclino) -- [ ] Run/check getting-started scripts -- [ ] Run/check demos with dev release and main branch and create draft PR for release-related changes -- [ ] Test with locally updated (to new release number) `releases.yaml` +- [ ] Check (selected) integration tests on the new release branches +- [ ] Run/Check getting started scripts, ensure image pulls for the release works +- [ ] Run/Check demos with dev release and main branch and create draft PR for release-related changes +- [ ] Test `stackablectl` with locally updated (to new release number) `releases.yaml` - [ ] Update `release.yaml` in https://github.com/stackabletech/release/blob/main/releases.yaml - [ ] Check that an upgrade can be performed on an existing cluster without data loss. - [ ] Run all of the test suites @@ -73,7 +92,8 @@ This will not be so crucial with release branches, but is nonetheless sensible a - [ ] Upgrade guide: List dropped supported product versions (if there are some) - [ ] Upgrade guide: List dropped supported operators (if there are some) - [ ] Upgrade guide: List supported k8s versions -- [ ] Update version of main documentation repo +- [ ] Update version of main documentation repo (antora.yml on the release branch) +- [ ] Update SDP release version in documentation/modules/ROOT/pages/getting-started.adoc - [ ] Set the release to "Released" in the Feature Tracker and create a new release - [ ] Update the getting-started page in the main docs and check it works with this release: https://github.com/stackabletech/documentation/blob/main/modules/ROOT/pages/getting-started.adoc ```