Tenant Management
Onboard a workload team onto a shared cluster without hand-writing RBAC. ksail tenant create scaffolds
a tenant — a namespace, scoped RBAC, and the GitOps sync resources that point at the team’s manifests —
into your platform repository; ksail tenant delete removes it again. The generated scaffolding lives in
the platform repo, so onboarding a tenant is a reviewable change like any other.
The pattern
Section titled “The pattern”The recommended real-world setup keeps platform and tenants in separate repositories. Each team owns
its own repo and publishes its manifests as a versioned OCI artifact; the platform registers the team by
pointing a GitOps source at that artifact. The scaffolding ksail tenant create writes is exactly that
registration:
edit platform/ ──► ksail tenant create ──► GitOps source points at ──► tenant publishes (your repo) (namespace + RBAC + the tenant's OCI artifact its own artifact sync resources) (their repo)Isolation is layered, and the generated manifests give you each layer:
- Namespace per tenant — the boundary everything else scopes to.
- RBAC — a ServiceAccount and RoleBinding scoped to that namespace, never cluster-wide.
- A network floor (opt-in, see Production-ready tenants) — a default-deny NetworkPolicy with DNS and intra-namespace allow rules that the tenant extends with its own allow-lists.
Tenant types
Section titled “Tenant types”| Type | RBAC | GitOps sync resources | Requires GitOps engine |
|---|---|---|---|
flux | ✓ | OCIRepository / GitRepository + Kustomization | Flux |
argocd | ✓ | AppProject + Application | ArgoCD |
kubectl | ✓ | None | No |
The --type flag defaults to auto-detect from ksail.yaml gitOpsEngine.
Onboard a tenant
Section titled “Onboard a tenant”-
Scaffold the tenant into your platform repo.
--typeauto-detects fromksail.yaml:Terminal window # Auto-detect type (reads gitOpsEngine from ksail.yaml)ksail tenant create my-team --output platform/tenants/# Or pin the type, namespaces, and bound ClusterRole explicitlyksail tenant create my-team --output platform/tenants/ \--type flux \--namespace my-team --namespace my-team-staging \--cluster-role viewNamespaces default to the tenant name; the bound ClusterRole defaults to
edit. The command writes:platform/tenants/my-team/├── kustomization.yaml├── namespace.yaml├── serviceaccount.yaml├── rolebinding.yaml└── (flux or argocd sync resources if applicable) -
Register it in the platform’s
kustomization.yamlso GitOps picks it up.--registerappends the tenant to the nearestkustomization.yamlfor you:Terminal window ksail tenant create my-team --output platform/tenants/ --register -
Apply or ship it (see Apply tenant manifests for the GitOps path).
Deliver via pull request
Section titled “Deliver via pull request”Use --delivery pr to open the platform change as a pull request instead of writing it to your working
tree. The platform repo is auto-detected from the local git remote origin:
ksail tenant create my-team --register --delivery pr \ --git-provider githubOverride the repo with --platform-repo and the PR target with --target-branch (defaults to the repo’s
default branch):
ksail tenant create my-team --register --delivery pr \ --git-provider github \ --platform-repo my-org/platform-repo \ --target-branch developFlux tenants
Section titled “Flux tenants”For Flux tenants, point the sync source at the tenant’s published artifact. OCI is the default and the recommended pattern — the tenant publishes manifests as an OCI artifact and the platform registers an OCIRepository against it:
# OCI source (default)ksail tenant create my-team --type flux \ --sync-source oci \ --registry oci://ghcr.io \ --tenant-repo my-org/my-team
# OCI source with a path suffix (avoids tag collisions when Docker images and# Kubernetes manifests are published to the same registry path)ksail tenant create my-team --type flux \ --sync-source oci \ --registry oci://ghcr.io \ --tenant-repo my-org/my-team \ --oci-path manifests
# Git source — also scaffolds a tenant Git repo when --git-provider github is setksail tenant create my-team --type flux \ --sync-source git \ --git-provider github \ --tenant-repo my-org/my-team-infraWhen scaffolding a tenant repo, KSail resolves the GitHub token through a fallback chain:
--git-tokenflag (highest priority)GH_TOKENorGITHUB_TOKENenvironment variable- GitHub CLI config (e.g., from
gh auth login)
If no token resolves, repo scaffolding is skipped with a warning and the command still succeeds. In CI,
provide a non-empty token via --git-token, GH_TOKEN, or GITHUB_TOKEN if you want scaffolding to run.
Only ksail tenant delete --delete-repo fails when no token can be resolved. Pass --git-token explicitly
only to override the auto-detected token:
ksail tenant create my-team --type flux \ --git-provider github \ --tenant-repo my-org/my-team-infra \ --git-token "${MY_BOT_TOKEN}"ArgoCD tenants
Section titled “ArgoCD tenants”ArgoCD tenants generate RBAC isolation manifests, an AppProject, and an Application:
ksail tenant create my-team --type argocd \ --git-provider github \ --tenant-repo my-org/my-team-infraplatform/tenants/my-team/├── kustomization.yaml├── namespace.yaml├── serviceaccount.yaml├── rolebinding.yaml├── project.yaml└── app.yamlAdd --register to also merge the tenant RBAC policy into the shared argocd-rbac-cm ConfigMap:
ksail tenant create my-team --type argocd \ --git-provider github \ --tenant-repo my-org/my-team-infra \ --registerKSail scans the kustomization directory for an argocd-rbac-cm ConfigMap (by content, not filename). If
found, it merges the tenant policy; otherwise it creates argocd-rbac-cm.yaml in the same directory and
registers it in kustomization.yaml.
kubectl tenants
Section titled “kubectl tenants”kubectl tenants generate RBAC-only platform manifests (no GitOps sync resources). When --git-provider github and --tenant-repo are provided, KSail also scaffolds a tenant repository without GitOps-specific
resources — provided a GitHub token can be resolved (see the token resolution fallback
chain above). If no token is available, the command still succeeds and only the local platform manifests
are generated:
ksail tenant create my-team --type kubectl
# With repo scaffoldingksail tenant create my-team --type kubectl \ --git-provider github \ --tenant-repo my-org/my-team-manifestsThe scaffolded repo contains a plain kustomize setup for manual workflows:
/├── README.md└── k8s/ └── kustomization.yamlThe tenant applies their manifests with kubectl apply -k k8s/.
Production-ready tenants
Section titled “Production-ready tenants”By default KSail generates a minimal tenant (namespace, ServiceAccount, RoleBinding, and any GitOps sync resources). For shared production clusters you usually want stronger isolation. These hardening resources are opt-in — nothing below is generated unless you ask for it.
Enable the recommended baseline with a single flag:
ksail tenant create my-team --production--production turns on Pod Security Standards (baseline), a default-deny NetworkPolicy, a ResourceQuota,
a LimitRange, a hardened ServiceAccount, and (for Flux tenants) a hardened sync. Any granular flag you set
explicitly overrides the umbrella default. The resulting tenant directory adds:
platform/tenants/my-team/├── kustomization.yaml├── namespace.yaml # + Pod Security Standards labels├── serviceaccount.yaml # + automountServiceAccountToken: false├── rolebinding.yaml├── networkpolicy.yaml # default-deny + DNS + intra-namespace├── resourcequota.yaml└── limitrange.yamlGranular flags
Section titled “Granular flags”| Flag | Effect |
|---|---|
--pod-security <restricted|baseline|privileged> | Adds pod-security.kubernetes.io/{enforce,audit,warn} labels to each namespace |
--with-network-policy | Default-deny NetworkPolicy plus allow rules for DNS and intra-namespace traffic |
--with-quota (--quota-cpu, --quota-memory) | ResourceQuota capping namespace requests/limits (defaults: 4 CPU, 8Gi) |
--with-limit-range (--limit-default-cpu, --limit-default-memory, --limit-request-cpu, --limit-request-memory) | LimitRange with default container requests/limits |
--disable-token-automount | Sets automountServiceAccountToken: false on the ServiceAccount |
--image-pull-secret <name> | Adds an imagePullSecrets entry (repeatable) |
--cluster-role <name> | Bind multiple ClusterRoles (repeatable; one RoleBinding per role) |
For Flux tenants you can additionally harden the sync:
| Flag | Effect |
|---|---|
--flux-wait | Sets wait: true and timeout (default 5m) on the Flux Kustomization |
--flux-timeout | Flux Kustomization timeout; setting it implies --flux-wait |
--flux-retry-interval | Sets the Kustomization retryInterval |
--flux-decryption | Adds a SOPS decryption block referencing the sops-age secret |
Portable by default, native CRDs when available
Section titled “Portable by default, native CRDs when available”The generated manifests are portable upstream Kubernetes resources by default, so they work on any
distribution KSail supports. When ksail.yaml opts into a richer control plane, KSail upgrades the output
automatically:
- If
spec.cluster.cniisCilium,--with-network-policyemits aCiliumNetworkPolicy(cilium.io/v2) instead of an upstreamNetworkPolicy. - Pod Security Standards labels remain the portable baseline even when
spec.cluster.policyEngineisKyverno— Kyverno enforces additional policy server-side but does not replace NetworkPolicies.
The Cilium policy is an intentionally simple starting point (default-deny, plus intra-namespace and kube-dns allow rules) that platform teams can extend with their own allow-lists.
Apply tenant manifests
Section titled “Apply tenant manifests”After generating manifests, apply them with the workflow that matches how the tenant was created:
# Created without --register? Apply the generated tenant directory directlyksail workload apply -k platform/tenants/my-team/
# Created with --register (the parent kustomization already includes the tenant)?# Apply the parent directoryksail workload apply -k platform/tenants/With GitOps, push and reconcile instead — the registered source then pulls each tenant’s artifact:
ksail workload pushksail workload reconcileSee GitOps Workflows for the full push/reconcile loop.
Offboard a tenant
Section titled “Offboard a tenant”# Remove manifests and unregister from kustomization.yaml (default)ksail tenant delete my-team
# Also delete the tenant Git repository (token resolved automatically;# requires a valid token from the fallback chain above)ksail tenant delete my-team --delete-repo \ --git-provider github \ --tenant-repo my-org/my-team-infra
# Keep the kustomization.yaml entryksail tenant delete my-team --unregister=falseWhen deleting an ArgoCD tenant, KSail also removes the tenant’s policy entries from the argocd-rbac-cm
ConfigMap. It scans YAML files in the output directory for a ConfigMap named argocd-rbac-cm (content-based
detection, not filename-based) and removes lines belonging to the deleted tenant. If no RBAC ConfigMap file
is found, the step is silently skipped.
Related
Section titled “Related”- Deliver with GitOps — the workflow tenants plug into.
- GitOps Workflows — the push/reconcile loop in depth.
- Secret Management — keep tenant secrets out of Git.
- ArgoCD ApplicationSet — auto-discover tenants with ArgoCD.
- Multi-Environment Workflows — drive many clusters with
--config. - Project Structure & GitOps Layout — how the platform repo is laid out.
ksail tenant— full CLI reference for the tenant command group.