Skip to content

Commit bc6999b

Browse files
committed
chore: Add upgrade instructions to release template
1 parent 196bb71 commit bc6999b

File tree

1 file changed

+121
-0
lines changed

1 file changed

+121
-0
lines changed

modules/ROOT/partials/release-notes/release-template.adoc

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,127 @@ Of the changes mentioned above, the following are breaking (or could lead to bre
6565

6666
===== Using stackablectl
6767

68+
Uninstall the `OO.M` release
69+
70+
[source,console]
71+
----
72+
$ stackablectl release uninstall OO.M
73+
74+
Uninstalled release 'OO.M'
75+
76+
Use "stackablectl release list" to list available releases.
77+
# ...
78+
----
79+
80+
Afterwards you will need to upgrade the CustomResourceDefinitions (CRDs) installed by the Stackable Platform.
81+
The reason for this is that helm will uninstall the operators but not the CRDs.
82+
This can be done using `kubectl replace`.
83+
84+
[source]
85+
----
86+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/airflow-operator/OO.M.X/deploy/helm/airflow-operator/crds/crds.yaml
87+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/commons-operator/OO.M.X/deploy/helm/commons-operator/crds/crds.yaml
88+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/druid-operator/OO.M.X/deploy/helm/druid-operator/crds/crds.yaml
89+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hbase-operator/OO.M.X/deploy/helm/hbase-operator/crds/crds.yaml
90+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hdfs-operator/OO.M.X/deploy/helm/hdfs-operator/crds/crds.yaml
91+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hive-operator/OO.M.X/deploy/helm/hive-operator/crds/crds.yaml
92+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/kafka-operator/OO.M.X/deploy/helm/kafka-operator/crds/crds.yaml
93+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/listener-operator/OO.M.X/deploy/helm/listener-operator/crds/crds.yaml
94+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/nifi-operator/OO.M.X/deploy/helm/nifi-operator/crds/crds.yaml
95+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/opa-operator/OO.M.X/deploy/helm/opa-operator/crds/crds.yaml
96+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/secret-operator/OO.M.X/deploy/helm/secret-operator/crds/crds.yaml
97+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/spark-k8s-operator/OO.M.X/deploy/helm/spark-k8s-operator/crds/crds.yaml
98+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/superset-operator/OO.M.X/deploy/helm/superset-operator/crds/crds.yaml
99+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/trino-operator/OO.M.X/deploy/helm/trino-operator/crds/crds.yaml
100+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/zookeeper-operator/OO.M.X/deploy/helm/zookeeper-operator/crds/crds.yaml
101+
----
102+
103+
[source,console]
104+
----
105+
customresourcedefinition.apiextensions.k8s.io "airflowclusters.airflow.stackable.tech" replaced
106+
customresourcedefinition.apiextensions.k8s.io "airflowdbs.airflow.stackable.tech" replaced
107+
customresourcedefinition.apiextensions.k8s.io "authenticationclasses.authentication.stackable.tech" replaced
108+
customresourcedefinition.apiextensions.k8s.io "s3connections.s3.stackable.tech" replaced
109+
...
110+
----
111+
112+
Install the `YY.M` release
113+
114+
[source,console]
115+
----
116+
$ stackablectl release install YY.M
117+
118+
Installed release 'YY.M'
119+
120+
Use "stackablectl operator installed" to list installed operators.
121+
----
122+
68123
===== Using Helm
69124

125+
Use `helm list` to list the currently installed operators.
126+
127+
You can use the following command to uninstall all operators that are part of the `OO.M` release:
128+
129+
[source,console]
130+
----
131+
$ helm uninstall airflow-operator commons-operator druid-operator hbase-operator hdfs-operator hive-operator kafka-operator listener-operator nifi-operator opa-operator secret-operator spark-k8s-operator superset-operator trino-operator zookeeper-operator
132+
release "airflow-operator" uninstalled
133+
release "commons-operator" uninstalled
134+
...
135+
----
136+
137+
Afterward you will need to upgrade the CustomResourceDefinitions (CRDs) installed by the Stackable Platform.
138+
The reason for this is that helm will uninstall the operators but not the CRDs. This can be done using `kubectl replace`:
139+
140+
[source]
141+
----
142+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/airflow-operator/OO.M.X/deploy/helm/airflow-operator/crds/crds.yaml
143+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/commons-operator/OO.M.X/deploy/helm/commons-operator/crds/crds.yaml
144+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/druid-operator/OO.M.X/deploy/helm/druid-operator/crds/crds.yaml
145+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hbase-operator/OO.M.X/deploy/helm/hbase-operator/crds/crds.yaml
146+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hdfs-operator/OO.M.X/deploy/helm/hdfs-operator/crds/crds.yaml
147+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/hive-operator/OO.M.X/deploy/helm/hive-operator/crds/crds.yaml
148+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/kafka-operator/OO.M.X/deploy/helm/kafka-operator/crds/crds.yaml
149+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/listener-operator/OO.M.X/deploy/helm/listener-operator/crds/crds.yaml
150+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/nifi-operator/OO.M.X/deploy/helm/nifi-operator/crds/crds.yaml
151+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/opa-operator/OO.M.X/deploy/helm/opa-operator/crds/crds.yaml
152+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/secret-operator/OO.M.X/deploy/helm/secret-operator/crds/crds.yaml
153+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/spark-k8s-operator/OO.M.X/deploy/helm/spark-k8s-operator/crds/crds.yaml
154+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/superset-operator/OO.M.X/deploy/helm/superset-operator/crds/crds.yaml
155+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/trino-operator/OO.M.X/deploy/helm/trino-operator/crds/crds.yaml
156+
kubectl replace -f https://raw.githubusercontent.com/stackabletech/zookeeper-operator/OO.M.X/deploy/helm/zookeeper-operator/crds/crds.yaml
157+
----
158+
159+
[source,console]
160+
----
161+
customresourcedefinition.apiextensions.k8s.io "airflowclusters.airflow.stackable.tech" replaced
162+
customresourcedefinition.apiextensions.k8s.io "airflowdbs.airflow.stackable.tech" replaced
163+
customresourcedefinition.apiextensions.k8s.io "authenticationclasses.authentication.stackable.tech" replaced
164+
customresourcedefinition.apiextensions.k8s.io "s3connections.s3.stackable.tech" replaced
165+
...
166+
----
167+
168+
Install the `YY.M` release
169+
170+
[source,console]
171+
----
172+
helm repo add stackable-stable https://repo.stackable.tech/repository/helm-stable/
173+
helm repo update stackable-stable
174+
helm install --wait airflow-operator stackable-stable/airflow-operator --version OO.M.X
175+
helm install --wait commons-operator stackable-stable/commons-operator --version OO.M.X
176+
helm install --wait druid-operator stackable-stable/druid-operator --version OO.M.X
177+
helm install --wait hbase-operator stackable-stable/hbase-operator --version OO.M.X
178+
helm install --wait hdfs-operator stackable-stable/hdfs-operator --version OO.M.X
179+
helm install --wait hive-operator stackable-stable/hive-operator --version OO.M.X
180+
helm install --wait kafka-operator stackable-stable/kafka-operator --version OO.M.X
181+
helm install --wait listener-operator stackable-stable/listener-operator --version OO.M.X
182+
helm install --wait nifi-operator stackable-stable/nifi-operator --version OO.M.X
183+
helm install --wait opa-operator stackable-stable/opa-operator --version OO.M.X
184+
helm install --wait secret-operator stackable-stable/secret-operator --version OO.M.X
185+
helm install --wait spark-k8s-operator stackable-stable/spark-k8s-operator --version OO.M.X
186+
helm install --wait superset-operator stackable-stable/superset-operator --version OO.M.X
187+
helm install --wait trino-operator stackable-stable/trino-operator --version OO.M.X
188+
helm install --wait zookeeper-operator stackable-stable/zookeeper-operator --version OO.M.X
189+
----
190+
70191
==== Known issues

0 commit comments

Comments
 (0)