Set up an organization

Organizations in Polars Nanook are the top-level entity and typically represent a company. An organization has members, contains one or more workspaces and holds the billing. Each workspace connects its own deployments, such as an AWS account or a cluster you run.

When an account is created, Polars Nanook creates an organization called <first name>'s organization with a workspace called My workspace, so queries can run right away. Before you send the first invitation, the portal asks you to give the workspace its own name, which invitees see in their invitation email. Rename the organization under Organization > Settings and the workspace on its settings page.

Create another organization in the portal or with the CLI:

nanook organization setup --name "<ORGANIZATION_NAME>"

Workspace creation

Organization admins create workspaces with New workspace in the workspace switcher of the portal or from the command line:

nanook workspace create --workspace-name "<WORKSPACE_NAME>" --organization-name "<ORGANIZATION_NAME>"

Creating a second workspace needs the Team or Enterprise plan, as listed in Plans and billing.

See Manage members for the organization roles.

Organization and workspace selection

The client uses the organization and workspace named in the code, such as pn.ComputeContext(workspace="My workspace"). Without one, it uses the default workspace: the NANOOK_DEFAULT_WORKSPACE_ID environment variable if set, then the client's local config file, then the default workspace of the account. Set the default in the portal or with pn.Workspace("My workspace").set_default(). A service account has no default workspace, so name the workspace in jobs that log in with one.

Membership of several organizations

A user can be a member of several organizations. Where it matters, name the organization you mean, such as with --organization-name in the CLI. Organization names are not unique: to tell apart organizations that share a name, refer to them by ID in the Python client (pn.Organization(id=...)) or rename one of them.

Delete an organization

An organization admin deletes an organization from the command line, once it has no workspaces and its paid plan has ended:

nanook organization delete --name "<ORGANIZATION_NAME>"

Delete the workspaces first (Delete a workspace) and cancel the plan under Organization > Billing.