Skip to content
SHC Docs

shc uninstall

uninstall a deployment (full teardown; backs up first)

Uninstall a deployment: a safety backup, then a full teardown of its containers, data, block volumes, config and vault secrets.

A database or bucket it created on a provider deployment is dropped with it; --keep-data keeps them on the provider unless the plug’s cleanup was set (--var .cleanup=true), and --no-backup keeps its block volumes. The operation names each store dropped or kept. A later install under the same name is a new deployment and refuses while anything kept is there (X409440LEFTOV, X409440VOLKPL). shc recover -b with the uninstall’s safety backup brings the deployment back.

One install, update or uninstall changes a deployment at a time, on the whole cluster. A second one on a deployment another is still changing is refused, not queued, naming the operation in flight, its node and its start (X409953OPRRUN), and nothing is started or written; run it again once that one has ended. shc operation ls lists what is in flight. Operations on different deployments run in parallel.

The master tenant’s modules, keycloak, traefik, openobserve and postgres, are refused (X409167SYSUNI) naming the deployments that bind them, unless --force says to take one down anyway.

shc uninstall <stack> [flags]
-e, --environment string environment name (default: "prod", or "default" on an estate with no licence and no trial; $SHC_ENVIRONMENT and shc ctx -e override it, and the "master" tenant is always "default")
--force uninstall a module of the master tenant, leaving the deployments that bind it without their provider
-h, --help help for uninstall
--keep-data keep the databases and buckets the deployment created on its providers instead of dropping them, except a plug whose cleanup was set
--no-backup skip the safety backup taken before teardown and keep the deployment's block volumes
-q, --quiet suppress progress output
-y, --yes skip confirmation prompt
--config stringArray extra YAML config file to layer on top of auto-discovered config; repeatable, later files win
-d, --debug enable debug mode (default: $SHC_DEBUG)
--exclude string comma-separated dotted paths to drop
--fields string comma-separated columns/keys to show (and their order)
--filter string comma-separated dotted paths to keep (drops everything else)
-o, --output string output format: tty|text|json|yaml (default: $SHC_OUTPUT)
-s, --stack string stack name (default: $SHC_STACK)
-t, --tenant string tenant name (default: $SHC_TENANT)
-v, --verbose verbose output (default: $SHC_VERBOSE)
  • shc - Selfhosted Cloud CLI