Skip to main content

Documentation Index

Fetch the complete documentation index at: https://akua-1dce587a.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

workspaces switcher
A workspace is the unit of resource ownership in Akua. Clusters, products, deployments, billing, and Stripe payments all belong to a workspace. Switch between workspaces in the sidebar to navigate between sets of resources. Workspaces are scoped to their members. Only people invited to a workspace, or members of an organization that manages it, can see it.

What a workspace contains

  • Clusters: Kubernetes infrastructure for deploying applications.
  • Regions: organizational labels for grouping clusters.
  • Application deployments: running instances of your products and applications.
  • Products: sellable software packages you create.
  • Installations: running deployments of your products and direct installs, each with its own package repository.
  • GitHub App installations: connected for automated deployments.
  • Workspace members: users with direct access.
  • Managing organization: optional organization whose members get admin access automatically.
  • Stripe account: one billing account per workspace for marketplace payments.

Workspaces vs organizations

These solve different problems. Use them together:
WorkspaceOrganization
What it isContainer for resources (clusters, products, deployments)Identity for your team or company
Who sees itDirect members and the managing organization’s membersMembers of the organization
Owns billingYes (Stripe Connect, Akua subscription)No
Owns resourcesYesNo (just access)
Typical countOne per environment, customer, or business unitOne per company
If you’re a single user shipping a product, you may only need a workspace. Once you have a team, create an organization. If you sell software that your customers deploy on Akua, your organization gets admin access to each customer’s workspace through the managed-by relationship; your customers retain full ownership and billing control.

When to use separate workspaces

Even with an organization, you’ll often want multiple workspaces:
  • Environment separation: production, staging, and development as separate workspaces prevent accidental changes and keep clusters isolated.
  • Per-customer ownership: when you sell software, each customer gets their own workspace. They own it; your organization manages it. This keeps billing, data, and resources isolated per customer.
  • Independent business units: different legal entities, different Stripe accounts, or different teams that should never share resources.
  • Test isolation: short-lived workspaces for one-off projects, demos, or partner experiments.
Don’t reach for a new workspace just to organize resources within the same business and same team. Clusters, products, and installations can coexist in one workspace.

Workspace roles

Each member has a role that controls their permissions:
RolePermissions
OwnerFull control: delete workspace, manage billing, transfer ownership, and invite members.
AdminManage apps, deployments, clusters, secrets, and members.
MemberDeploy apps and view resources and logs.
The workspace creator is automatically assigned the owner role. Members of a managing organization get admin access automatically. See Organizations → Managed workspaces.

Managing the workspace

  • Switch workspaces from the sidebar switcher.
  • Selecting All Workspaces shows resources from every workspace you have access to.
  • Create, edit, invite members, or transfer ownership from Settings in the dashboard.

API

Manage workspaces, members, subscriptions, and access state programmatically.

Workspaces API

CRUD, member management, subscription, access state, and billing portal endpoints.

Authentication

Mint API tokens for programmatic access.

Organizations

Team and customer-management identity.

Billing

Manage your workspace subscription.

Create a cluster

Set up infrastructure in your workspace.

Plans and pricing

Resource quotas and plan limits per workspace.