Organization Management
After Fuzzball has been deployed on your system, you will first need to create an organization before you are able to add Fuzzball users.
Local organization (v3.3.0+): Fuzzball now supports a built-in local organization that does not require Keycloak. When deploying with the local organization feature, the initial organization and its root user are created automatically as part of the bootstrap process — no manual organization creation step is required. See your deployment’s initial configuration output for the admin credentials.
Cluster administrators manage organizations with the Fuzzball CLI:
| Task | Command |
|---|---|
| Create an organization | fuzzball organization create |
| List organizations | fuzzball organization list |
| Delete an organization | fuzzball organization delete |
| List organization members | fuzzball organization member list |
These commands run against the Fuzzball API, so they need only a CLI context logged in as a cluster
administrator – no cluster or kubectl access is required.
The fuzzball-admin CLI overlaps with the operations above and adds a few realm-inspection commands
of its own. It talks to internal service endpoints directly and is accessed in the fuzzball-admin-0
pod running on the server node as part of
Fuzzball Orchestrate.
Prefer the Fuzzball CLI commands above. Reach forfuzzball-adminonly when the Fuzzball API is unreachable – for example while recovering a deployment whose orchestrate service or Keycloak is down.
The command below shows all the fuzzball-admin subcommands which can be run.
$ kubectl exec -n fuzzball fuzzball-admin-0 -- /app/fuzzball-admin --help
This CLI allows you to interface with internal fuzzball service endpoints directly via a preexisting port-forward.
Usage:
fuzzball-admin [command]
Available Commands:
application Manage applications
audit Manage audit data
billing Manage billing service
completion Generate the autocompletion script for the specified shell
debug Debugging commands
help Help about any command
organization Manage organization
scheduler Manage the scheduler
Flags:
-h, --help help for fuzzball-admin
Use "fuzzball-admin [command] --help" for more information about a command.Each organization management task has its own page, starting with creating an organization.
You can list members of an organization using the fuzzball organization member list command.
The --owner flag controls filtering by member role:
# List all members (owners and non-owners)
$ fuzzball organization member list <org-name>
# List only owners
$ fuzzball organization member list <org-name> --owner
# List only non-owners
$ fuzzball organization member list <org-name> --owner=falseDefault behavior: When no flag is provided, the command lists all members (both owners and non-owners).
The --relationship flag is deprecated in favor of --owner. If you have scripts using the old flag, update them to use the new syntax:
| Old syntax | New syntax |
|---|---|
--relationship=all | (omit flag) |
--relationship=owner | --owner |
--relationship=member | --owner=false |
The--relationshipflag will be removed in a future release. Update your scripts to use--owner.