Skip to content

Commit c187cff

Browse files
committed
add documentation
1 parent 70fd483 commit c187cff

2 files changed

Lines changed: 64 additions & 1 deletion

File tree

docs/modules/stackablectl/pages/commands/demo.adoc

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,4 +159,31 @@ $ stackablectl stacklets list
159159

160160
== Uninstalling a Demo
161161

162-
Currently, there is no support for uninstalling a demo again. However, this functionality will come soon.
162+
To uninstall a demo, you can run the following command, specifying the namespace the demo was installed in.
163+
164+
[source,console]
165+
----
166+
$ stackablectl demo uninstall trino-taxi-data -n <NAMESPACE>
167+
168+
----
169+
170+
[NOTE]
171+
====
172+
The uninstall command deletes the namespace the demo was installed in. Therefore it is not possible to uninstall demos in the `default` namespace.
173+
====
174+
175+
[WARNING]
176+
====
177+
Currently, some resources deployed by the demo are either still lingering after the deletion process or need to be deleted before running the uninstall command.
178+
179+
* All demos
180+
** MutatingWebhookConfiguration `restarter-sts-enricher.stackable.tech` is not deleted
181+
* end-to-end-security, argo-cd-git-ops, hbase-hdfs-load-cycling-data, jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data
182+
** ClusterroleBinding `hdfs-clusterrolebinding-nodes` is not deleted
183+
* argo-cd-git-ops
184+
** Delete the ArgoCD Applications `airflow`, `airflow-postgres`, `minio`, and `sealed-secrets`
185+
** Then you can delete the namespaces `stackable-airflow`, `minio`, and `sealed-secrets`
186+
** Delete the ArgoCD ApplicationSet `stackable-operators` and wait for ArgoCD to delete the Applications of that ApplicationSet
187+
** Only after deleting the above, run the `stackablectl demo uninstall` command, otherwise the deletion might get stuck
188+
** `*.argoproj.io` CRDs and `sealedsecrets.bitnami.com` CRD are not deleted
189+
====

docs/modules/stackablectl/pages/commands/stack.adoc

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,3 +89,39 @@ Installed stack logging
8989
Use "stackablectl operator installed" to display the installed operators
9090
Use "stackablectl stacklet list" to display the installed stacklets
9191
----
92+
93+
== Uninstalling a Stack
94+
95+
To uninstall a stack, you can run the following command, specifying the namespace the stack was installed in.
96+
97+
[source,console]
98+
----
99+
$ stackablectl stack uninstall logging -n <NAMESPACE>
100+
101+
----
102+
103+
[NOTE]
104+
====
105+
The uninstall command deletes the namespace the stack was installed in. Therefore it is not possible to uninstall stacks in the `default` namespace.
106+
====
107+
108+
[WARNING]
109+
====
110+
Currently, some resources deployed by the stack are either still lingering after the deletion process or need to be deleted before running the uninstall command.
111+
112+
* All stacks
113+
** MutatingWebhookConfiguration `restarter-sts-enricher.stackable.tech` is not deleted
114+
* argo-cd-git-ops, hdfs-hbase, jupyterhub-pyspark-hdfs
115+
** ClusterroleBinding `hdfs-clusterrolebinding-nodes` is not deleted
116+
* argo-cd-git-ops
117+
** Delete the ArgoCD Applications `airflow`, `airflow-postgres`, `minio`, and `sealed-secrets`
118+
** Then you can delete the namespaces `stackable-airflow`, `minio`, and `sealed-secrets`
119+
** Delete the ArgoCD ApplicationSet `stackable-operators` and wait for ArgoCD to delete the Applications of that ApplicationSet
120+
** Only after deleting the above, run the `stackablectl stack uninstall` command, otherwise the deletion might get stuck
121+
** `*.argoproj.io` CRDs and `sealedsecrets.bitnami.com` CRD are not deleted
122+
* monitoring
123+
** `*.monitoring.coreos.com` CRDs are not deleted
124+
* observability
125+
** Delete OpenTelemetryCollector `otel-collector-grpc-external` and `otel-collector-grpc`
126+
** Only after deleting the above, run the `stackablectl stack uninstall` command, otherwise the deletion might get stuck
127+
====

0 commit comments

Comments
 (0)