Skip to content
SHC Docs

shc tenant add

add a tenant

Create a new tenant: filesystem tree, overlay network, and Keycloak realm. The realm’s first user is the person asking (the signed-in account, or the account that registered the cluster with the portal), created with a verified email, tenant:manage and no password until they set one in the console. When nobody is signed in, or with --admin-user or --admin-password, a named admin is created instead; its password is auto-generated and stored in the vault; retrieve it any time with shc vault get keycloak_admin_password -t <name>. Realm provisioning runs in the background and completes automatically.

shc tenant add <name> [flags]
--admin-password string explicit password for the admin user (default: auto-generated)
--admin-user string username for the auto-created admin user (default "admin")
-h, --help help for add
--no-admin skip auto-creating an admin user
--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)