Skip to content

Commit 20400ab

Browse files
NickLarsenNZTechassi
NickLarsenNZ
and
Techassi
authored
chore: Add release-upgrade-testing tracking issue template (#136)
* chore: add release-upgrade-testing tracking issue template. Make existing templates consistent * Apply suggestions Co-authored-by: Techassi <git@techassi.dev> * Apply suggestions Co-authored-by: Techassi <git@techassi.dev> --------- Co-authored-by: Techassi <git@techassi.dev>
1 parent 507d02f commit 20400ab

File tree

3 files changed

+208
-19
lines changed

3 files changed

+208
-19
lines changed

‎.github/ISSUE_TEMPLATE/pre-release-chart-updates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Pre-Release Demo Chart Updates
33
about: This template can be used to track the Helm chart updates for all demos.
4-
title: "chore(tracking): Update Helm charts for XX.(X)X"
4+
title: "chore(tracking): Update Helm charts for YY.M.X"
55
labels: []
66
assignees: ''
77
---

‎.github/ISSUE_TEMPLATE/pre-release-nightly-testing.md renamed to ‎.github/ISSUE_TEMPLATE/pre-release-upgrade-testing.md

Lines changed: 48 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
---
2-
name: Pre-Release Demo Upgrade Testing from Stable to Nightly
2+
name: Pre-Release Demo and Upgrade Testing
33
about: |
4-
This template can be used to track the upgrade testing of demos from stable to nightly leading
5-
up to the next Stackable release
6-
title: "chore(tracking): Test demos on nightly versions for XX.(X)X"
4+
This template can be used to track the upgrade testing of demos from stable to
5+
nightly and nightly from scratch leading up to the next Stackable release.
6+
title: "chore(tracking): Test demos on nightly versions for YY.M.X"
77
labels: ['epic']
88
assignees: ''
99
---
1010

1111
<!--
12-
Make sure to update the link in '.github/ISSUE_TEMPLATE/release.md' when
12+
Make sure to update the link in 'stackabletech/issues/.github/ISSUE_TEMPLATE/release.md' when
1313
you change the filename.
1414
-->
1515

1616
<!--
1717
DO NOT REMOVE THIS COMMENT. It is intended for people who might copy/paste from the previous release issue.
18-
This was created by an issue template: https://github.com/stackabletech/issues/issues/new/choose.
18+
This was created by an issue template: https://github.com/stackabletech/demos/issues/new/choose.
1919
-->
2020

2121
## Pre-Release Demo Testing on Nightly
@@ -24,9 +24,9 @@ Part of <https://github.com/stackabletech/issues/issues/TRACKING_ISSUE>
2424

2525
This is testing:
2626

27-
1. The demos documented in nightly (with the updated product versions) still work.
28-
2. That the operators can be upgraded from the current release to the nightly release and do not
29-
negatively impact the products.
27+
1. That upgrades from the _stable_ release to the _nightly_ release of the operators and products do
28+
not negatively impact the products.
29+
2. That _nightly_ demos work as documented from scratch.
3030

3131
> [!NOTE]
3232
> Record any issues or anomalies during the process in a comment on this issue.
@@ -67,24 +67,30 @@ Replace the items in the task lists below with the applicable Pull Requests (if
6767
- [ ] [trino-taxi-data](https://docs.stackable.tech/home/nightly/demos/trino-taxi-data)
6868
```
6969
70-
### Testing Instructions
70+
### Stable to Nightly Upgrade Testing Instructions
7171

72-
These instructions are for deploying the nightly demo, as well as upgrading the operators and CRDS.
72+
These instructions are for deploying and completing the stable demo, and then
73+
upgading operators, CRDs, and products to the nightly versions well as upgrading
74+
the operators and CRDS.
7375

7476
<!--
7577
Make sure to update the version mentioned below when creating the issue.
7678
-->
7779

80+
> [!TIP]
81+
> Be sure to select the _stable_ docs version on <https://docs.stackable.tech/home/stable/demos/>.
82+
7883
```shell
79-
# Install demo (stable operators) for the previous release (24.7)
80-
# For now, we have to deploy from the release branch, otherwise we get new changes.
81-
# Stackablectl doesn't yet support deploying a demo from a branch
82-
git checkout release-24.7
84+
# Install demo (stable operators) for the stable release (YY.M).
85+
# Until https://github.com/stackabletech/stackable-cockpit/issues/310 is merged,
86+
# this will need to be done by pointing stackablectl to local files checked out
87+
# from the stable release branch.
88+
git checkout release-YY.M
8389
git pull
8490
stackablectl --stack-file=stacks/stacks-v2.yaml --demo-file=demos/demos-v2.yaml demo install <DEMO_NAME>
8591

8692
# --- IMPORTANT ---
87-
# Run through the nightly demo instructions (refer to the tasklist below).
93+
# Run through the stable demo instructions (refer to the tasklist above).
8894

8995
# Get a list of installed operators
9096
stackablectl operator installed --output=plain
@@ -107,8 +113,8 @@ helm upgrade minio minio/minio --version x.x.x
107113
helm upgrade postgresql-hive bitnami/postgresql --version x.x.x
108114
# --- OPTIONAL END ---
109115

110-
# Uninstall operators
111-
stackablectl release uninstall 24.7
116+
# Uninstall operators for the stable release (YY.M)
117+
stackablectl release uninstall YY.M
112118

113119
# Update CRDs to nightly version (on main)
114120
# Repeat this for every operator used by the demo (use the list from the earlier step before deleting the operators)
@@ -121,3 +127,27 @@ stackablectl operator install commons ...
121127
# Optionally update the product versions in the CRDs (to the latest non-experimental version for the new release), e.g.:
122128
kubectl patch hbaseclusters/hbase --type='json' -p='[{"op": "replace", "path": "/spec/image/productVersion", "value":"x.x.x"}]' # changed
123129
```
130+
131+
### Nightly from Scratch Testing Instructions
132+
133+
These instructions are for deploying and completing the nightly demo from scratch.
134+
135+
<!--
136+
Make sure to update the version mentioned below when creating the issue.
137+
-->
138+
139+
> [!TIP]
140+
> Be sure to select the _nightly_ docs version on <https://docs.stackable.tech/home/nightly/demos/>.
141+
142+
```shell
143+
# Install demo (stable operators) for the nightly release.
144+
# Until https://github.com/stackabletech/stackable-cockpit/issues/310 is merged,
145+
# this will need to be done by pointing stackablectl to local files checked out
146+
# from the main branch.
147+
git checkout main
148+
git pull
149+
stackablectl --stack-file=stacks/stacks-v2.yaml --demo-file=demos/demos-v2.yaml demo install <DEMO_NAME>
150+
151+
# --- IMPORTANT ---
152+
# Run through the nightly demo instructions (refer to the tasklist above).
153+
```

‎.github/ISSUE_TEMPLATE/release-upgrade-testing.md

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
---
2+
name: Release Demo and Upgrade Testing
3+
about: |
4+
This template can be used to track the upgrade testing of demos from the outgoing stable to
5+
the new release, and new release from scratch before officially marking the new release as stable.
6+
title: "chore(tracking): Test demos on nightly versions for YY.M.X"
7+
labels: ['epic']
8+
assignees: ''
9+
---
10+
11+
<!--
12+
Make sure to update the link in 'stackabletech/issues/.github/ISSUE_TEMPLATE/release.md' when
13+
you change the filename.
14+
-->
15+
16+
<!--
17+
DO NOT REMOVE THIS COMMENT. It is intended for people who might copy/paste from the previous release issue.
18+
This was created by an issue template: https://github.com/stackabletech/demos/issues/new/choose.
19+
-->
20+
21+
## Pre-Release Demo Testing
22+
23+
Part of <https://github.com/stackabletech/issues/issues/TRACKING_ISSUE>
24+
25+
This is testing:
26+
27+
1. That upgrades from the outgoing _stable_ release to the new release of the operators and products do
28+
not negatively impact the products.
29+
2. That the new release demos work as documented from scratch.
30+
31+
> [!NOTE]
32+
> Record any issues or anomalies during the process in a comment on this issue.
33+
> Eg:
34+
>
35+
> ```plain
36+
> :green_circle: **airflow-scheduled-job**
37+
>
38+
> The CRD had been updated and I needed to change the following in the manifest:
39+
> ...
40+
> ```
41+
42+
Replace the items in the task lists below with the applicable Pull Requests (if any).
43+
44+
<!--
45+
The following list was generated by:
46+
47+
# go to the demos repository, then run:
48+
yq '.demos | keys' demos/demos-v2.yaml \
49+
| sed -e 's/- //g' \
50+
| sort \
51+
| xargs -I {} echo "- [ ] [{}](https://docs.stackable.tech/home/nightly/demos/{})"
52+
-->
53+
54+
> [!NOTE]
55+
> At this point, the new release docs are still versoined as _nightly_.
56+
57+
```[tasklist]
58+
### Testing Demos on Nightly
59+
- [ ] [airflow-scheduled-job](https://docs.stackable.tech/home/nightly/demos/airflow-scheduled-job)
60+
- [ ] [data-lakehouse-iceberg-trino-spark](https://docs.stackable.tech/home/nightly/demos/data-lakehouse-iceberg-trino-spark)
61+
- [ ] [end-to-end-security](https://docs.stackable.tech/home/nightly/demos/end-to-end-security)
62+
- [ ] [hbase-hdfs-load-cycling-data](https://docs.stackable.tech/home/nightly/demos/hbase-hdfs-load-cycling-data)
63+
- [ ] [jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data](https://docs.stackable.tech/home/nightly/demos/jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data)
64+
- [ ] [logging](https://docs.stackable.tech/home/nightly/demos/logging)
65+
- [ ] [nifi-kafka-druid-earthquake-data](https://docs.stackable.tech/home/nightly/demos/nifi-kafka-druid-earthquake-data)
66+
- [ ] [nifi-kafka-druid-water-level-data](https://docs.stackable.tech/home/nightly/demos/nifi-kafka-druid-water-level-data)
67+
- [ ] [signal-processing](https://docs.stackable.tech/home/nightly/demos/signal-processing)
68+
- [ ] [spark-k8s-anomaly-detection-taxi-data](https://docs.stackable.tech/home/nightly/demos/spark-k8s-anomaly-detection-taxi-data)
69+
- [ ] [trino-iceberg](https://docs.stackable.tech/home/nightly/demos/trino-iceberg)
70+
- [ ] [trino-taxi-data](https://docs.stackable.tech/home/nightly/demos/trino-taxi-data)
71+
```
72+
73+
### Outgoing Stable to new YY.M Upgrade Testing Instructions
74+
75+
These instructions are for deploying and completing the outgoing stable demo, and then
76+
upgading operators, CRDs, and products to the nightly versions well as upgrading
77+
the operators and CRDS.
78+
79+
<!--
80+
Make sure to update the YY.M.X and YY.M versions mentioned below when creating the issue.
81+
-->
82+
83+
> [!TIP]
84+
> Be sure to select the _stable_ docs version on <https://docs.stackable.tech/home/stable/demos/>.
85+
86+
```shell
87+
# Install demo (stable operators) for the stable release (YY.M).
88+
# Until https://github.com/stackabletech/stackable-cockpit/issues/310 is merged,
89+
# this will need to be done by pointing stackablectl to local files checked out
90+
# from the outgoing stable release branch.
91+
git checkout release-OUTGOING_STABLE
92+
git pull
93+
stackablectl --stack-file=stacks/stacks-v2.yaml --demo-file=demos/demos-v2.yaml demo install <DEMO_NAME>
94+
95+
# --- IMPORTANT ---
96+
# Run through the stable demo instructions (refer to the tasklist above).
97+
98+
# Get a list of installed operators
99+
stackablectl operator installed --output=plain
100+
101+
# --- OPTIONAL ---
102+
# Sometimes it is necessary to upgrade Helm charts. Look for other Helm Charts
103+
# which might need updating.
104+
105+
# First, see which charts are installed. You can ignore the stackable-operator
106+
# charts, or anything that might have been installed outside of this demo.
107+
helm list
108+
109+
# Next, add the applicable Helm Chart repositories. For example:
110+
helm repo add minio https://charts.min.io/
111+
helm repo add bitnami https://charts.bitnami.com/bitnami
112+
113+
# Finally, upgrade the Charts to what is defined in `main`.
114+
# For example:
115+
helm upgrade minio minio/minio --version x.x.x
116+
helm upgrade postgresql-hive bitnami/postgresql --version x.x.x
117+
# --- OPTIONAL END ---
118+
119+
# Uninstall operators for the stable release (OUTGOING_STABLE)
120+
stackablectl release uninstall OUTGOING_STABLE
121+
122+
# At this point, we assume release.yml has been updated with the new YY.M release.
123+
# if it hasn't, you will need to point stackablectl at a locally updated file using --release-file
124+
125+
# Update CRDs to nightly version (on release-YY.M)
126+
# Repeat this for every operator used by the demo (use the list from the earlier step before deleting the operators)
127+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/commons-operator/release-YY.M/deploy/helm/commons-operator/crds/crds.yaml
128+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/...-operator/release-YY.M/deploy/helm/...-operator/crds/crds.yaml
129+
130+
# Install new release operators (use the list from the earlier step before deleting the operators)
131+
stackablectl operator install commons=YY.M ...
132+
133+
# Optionally update the product versions in the CRDs (to the latest non-experimental version for the new release), e.g.:
134+
kubectl patch hbaseclusters/hbase --type='json' -p='[{"op": "replace", "path": "/spec/image/productVersion", "value":"x.x.x"}]' # changed
135+
```
136+
137+
### YY.M from Scratch Testing Instructions
138+
139+
These instructions are for deploying and completing the YY.M demo from scratch.
140+
141+
<!--
142+
Make sure to update the version mentioned below when creating the issue.
143+
-->
144+
145+
> [!TIP]
146+
> Be sure to select the _nightly_ docs version on <https://docs.stackable.tech/home/nightly/demos/>.
147+
148+
```shell
149+
# Install demo (stable operators) for the nightly release.
150+
# Until https://github.com/stackabletech/stackable-cockpit/issues/310 is merged,
151+
# this will need to be done by pointing stackablectl to local files checked out
152+
# from the release-YY.M branch.
153+
git checkout release-YY.M
154+
git pull
155+
stackablectl --stack-file=stacks/stacks-v2.yaml --demo-file=demos/demos-v2.yaml demo install <DEMO_NAME>
156+
157+
# --- IMPORTANT ---
158+
# Run through the nightly demo instructions (refer to the tasklist above).
159+
```

0 commit comments

Comments
 (0)