From f09d8b6751720db6cf9008df4b93b5c4df9d4c0a Mon Sep 17 00:00:00 2001 From: Pascal Sthamer <10992664+P4sca1@users.noreply.github.com> Date: Wed, 19 Feb 2025 12:37:03 +0100 Subject: [PATCH] add usage and uninstallation information Signed-off-by: Pascal Sthamer <10992664+P4sca1@users.noreply.github.com> --- charts/shuffle/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/charts/shuffle/README.md b/charts/shuffle/README.md index 8667ed8d..7241c640 100644 --- a/charts/shuffle/README.md +++ b/charts/shuffle/README.md @@ -21,6 +21,21 @@ SPDX-License-Identifier: APACHE-2.0 helm install shuffle oci://ghcr.io/shuffle/shuffle/charts/shuffle --namespace shuffle --create-namespace ``` +Make sure that no other application is deployed to the shuffle namespace, as shuffle deletes kubernetes resources in this namespace. + +Only a single deployment of shuffle is supported per namespace. + +## Uninstallation + +```sh +# Uninstall shuffle via helm +helm uninstall shuffle --namespace shuffle + +# Remove additional resources created by shuffle (such as workers and apps) +kubectl delete svc --namespace shuffle -l "app.kubernetes.io/managed-by in (shuffle-orborus,shuffle-worker)" +kubectl delete deploy --namespace shuffle -l "app.kubernetes.io/managed-by in (shuffle-orborus,shuffle-worker)" +``` + ## Secret Parameters The helm chart was designed to not contain any secret data and does not allow configuring secret data using helm values.