Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.akua.dev/llms.txt

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

Akua is the open-source packaging substrate behind Akua’s per-installation deployments. Every install on Akua is an akua Package: a typed, signed, deterministically-rendered KCL program that turns customer inputs into Kubernetes manifests. You don’t have to author an akua Package by hand to use Akua. For most products, Akua synthesizes one from your sources. But if you want full control over composition (sidecars, custom CRDs, multi-resource patches), authoring directly is supported.

​
What akua provides

SurfacePurpose
package.kThe deploy definition: KCL composition that turns inputs into Kubernetes resources
akua.toml + akua.lockPinned dependencies (Helm charts, other Packages, KCL libraries) with cosign signatures
akua renderExecutes the Package against customer inputs, produces deploy-ready manifests
akua exportEmits the Package’s input schema as standards-pure JSON Schema 2020-12 / OpenAPI 3.1
A programmatic API exists for embedding akua in your own tooling. See the akua repo for details.

​
How Akua uses akua

Akua runs akua at three points in the install lifecycle:
  1. Schema for the install wizard: Akua exports the Package’s Input schema as JSON Schema; the wizard renders from it. UI hints from @ui(...) decorators flow through as x-ui extensions.
  2. Per-install rendering: for every customer install, Akua renders the Package against the customer’s inputs.yaml, vendoring upstream deps and writing the rendered manifests into the installation repository.
  3. Update propagation: when a Package version changes (composition, defaults, or pinned deps), Akua re-renders every affected installation independently.

​
Where to start

Package format

Authoring package.k: the Input schema, @ui annotations, composition.

Install links

How @ui drives the install wizard at /i/<slug> and what links carry.

Akua repo on GitHub

Source code, full CLI reference, SDK docs, examples.

Installation repositories

The per-install git repo that materializes a rendered Package.

​
Status

Akua is pre-alpha. The Package format and CLI contract are stable enough to build on, but the CLI verb set is still iterating. Akua pins to a specific akua version per release and bumps deliberately. For canonical, always-fresh references, the akua repository is authoritative. The pages here are curated for product authors building on akua within Akua; full architecture, embedded engines, security model, and roadmap docs live in the akua docs directory.

Installation repositories

The per-install git repository that materializes a rendered Package.

Offers and install links

How your Package’s schema drives the install wizard.

Customizing inputs

Wizard, overrides, and git push: three views of the same state.

Products

Wrap a Package into a sellable product with billing.