0.6.0 to 0.6.1 Upgrade
The 0.6.1 release replaces the archived Bitnami Cassandra runtime with the official Apache Cassandra 5.0.8 image and an in-house Cassandra Helm chart. This removes the CVE-affected Bitnami runtime and its bundled components.
Fresh installs need no special handling. Existing clusters that already hold data need a migration, because three things change at once: the runtime image, the Helm chart shape, and the on-disk data layout. A normal in-place Helm upgrade does not carry an existing Bitnami-based cluster onto the new stack:
- The new Cassandra chart intentionally removes the
app.kubernetes.io/nameandapp.kubernetes.io/instancelabels fromvolumeClaimTemplates.metadata.labels. This is the only change to an immutable StatefulSet field. Kubernetes treats the entire volume claim template as immutable, so the StatefulSet has to be recreated. - The Bitnami image stored data nested one directory deeper than the official
image expects (
/bitnami/cassandra/data/...versus/var/lib/cassandra/...), so the new image does not find the old data by default. - The old and new node configuration must agree on the settings the existing data was written with.
Because of this, an operator with an existing data-bearing cluster chooses a migration method. This guide describes the methods and their trade-offs; none is mandated over the others.
The commands below use Bash, Helm 3, Helmfile 1.1.x, kubectl, jq, Python 3, and the NGC CLI. The data-bearing example covers the standard three-member Cassandra cluster and its Bitnami data layout. Other replica counts, separate commitlog volumes, custom data paths, or custom authentication require a site-tested migration procedure.
For an existing data-bearing cluster, do not run an unscoped 0.6.1 stack
install before completing the Cassandra steps for your chosen migration method.
This includes make install, helmfile sync, and equivalent sync commands. An
unscoped sync attempts to patch the existing Cassandra StatefulSet, fails on its
immutable fields, leaves the Cassandra Helm release in a failed state, and stops
the later Helmfile stages.
If an unscoped sync already failed, do not uninstall Cassandra or delete its PersistentVolumeClaims. Stop and reconcile the failed release against your saved 0.6.0 configuration and data baseline before using a site-reviewed recovery procedure. The healthy-source checks below deliberately reject that failed state.
Select the bundles and cluster
Download each version into a separate directory. Keep your deployed 0.6.0 configuration and credentials; a download does not contain your site settings. Use a new directory outside the cluster for the evidence and backups. It must have capacity for all node snapshots and use your approved backup storage.
Keep this shell open for the remaining commands. The bundle Makefile accepts
a kubeconfig, but no context flag. assert_context must succeed immediately
before each make install. Do not run concurrent maintenance or change this
kubeconfig during the procedure. Stop on any command failure; do not skip a
failed check or resume at a later mutation.
Reopen a session for diagnostics
The commands save the pinned cluster identity and available helpers in
$UPGRADE_DIR/session.sh, adding the snapshot tag and target image when they
are known. This private file excludes credentials. If a check closes the shell
after setup, open a new Bash shell and source the saved session at its prompt:
Use this session only for read-only diagnostics until the failed check is
resolved and the recovery procedure is reviewed. Do not rerun setup, recapture
the original baseline, or repeat mutations to bypass the failure. If CQL setup
was reached, run load_cql_credentials before CQL diagnostics; it reloads the
credentials from the protected baseline files, even after the old Secret is
removed. A changed context or cluster UID must be investigated, not repinned.
Prepare the 0.6.1 configuration
Run cd "$TARGET_CONTROL" before preparing the configuration or running a
0.6.1 sync command.
Reconcile the site-specific settings from the 0.6.0 deployment into the 0.6.1
configuration files:
environments/$HELMFILE_ENV.yamlsecrets/$HELMFILE_ENV-secrets.yaml
Start from the files or templates included with 0.6.1 and carry forward the required values from 0.6.0. Do not replace the 0.6.1 files wholesale because available settings can change between releases. Preserve the existing registry, storage, endpoint, credential, and secret values unless this procedure explicitly instructs you to change them.
Do not change the Cassandra superuser password or application role passwords
during this migration. Preserve the Cassandra and OpenBao credential values
from the 0.6.0 deployment. The 0.6.1 Cassandra chart does not create the old
cassandra-system/cassandra Secret, so do not rely on that Secret after the
upgrade. Rotate Cassandra credentials in a separate maintenance procedure.
Confirm that both files exist before continuing:
Fresh installs
A new 0.6.1 install has no existing Cassandra data and needs no migration. Install the stack normally; Cassandra comes up on the official image with the in-house chart:
The rest of this guide applies only when migrating an existing data-bearing cluster.
Check Cassandra before migrating
Download the read-only checker
to $UPGRADE_DIR/cassandra-upgrade-check.py. It uses only the Python standard
library and validates captured evidence; it does not contact or change a cluster.
The checker rejects unsupported layouts and incomplete results.
Success requires exactly the three expected pods, owned by the current
StatefulSet, Running with every container Ready. Each node must report the same
three UN (Up/Normal) ring members, matching the pod IPs. Each original data PVC
must be Bound, without a deletion owner or Delete retention policy. The saved
PVC/PV and Cassandra host identities are compared after adoption.
The standard 0.6.0 superuser name is in cassandra.dbUser.user in the Helm
values; its live password is in Secret cassandra, key cassandra-password.
If the installation uses dbUser.existingSecret, a mapped key, password files,
or a customized authentication/TLS setup, stop and adapt the site procedure
before continuing. Do not substitute a default password.
Keep the saved credentials private and this shell open. They remain available after the old Secret is removed. The password travels over stdin to the pod, not in the kubectl command arguments. Do not enable shell tracing.
Preserve the target credentials
In the existing target secrets/$HELMFILE_ENV-secrets.yaml, set
cassandra.dbUser.user and cassandra.dbUser.password to the recorded superuser
values. Set cassandra.serviceRolePassword to the source Helm value with that
name. Preserve the existing openbao.migrations.env entry named
DEFAULT_CASSANDRA_PASSWORD and its other array entries. This entry must equal
the service-role password, which can differ from the superuser password.
Merge these keys into the existing secrets file; do not create a second
cassandra key or replace the file. In 0.6.1, the environment file forwards
persistence.subPath, but does not forward dbUser, serviceRolePassword,
hooks, cluster, or config. Those chart settings belong in this secrets
values file. A selected target render is checked before deleting the StatefulSet.
Record a nonempty data and migration baseline
Pause changes to the account records during this maintenance window. The
example uses the normally small nvcf_api.accounts table; avoid unbounded
counts on large workload tables. A missing or empty table cannot serve as a
survival baseline. Record an existing function and its successful invocation
through your normal client as an additional application-level baseline.
Every discovered migration table must contain exactly one clean version record. The checker rejects CQL errors, partial output, empty inventories, missing or dirty records, and later missing tables or regressed versions. Target migrations can advance versions or add tables. Do not clear dirty flags to bypass a failure.
Back up every Cassandra member
Keep application writes paused until the baseline and snapshots are complete. Snapshots are node-local; copying one node is not a cluster backup. These commands save every tagged snapshot, schema, credentials, configuration, and identity evidence outside the cluster. Confirm that the destination satisfies your site’s backup retention and access controls.
The capacity check conservatively requires one current data footprint free on each node before flushing, and space for all nodes plus 10 percent at the backup destination. Resolve insufficient capacity before taking snapshots.
Each archive must be readable to its end, contain the requested tag, include application, authentication, and migration-state snapshots, and contain the SSTables listed in its manifests, including their data, metadata, compression or checksum information, and primary index files. A table-of-contents file is required for SSTables with SAI components. It is optional only for SSTables without SAI components, as seen in released system-table snapshots. An SAI column index can omit data components only when its completion marker identifies an empty index. The checker validates the released marker format and rejects missing primary data or partial nonempty indexes. See the Cassandra SAI index format. The checker records a SHA-256 for each archive. A checksum and readable archive establish transfer integrity, not a successful restore. Keep a separately rehearsed recovery procedure. If your backup destination is temporary, copy the whole evidence directory to durable protected storage and compare the archive checksums there before proceeding. Never remove the only backup, clear snapshots, or delete PVCs as an automatic retry.
Choose a migration method
Choose the method that fits your deployment and downtime requirements. The commands above and the in-place adoption checks cover the standard three-member source cluster. Datacenter expansion and backup/restore remain outlines that need a separate site-tested execution plan; they are not qualified by the in-place checks.
Datacenter expansion keeps the cluster online by adding the new stack as a second Cassandra datacenter and streaming data to it, then cutting clients over. It has the most moving parts and needs enough capacity to run both datacenters during the migration.
In-place volume adoption reuses the existing data volumes. It is the smallest change in footprint, but it requires deleting and recreating the Cassandra StatefulSet (its volumes are retained) and pointing the new pods at the existing Bitnami on-disk layout.
Backup and restore is the most conservative for data integrity: the existing cluster is left untouched until a fresh 0.6.1 cluster is verified. It needs a maintenance window and capacity to run both clusters during the copy.
Method: datacenter expansion
Add the 0.6.1 stack as a second Cassandra datacenter in the same cluster, replicate the data to it, move clients over, then remove the old datacenter. Because the new nodes bootstrap empty and receive their data by streaming, this method avoids the volume-layout and configuration-compatibility concerns of an in-place adoption.
Validate this procedure in a non-production environment before running it against production. Perform the keyspace replication and decommission steps deliberately; an incorrect replication change or an early decommission can lose data.
Two settings on the new datacenter’s nodes decide whether the join and rebuild succeed:
storage_compatibility_modemust match the existing cluster. The existing Cassandra fleet runsNONE(full Cassandra 5.0 native format), and the 0.6.1 chart defaults the new nodes toNONEfor this reason. If the new nodes run a different mode (the Apache Cassandra 5.0 default isCASSANDRA_4), gossip and schema exchange still succeed and the datacenters appear healthy, but thenodetool rebuildin step 4 fails: the streaming connection is rejected as version-incompatible.- Token allocation. When the existing cluster already holds a large schema, a
node that joins with schema-aware token allocation
(
allocate_tokens_for_local_replication_factor) must reach schema readiness within a fixed window during bootstrap, or it aborts with a “Could not achieve schema readiness” error and restarts. If the new nodes fail to finish joining with that error, have them allocate tokens without the schema-aware option (random tokens are acceptable for a new, empty datacenter) and retry.
-
Stand up the new datacenter joined to the existing cluster. Deploy the 0.6.1 Cassandra nodes with the same cluster name as the existing cluster, a distinct datacenter name, seeds that reach the existing datacenter, and
auto_bootstrap: falseso the new nodes join without streaming during bootstrap. Do not run the schema-initialization or migration jobs yet. The schema already exists in the cluster, and the new nodes receive it through gossip. Disable both jobs in the new datacenter’s values withcassandra.hooks.initializeCluster.enabled: falseandcassandra.hooks.migrations.enabled: false. Keep them disabled until the new datacenter is included in the application and migration-state keyspaces in step 3. -
Confirm both datacenters are visible and healthy from a node in either datacenter:
Every node should report
UN. The new datacenter nodes appear with no or minimal load until the rebuild in step 4. -
Extend replication for every application keyspace,
schema_migrations,system_auth,system_distributed, andsystem_tracesto include the new datacenter. Replicatingschema_migrationspreserves the version and dirty state that the 0.6.1 migration job uses to apply only pending migrations. For each keyspace: -
On each node in the new datacenter, stream the existing data across:
-
Run the pending 0.6.1 schema migrations before moving clients. Keep cluster initialization disabled and enable only the migration hook:
Apply the Cassandra release and wait for its migration job:
The logs must end with
All Cassandra migrations completed successfully. Do not continue if the job failed or timed out. -
Inventory application keyspace replication after the migration job:
For each application keyspace that does not list both datacenters, update its replication:
Run the
system_schema.keyspacesquery again. Confirm that every application keyspace lists both datacenters before continuing.If a newly created keyspace already contains data, rebuild that keyspace on each new-datacenter node before continuing:
-
Confirm the migration state is clean:
Run the second query for each table returned by the first query. Each query must return one record with
dirtyset tofalse. This confirms that the cluster can receive later schema migrations. Do not move clients or remove the old datacenter while a migration is missing or dirty. -
Move clients to the new datacenter. Point application traffic at the new datacenter using
LOCAL_QUORUMagainst the new datacenter name, and confirm reads and writes succeed there. -
Remove the old datacenter from replication, then decommission it. Alter every keyspace again to drop the old datacenter from the replication map, then decommission the old-datacenter nodes and remove the old stack.
Method: in-place volume adoption
Reuse the existing data volumes with the new stack. The StatefulSet must be recreated because its shape is immutable, and the new pods must be pointed at the Bitnami on-disk layout.
The StatefulSet recreate step deletes the StatefulSet object but keeps its pods
and PersistentVolumeClaims. Do not delete the PersistentVolumeClaims. Confirm
the StatefulSet’s persistentVolumeClaimRetentionPolicy.whenDeleted is not
Delete before deleting it.
Use persistence.subPath: data to expose the existing Bitnami layout at the
paths the official image expects. This procedure does not relocate data files.
Review the saved Cassandra configuration before continuing. Custom cluster
names, datacenters, TLS, storage paths, or Cassandra settings need matching
chart values and a site-tested procedure; do not assume defaults are compatible.
-
In the target
environments/$HELMFILE_ENV.yaml, merge this value into the existingcassandrasection: -
Render the site’s target Cassandra and OpenBao charts before stopping any old pod. Keep this output private because it contains credentials. The checker verifies the replica count, subPath, cluster/datacenter names, released runtime overrides, and preserved superuser/service credentials. The OpenBao render verifies the shared service credential; it does not apply or restart OpenBao.
-
Recheck the original members and every off-node archive immediately before adoption. Require a fresh, clean ledger and the same account baseline.
The StatefulSet controller recreates
cassandra-0and replaces the remaining pods in reverse ordinal order. Do not delete those pods manually. A failed install or timeout stops the procedure even if a pod later becomes Ready. Keep the PVCs and backups and inspect the ring, events, and hook logs. -
Continue to Verify Cassandra. A new Ready pod or a successful Helm command alone does not establish adoption.
Method: backup and restore
Leave the existing cluster in place and load its data into a fresh 0.6.1 cluster.
-
Snapshot the existing cluster: on every node, run
nodetool flushthennodetool snapshot, and copy the snapshots off-node. -
Deploy a fresh 0.6.1 Cassandra cluster on new volumes and let the init and migration jobs create the schema.
-
Restore the data into the new cluster with
sstableloader, or place the snapshot sstables and runnodetool refreshper table. -
Verify row counts and application connectivity against the new cluster, then decommission the old cluster.
Verify Cassandra before continuing
For in-place adoption, require all three new pods on the target image and StatefulSet revision, the same original PVC UIDs/PVs and Cassandra host IDs, and the same healthy ring. All original pods must have been replaced. For a separately tested datacenter or restore migration, use that procedure’s identity mapping instead; the in-place identity comparison does not apply to new volumes.
Do not proceed if these commands fail. Count equality is a bounded baseline check, not proof that every table survived. Confirm that the original function and its deployment are still retrievable through your existing client.
Apply the remaining 0.6.1 stack
The Cassandra selector leaves other releases at their old versions. After Cassandra verification, render the full target stack with the same site files and review the changes. The template contains secrets; keep it in the private backup directory. Clear an inherited selector explicitly on the full install.
Check the render against your source configuration before running the next
block. Preserve the Cassandra subPath and credentials and OpenBao OnDelete
strategy. Do not restart OpenBao at this stage. Save the existing OpenBao pod
UIDs and live images for the required continuation below.
The release comparison requires every enabled target release to be deployed
with its expected chart version. It includes optional releases when enabled;
it does not compare unrelated Helm releases. Recheck application readiness,
the original function, and fresh authentication. This command updates the
control-plane bundle, not the separate compute-plane or observability bundles.
Continue through the OpenBao 0.6.2 patch
The full 0.6.1 apply updates the OpenBao StatefulSet template to
2.5.5-nv-1.3.1. Its OnDelete strategy leaves existing server pods running
2.5.4-nv-1.3.0 until they are replaced. A deployed Helm release does not mean
those running servers have upgraded.
Compare the template and the actual server and auto-unseal container images:
Do not restart or delete OpenBao server pods, reload the JWT plugin, or change the update strategy at 0.6.1. The old plugin catalog must be refreshed before new binaries can start safely. Keep the healthy existing members running and continue directly to the 0.6.1 to 0.6.2 procedure, which detects inherited old pods even when the target template is unchanged, refreshes the catalog, and replaces standbys before gracefully replacing the active member.
If a member has already restarted, is sealed, or cannot issue fresh JWTs, stop and assess that state before continuing. Do not delete another member to recover. The overall upgrade is complete only after the 0.6.2 runtime, per-pod revision, Raft, authentication and invocation checks pass.