Managed Public Cloud

This is a guide on how to deploy Immuta on Kubernetes in the following managed public cloud providers:

• Amazon Web Services (AWS)

• Microsoft Azure

• Google Cloud Platform (GCP)

Prerequisites

The following managed services must be provisioned and running before proceeding. For further assistance consult the recommendations table for your respective cloud provider.

Feature availability

If deployed without ElasticSearch/OpenSearch, several core services and features will be unavailable. See the deployment requirements for details.

Amazon Web Services (AWS)

• Amazon RDS for PostgreSQL

• (Optional) Amazon OpenSearch

Microsoft Azure

Google Cloud Platform (GCP)

Checklist

This checklist outlines the necessary prerequisites for successfully deploying Immuta.

Credentials

• You have the credentials needed to access the ocir.immuta.com OCI registry. These can be viewed in your user profile at support.immuta.com.

PostgreSQL

• The PostgreSQL instance's hostname/FQDN is resolvable from within the Kubernetes cluster.

• The PostgreSQL instance is accepting connections.

• You have a PostgreSQL user account with the necessary privileges to create databases, extensions, and roles.

• The Helm chart only supports username/password authentication for PostgreSQL. At this time, other authentication mechanisms are not supported.

Elasticsearch

• The Elasticsearch instance's hostname/FQDN is resolvable from within the Kubernetes cluster.

• The Elasticsearch instance is accepting connections.

• The user must have the required permissions.

• The Helm chart supports the following authentication methods for Elasticsearch. At this time, other authentication mechanisms are not supported:

  • Username and password

  • AWS assumed role for OpenSearch

Setup

Helm

Authenticate with OCI registry

echo <token> | helm registry login --password-stdin --username <username> ocir.immuta.com

Kubernetes

Creating a dedicated namespace ensures a logically isolated environment for your Immuta deployment, preventing resource conflicts with other applications.

Create namespace

1. Create a Kubernetes namespace named immuta.

   kubectl create namespace immuta

2. Switch to namespace immuta. All subsequent kubectl commands will default to this namespace.

   kubectl config set-context --current --namespace=immuta

Create registry secret

Create a container registry pull secret. Your credentials to authenticate with ocir.immuta.com can be viewed in your user profile at support.immuta.com.

kubectl create secret docker-registry immuta-oci-registry \
    --docker-server=https://ocir.immuta.com \
    --docker-username="<username>" \
    --docker-password="<token>" \
    [email protected]

PostgreSQL

Connecting a client

There are numerous ways to connect to a PostgreSQL database. This step demonstrates how to connect with psql by creating an ephemeral Kubernetes pod.

Connect to the database

Connect to the database as an admin (e.g., postgres) by creating an ephemeral container inside the Kubernetes cluster. A shell prompt will not be displayed after executing the kubectl run command outlined below. Wait 5 seconds, and then proceed by entering a password.

kubectl run pgclient \
    --stdin \
    --tty \
    --rm \
    --image docker.io/bitnami/postgresql -- \
    psql --host <postgres-fqdn> --username <postgres-admin> --dbname postgres --port 5432 --password

Create role

Temporal's upgrade mechanism utilizes SQL command CREATE EXTENSION when managing database schema changes. However, in cloud-managed PostgreSQL offerings, this command is typically restricted to roles with elevated privileges to protect the database and maintain the stability of the cloud environment.

To ensure Temporal can successfully manage its schema, an administrator role must be granted temporarily. The role name varies depending on the cloud-managed service:

• Amazon RDS: rds_superuser

• Azure Database: azure_pg_admin

• Google Cloud SQL: cloudsqlsuperuser

1. Create the immuta role.

   CREATE ROLE immuta with LOGIN ENCRYPTED PASSWORD '<postgres-password>';
   ALTER ROLE immuta SET search_path TO bometadata,public;

2. Grant administrator privileges to the immuta role. Upon successfully completing this installation guide, you can optionally revoke this role grant.

   GRANT <admin-role> TO immuta;

3. Grant the immuta role to the current user. Upon successfully completing this installation guide, you can optionally revoke this role grant.

   GRANT immuta TO CURRENT_USER;

Create databases

1. Create databases.

   CREATE DATABASE immuta OWNER immuta;
   CREATE DATABASE temporal OWNER immuta;
   CREATE DATABASE temporal_visibility OWNER immuta;

2. Grant role immuta additional privileges. Refer to the PostgreSQL documentation for further details on database roles and privileges.

   GRANT ALL ON DATABASE immuta TO immuta;
   GRANT ALL ON DATABASE temporal TO immuta;
   GRANT ALL ON DATABASE temporal_visibility TO immuta;

3. Configure the immuta database.

   \c immuta
   CREATE EXTENSION pgcrypto;

4. Configure the temporal database.

   \c temporal
   GRANT CREATE ON SCHEMA public TO immuta;

5. Configure the temporal_visibility database.

   \c temporal_visibility
   GRANT CREATE ON SCHEMA public TO immuta;
   CREATE EXTENSION btree_gin;

6. Exit the interactive prompt. Type \q, and then press Enter.

Install Immuta

This section demonstrates how to deploy Immuta using the Immuta Enterprise Helm chart once the prerequisite cloud-managed services are configured.

Feature availability

If deployed without Elasticsearch/OpenSearch, several core services and features will be unavailable. See the deployment requirements for details.

Default

Audit record retention

Immuta defaults to keeping audit records for 7 days. To change this duration, set the following values in the immuta-values.yaml file. The example below configures audit records to be kept for 90 days:

audit:
  deployment:
      extraEnvVars:
        - name: AUDIT_RETENTION_POLICY_IN_DAYS
          value: "90"

immuta-values.yaml

global:
  imageRegistry: ocir.immuta.com
  imagePullSecrets:
    - name: immuta-oci-registry
  postgresql:
    host: <postgres-fqdn>
    port: 5432
    username: immuta
    password: <postgres-password>

audit:
  # If you use OpenSearch, uncomment the lines below by deleting the hash symbols
  #init:
    #extraEnvVars:
    #- name: ELASTICSEARCH_INIT_SHARDS
      #value: "5"
  config:
    elasticsearchEndpoint: <elasticsearch-endpoint>
    searchAuthenticationType: <'UsernamePassword' or 'AWS'>
  # If you use OpenSearch and authenticate with username and password, uncomment the lines below by deleting the hash symbols
    #elasticsearchUsername: <elasticsearch-username>
    #elasticsearchPassword: <elasticsearch-password>
  # If you use OpenSearch and authenticate with AWS role, uncomment the lines below by deleting the hash symbols
    #searchAwsRegion: '<deployment-OS-region>'
  # If Immuta is deployed in an AWS account that is different than OpenSearch, then you must configure a trust relationship between the Immuta role and an OpenSearch role 
    #searchAwsRoleArn: '<assumed-role-arn>'
  postgresql:
    database: immuta

secure:
  ingress:
    enabled: false
  postgresql:
    database: immuta
    ssl: true

temporal:
  enabled: true
  schema:
    createDatabase:
      enabled: false
  server:
    config:
      persistence:
        default:
          sql:
            database: temporal
            tls: 
              enabled: true
        visibility:
          sql:
            database: temporal_visibility
            tls:
              enabled: true

Without Elasticsearch

1. Create a file named immuta-values.yaml with the above content, making sure to update all placeholder values.

Avoid these special characters in generated passwords

whitespace, $, &, :, \, /, '

1. Deploy Immuta.

   helm install immuta oci://ocir.immuta.com/stable/immuta-enterprise \
       --values immuta-values.yaml \
       --version 2025.1.8

2. Wait for all pods to become ready.

   kubectl wait --for=condition=Ready pods --all

Validation

This section helps you validate your Immuta installation by temporarily accessing the application locally. However, this access is limited to your own computer. To enable access for other devices, you must proceed with configuring Ingress outlined in the Next steps section.

1. Determine the name of the Secure service.

   kubectl get service --selector "app.kubernetes.io/component=secure" --output name

2. Listen on local port 8080, forwarding TCP traffic to the Secure service's port named http.

   kubectl port-forward <service-name> 8080:http

3. In a web browser, navigate to localhost:8080, to ensure the Immuta application loads.

4. Press Control+C to stop port forwarding.

Next steps

Amazon Web Services (AWS)

• Configure Ingress for EKS (required).

• Configure TLS certificates for EKS.

• Learn about best practices for running Immuta in production.

Microsoft Azure

Google Cloud Platform (GCP)