Migrating to the New Helm Chart
This guide demonstrates how to upgrade an existing Immuta deployment installed with the older Immuta Helm chart (IHC) to v2024.2 LTS using the Immuta Enterprise Helm chart (IEHC).
Helm chart deprecation notice
As of Immuta version 2024.2, the IHC has been deprecated in favor of the IEHC. Their respective immuta-values.yaml
Helm values files are not compatible.
Prerequisites
Create a PostgreSQL database
The PostgreSQL instance has been provisioned and is actively running.
The PostgreSQL instance's hostname/FQDN is resolvable from within the Kubernetes cluster.
The PostgreSQL instance is accepting connections.
For additional information, consult the Deployment requirements.
Validate the Helm release
Fetch the metadata for the Helm release associated with Immuta.
helm get metadata --output yaml <helm-release-name>
Review the output from the previous step and verify the following:
The Immuta version (
appVersion
) isThe last LTS (2022.5.x) or 2024.1 or newer
Less than 2024.2
The Immuta Helm chart (
version
) is greater than or equal to 4.13.5The Immuta Helm chart name (
chart
) isimmuta
If any of the criteria is not met, it's first necessary to perform a Helm upgrade using the IHC. Contact your Immuta representative for guidance.
Metadata database
The new IEHC no longer supports deploying a Metadata database (PostgreSQL) inside the Kubernetes cluster. Before transitioning to the new IEHC, it's first necessary to externalize the Metadata database.
Built-in
The following demonstrates how to take a database backup and import the data into each cloud provider's managed PostgreSQL service.
Create backup of old database
Get the metadata database pod name.
kubectl get pod --selector "app.kubernetes.io/component=database" --output name
Spawn a shell inside the running metadata database pod.
kubectl exec --stdin --tty <metadata-database-pod-name> -- sh
Perform a database backup.
pg_dump --dbname=bometadata --file=/tmp/bometadata.dump --format=custom --no-owner --no-privileges
Type
exit
, and then pressEnter
to exit the shell prompt.Copy file
bometadata.dump
from the pod to the host's working directory.kubectl cp <metadata-database-pod-name>:/tmp/bometadata.dump .
Setup new database
Create a pod named
immuta-setup-db
and spawn a shell.kubectl run immuta-setup-db --stdin --tty --rm --image docker.io/bitnami/postgresql:latest -- sh
Connect to the new PostgreSQL database as a superuser. Depending on the cloud provider, the default superuser name (
postgres
) might differ.psql --host <postgres-fqdn> --username postgres --port 5432 --password
Create
immuta
,temporal
, andtemporal_visiblity
databases and animmuta
role.CREATE ROLE immuta with login encrypted password '<postgres-password>'; GRANT immuta TO CURRENT_USER; CREATE DATABASE immuta OWNER immuta; CREATE DATABASE temporal OWNER immuta; CREATE DATABASE temporal_visibility OWNER immuta; GRANT all ON DATABASE immuta TO immuta; GRANT all ON DATABASE temporal TO immuta; GRANT all ON DATABASE temporal_visibility TO immuta; ALTER ROLE immuta SET search_path TO bometadata,public; REVOKE immuta FROM CURRENT_USER;
Type
\q
, and then pressEnter
to exit the psql prompt.Authenticate as the
immuta
user and create the pgcrypto extension.psql --host <postgres-fqdn> --username immuta --port 5432 --password CREATE EXTENSION pgcrypto;
Type
\q
, and then pressEnter
to exit the psql prompt.
Restore backup to new database
Create a pod named
immuta-restore-db
and spawn a shell.kubectl run immuta-restore-db --image docker.io/bitnami/postgresql:latest -- sleep infinity
Copy file
bometadata.dump
from the host's working directory to podimmuta-restore-db
.kubectl cp bometadata.dump immuta-restore-db:/tmp
Spawn a shell inside pod
immuta-restore-db
.kubectl exec immuta-restore-db --stdin --tty -- sh
Perform a database restore while authenticated as role
immuta
. Refer to the value substituted for<postgres-password>
when prompted to enter a password.pg_restore --host=<postgres-fqdn> --port=5432 --username=immuta --password --dbname=immuta --no-owner --role=immuta < /tmp/bometadata.dump
Type
exit
, and then pressEnter
to exit the shell prompt.Delete pod
immuta-restore-db
that was previously created.kubectl delete pod/immuta-restore-db
External
No additional work is required. The existing database can be reused with the new IEHC.
Helm values
Rename the existing
immuta-values.yaml
Helm values file used by the IHC.mv immuta-values.yaml immuta-values.ihc.yaml
Follow the installation guide for your Kubernetes distribution of choice.
Last updated
Was this helpful?