Skip to content
SHC Docs

shc portal deregister

withdraw this cluster’s Portal registration

Withdraw this cluster’s Portal registration. Four things happen and each one alone is enough to end the relationship: the agent key is deleted from the vault, the registration row is tombstoned, the portal is told so this cluster’s public key stops authenticating, and the vendor IdP is removed from the master realm.

--local does all of that without contacting the portal, and cannot be made to fail by the portal being unreachable. An estate must be able to sever unilaterally, including from a vendor that is down, gone, or the thing you are severing from.

shc portal deregister [flags]
-h, --help help for deregister
--local sever without contacting the portal, since an estate must be able to leave unilaterally
--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)
-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")
--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 portal - register this cluster with the Selfhosted Cloud Portal