The new organization’s name — also becomes its Kubernetes namespace, and must not collide with hyve-system or any form of control plane, both permanently reserved.
'hyve organization'
hyve organization manages organizations — hyve-api’s own multi-tenant isolation unit, one Kubernetes namespace plus a set of environments/RBAC bindings/reconciling-cluster assignment, backed by a real row in hyve-api’s own datastore rather than a Kubernetes object. Cluster-mode only — organizations have no local-directory equivalent — and every command needs an active session (hyve context login). list, use, unset, and current work for anyone; the rest are superadmin-only.
One login reaches every organization you’re a member of (see Multi-Tenancy), so these commands pick which one the rest of the CLI acts in.
hyve organization list
hyve organization listThe organizations you can access — every one, for a superadmin — with your role in each, marking the one you’re acting in. The control plane’s own organization is listed once, as control plane (hyve-system).
hyve organization use
hyve organization use <name>Act in <name> from now on: recorded on the active context, so every cluster-mode command (hyve cluster, template, environment, …) acts there until you run use again or unset. Refuses an organization you can’t access. Clears the context’s selected environment, which belonged to the previous organization. control-plane names the control plane’s own organization.
For a single command, pass --org <name> instead — a global flag, accepted by every command:
hyve cluster list --org widgethyve organization unset / current
hyve organization unset # let the server pick: your only (or first) organization, or the control plane for a superadminhyve organization current # the organization commands act in, and your role therehyve organization create
hyve organization create <name> [--admin-identity <identity> --admin-role <role>] [--reconciling-cluster <name>]<name> string required --admin-identity string Identity (username or OIDC subject) to grant an initial admin binding to, in the same transaction as the organization itself. Requires --admin-role.
--admin-role string Role for --admin-identity (admin or read-only).
--reconciling-cluster string Name of a pool reconciling cluster (see hyve reconciling-cluster pool add) this organization’s resources should live on instead of the control plane’s own home cluster. Omit to use the home cluster; the organization’s own admin can later add and switch to clusters of its own.
hyve organization create acme --reconciling-cluster cell-ahyve organization delete
hyve organization delete <name>Marks the organization for deletion and issues a standard Kubernetes namespace delete — permanent, and asynchronous: Kubernetes’ own cascade tears everything down, and the organization’s row disappears once the namespace finishes terminating.
hyve organization migrate
hyve organization migrate <name> (--reconciling-cluster <name> | --home)Moves an organization onto a different reconciling cluster, or back to the control plane’s own home cluster.
--reconciling-cluster string Name of a pool reconciling cluster (see hyve reconciling-cluster pool add/pool list) to move the organization onto. To switch between an organization’s own stored clusters, its admin uses hyve reconciling-cluster use instead.
--home boolean Move the organization back to the control plane’s own home cluster. Only possible for an install that has one — see --home-cluster on hyve cluster-config api run.
hyve organization migrate acme --reconciling-cluster cell-bEnvironments
An organization’s environments are managed with hyve environment (list/create/delete/use, in the organization you’re acting in). The older hyve organization environments and hyve organization create-environment still work but are deprecated.