Skip to main content

Installing Kamiwaza

Kamiwaza installs with Helm into a single namespace on a Kubernetes cluster that you run. Installation has two stages, usually done by two roles:

  1. Prepare the platform. A platform administrator makes sure the cluster provides what Kamiwaza depends on: a namespace, an installer identity, a service mesh and gateway, storage, DNS, and a few recorded facts. Kamiwaza does not set up or modify your cluster. Each environment has its own prerequisites page.
  2. Install Kamiwaza. Using the namespace-scoped installer identity, you add the license, write a values file with the recorded facts, and run one helm upgrade --install.

Before you begin​

  • Review System Requirements: hardware sizing, supported operating systems, GPU support, and supported configurations.
  • Get a license file from your Kamiwaza representative. See License File.

Choose your environment​

Kamiwaza runs on several kinds of Kubernetes environment, each with its own prerequisites, install, and uninstall pages. Find yours in Installation Environments.

Use the image references from your release​

Choose the release you install with --version on the chart. Use that version's chart and bundled catalog to select the platform and bundled extension images.

If you pull or copy release images yourself, take each reference from the same release's manifest, as Get the image list shows; that step works with internet access too. Keep each reference as listed, in the form <repository>@sha256:<digest> or <repository>:<tag>@sha256:<digest>.

Do not take references from a package's page on GitHub. Its Latest version and install command can name a signature, provenance, or SBOM artifact published beside an image, sometimes under a tag of the form sha256-<digest>. Such an artifact has no platform to run, and pulling it fails, for example with no matching manifest. Not every sha256- tag is one: the air-gapped copy creates sha256- tags for real images. Editing a reference by hand, such as changing :sha256- to @sha256:, names a different artifact, possibly one that is not from your release. Select the reference from the release manifest; the published artifacts need no rebuild, retag, or deletion.

Upgrading from an earlier release​

There is no in-place upgrade from Kamiwaza 1.2 or earlier. Contact your Kamiwaza representative to plan an assisted migration to a new installation.

Within a release line, upgrade with helm upgrade --install, using the new version and the same values file. See Upgrade Kamiwaza for the supported upgrades and what to do before and after.

After installation​

Verify the platform and log in as described at the end of your installation guide, then see the Quickstart.

To remove Kamiwaza, follow the uninstall page for your environment.