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.

Products overview
Products are sellable software packages you create in Akua. They combine your application’s deployment configuration with pricing to enable customers to purchase and deploy your software through the or offer links. A product wraps your application’s sources (Helm charts, GitHub repositories, Docker images) with default inputs and optional pricing. When a customer purchases, Akua provisions a private installation repository for that customer and deploys it.

​
How products work

Products package your software for sale. Each product includes:
  • Deployment configuration: sources (Helm charts, GitHub repos, Docker images) and default inputs that define how your software runs
  • Pricing: optional Stripe integration for customer billing
  • Cluster targeting: which the product can be deployed to
  • Display settings: custom images, descriptions, and visibility options
When customers purchase your product, Akua automatically provisions a per-customer installation repository and deploys the rendered manifests to the selected cluster. Each customer gets their own isolated with dedicated resources.

​
How a product becomes a deployment

Sources + default inputs (Product)
        │
        ▼  customer purchases via offer link or marketplace
Per-install package repository (akua.toml + package.k + inputs.yaml + upstream/ + manifests/)
        │
        ▼  cluster syncs
Running installation
Every installation gets its own repository with vendored sources, the customer’s inputs, and the rendered Kubernetes manifests. The repository is the deploy target: your cluster reads from it, your team can edit it, and every change ships with a commit history. See Concepts for the full picture.

​
Products and offers

Products with Stripe pricing automatically appear in the marketplace. You can also sell products without the public catalog using offer links: shareable short URLs (akua.dev/i/<hash>) that take customers directly into the install wizard. An offer can pre-fill and optionally lock specific input fields. The wizard form is generated from the product’s Akua Package input schema, so customers configure their install without any hand-coded form on your part. Input schema quality (docstrings, grouping, ordering, widget hints) is the main lever for a great customer experience. (CEP-0026)

​
When to use products

Use products when you want to sell software to customers:
  • Open source monetization: offer managed, dedicated deployments of your OSS project (databases, dev tools, analytics, CMS) as a cloud service without building multi-tenant infrastructure
  • SaaS with dedicated instances: enterprise customers who need isolation get their own deployment (healthcare, finance, collaboration tools)
  • Managed database services: offer dedicated database clusters (PostgreSQL, Redis, ClickHouse) per customer
  • Custom applications: B2B SaaS, industry-specific software, white-label solutions, or internal tools turned into products

​
Products vs direct installs

ProductsDirect installs
PurposeSell software to customersInternal tools, shared databases, monitoring
PricingOptional Stripe integrationNo pricing
MarketplaceListed when pricing is configuredNot listed
Offer linksYes (shareable install wizard links)No
Per-install repositoryYes, one per customerYes, one per install
Both flavors generate per-installation repositories from the same sources and inputs. Learn more about application deployments →.

​
Creating a product

Create a product from the Products dashboard. You will:
  1. Select the package source: a Helm chart, GitHub repository, or Docker image.
  2. Choose which clusters the product can be deployed to. Customers see only the regions of those clusters.
  3. Optionally add Stripe pricing. Once pricing is configured, the product appears in the marketplace automatically.
To add Stripe pricing, first connect your Stripe account in workspace settings, then associate one or more Stripe prices with the product.

​
API

Products API

Create, update, archive, and list products.

Offers API

Create and manage offer links for your products.

Offers and install links

Share short URLs that drive the generated install wizard.

Marketplace

How products appear to customers in the catalog.

Deployments

How products create customer installations.

Payments

How Stripe integration works for product billing.