Upgrade Kamiwaza

Within a release line, upgrade Kamiwaza in place: rerun the helm upgrade --install command from your environment's install page with the new --version and the same values files. An in-place upgrade keeps Kamiwaza's models, workrooms, users, data, and storage volumes, and existing extension deployments keep running.

Supported upgrades

You can upgrade in place from any 1.3 release to a later 1.3 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.

Before you start

1. Read the release notes for every release after the one you run, up to and including the one you are installing. Each patch release lists any action it requires. See Release notes.
2. Back up. Back up Kamiwaza's PostgreSQL database and, for each Kaizen deployment, its database and its object store. For example, run pg_dumpall in each PostgreSQL pod, and archive the /data directory of each Kaizen deployment's SeaweedFS pod. Restoring a Kaizen backup into a new deployment is not documented; contact Kamiwaza support if you need one.
3. Find your values files, and the order you installed with.
4. Air-gapped installations: copy the new release into your registry, as described in Install Without Internet Access. Keep the previous release's engine images in your registry until every model deployment has been redeployed on the new release, and its extension images while deployments of those extension versions still run.

Do not uninstall Kamiwaza before an upgrade. Uninstalling deletes the platform databases, the object store, and every extension's data.

Upgrade

As the identity that installed Kamiwaza, rerun the helm upgrade --install command from your environment's install page, with the new --version and every values file you installed with, in the same order. For a Kubernetes with Istio installation with one values file:

helm upgrade --install kamiwaza \
  oci://ghcr.io/kamiwaza-ai/releases/kamiwaza/charts/kamiwaza \
  --version <new version> \
  --namespace kamiwaza \
  --values kamiwaza-values.yaml \
  --wait --wait-for-jobs --timeout 30m

Your environment's install page has the exact command and any additions:

• Kubernetes with Istio
• OpenShift with GreyMatter. First repeat step 3 with the new version, then rerun the install command. With Helm 4, keep --server-side=false on every upgrade.
• Install Without Internet Access. Use the chart in your own registry, with the values from step 5 of that page. If you installed with the field kit, use the new release's field kit: render its values again and follow its README. Values rendered by an earlier kit refer to the earlier release's images.

Always upgrade with helm upgrade --install against the cluster, never by applying rendered manifests. The chart reads its generated keys and passwords back from the cluster on each upgrade.

Verify

• Every Kamiwaza deployment's pods are Ready, and the upgrade's jobs have completed.
• helm list -n kamiwaza shows the new chart version.
• The platform answers 200 at / and 401 at /api/ without credentials.
• From 1.3.3, GET /api/kamiwaza/metadata, called as a signed-in user, reports the new version.

After the upgrade

Do each action that the release notes list for the releases you crossed, such as redeploying models.

Extensions do not change on their own.

• Running extension deployments keep the version they were deployed with.
• The App Garden keeps deploying the versions an administrator selected before the upgrade. To use the new versions, as an administrator, open the App Garden, select Check for updates, then Update on a row, Update all, or Choose version. A selection changes the version that new deployments use. It does not change a running deployment.

A new Kaizen version is a new deployment. Each Kaizen deployment has its own database and storage volumes, and no data carries over from an existing deployment to a new one. Stopping a Kaizen deployment in the App Garden deletes its storage volume claims, and with a Delete reclaim policy, the Kubernetes default for dynamically provisioned volumes, its data. Keep your current Kaizen deployment unless you are starting fresh. To run a new Kaizen version alongside it:

1. Back up the existing deployment, as described in Before you start.
2. Make sure the cluster has room for a second complete Kaizen deployment. Without it, the new deployment's pods stay Pending and the deployment fails. Never stop the existing deployment to make room. If the new deployment fails before anyone has used it, or opens the Kamiwaza dashboard instead of Kaizen, add capacity if it was short, then stop that new, unused deployment and deploy again. Do not stop a new deployment that anyone has added data to; contact Kamiwaza support instead.
3. In the App Garden, select the new Kaizen version, as described above.
4. Deploy Kaizen from the App Garden.
5. In the new deployment's Admin area, under Models, select the chat and embedding models. Upload your documents again, then choose Index on each one, or Index selected for several.