For the complete documentation index, see llms.txt. This page is also available as Markdown.

Deploy Immuta without Elasticsearch

The guides below outline how to deploy Immuta without Elasticsearch.

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 cloud-managed services must be provisioned before proceeding:

Validation

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

  2. The PostgreSQL instance is accepting connections.

Authenticate with OCI registry

Copy the snippet below and replace the placeholder text with the credentials provided to you by your customer success manager:

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

Setup

  1. Create a Kubernetes namespace named immuta for Immuta.

  2. Switch to namespace immuta.

  3. 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.

PostgreSQL

Connecting to the database

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

  1. Connect to the database as superuser (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.

  2. Create an immuta role and database.

  3. Revoke privileges from CURRENT_USER as they're no longer required.

  4. Enable the pgcrypto extension.

  5. Type \q, and then press Enter to exit.

Install Immuta

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

  1. Create a Helm values file named immuta-values.yaml with the following content:

  2. Update all placeholder values in the immuta-values.yaml file.

  1. Deploy Immuta.

Validation

  1. Wait for all pods in the namespace to become ready.

  2. Determine the name of the Secure service.

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

Next steps

This is an OpenShift-specific guide on how to deploy Immuta with the following managed services:

  • Cloud-managed PostgreSQL

  • Cloud-managed Redis

Prerequisites

Review the following criteria before proceeding with deploying Immuta.

PostgreSQL

  1. The PostgreSQL instance has been provisioned and is actively running.

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

  3. The PostgreSQL instance is accepting connections.

Redis

  1. The Redis instance has been provisioned and is actively running.

  2. The Redis instance's hostname/FQDN is resolvable from within the Kubernetes cluster.

  3. The Redis instance is accepting connections.

Authenticate with OCI registry

Copy the snippet below and replace the placeholder text with the credentials provided to you by your customer success manager:

Setup

  1. Create a new OpenShift project named immuta for Immuta.

  2. Get the UID range allocated to the project. Each running container's UID must fall within this range. This value will be referenced later on.

  3. Get the GID range allocated to the project. Each running container's GID must fall within this range. This value will be referenced later on.

  4. Switch to project immuta.

  5. 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.

Cloud-managed PostgreSQL

Connecting to the database

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

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

  2. Create an immuta role and database.

  3. Revoke privileges from CURRENT_USER as they're no longer required.

  4. Enable the pgcrypto extension.

  5. Type \q, and then press Enter to exit.

Install Immuta

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

  1. Create a Helm values file named immuta-values.yaml with the content below. Because the Ingress resource will be managed by an OpenShift route you will create when configuring Ingress and not the Immuta Enterprise Helm chart, ingress is set to false below. TLS comes pre-configured with OpenShift, so tls is also set to false.

  2. Update all placeholder values in the immuta-values.yaml file.

  1. Deploy Immuta.

Validation

  1. Wait for all pods in the namespace to become ready.

  2. Determine the name of the Secure service.

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

Next steps

This is a generic guide that demonstrates how to deploy Immuta into any Kubernetes cluster without dependencies on any particular cloud provider.

Considerations

For the purposes of this guide, the PostgreSQL state stores are deployed in Kubernetes using third-party Helm charts maintained by Bitnami.

  • Operational overhead: Managing PostgreSQL on Kubernetes requires expertise in deploying, maintaining, and scaling these databases and search engines effectively. This involves tasks like setting up monitoring, configuring backups, managing updates, and ensuring high availability. Cloud-managed services abstract much of this operational burden away, allowing teams to focus on application development rather than infrastructure management.

  • Resource allocation and scaling: Kubernetes requires careful resource allocation and scaling decisions to ensure that PostgreSQL has sufficient CPU, memory, and storage. Properly sizing these resources can be challenging and may require continuous adjustments as workload patterns change. Managed services typically handle this scaling transparently and can automatically adjust based on demand.

  • Data integrity and high availability: PostgreSQL deployments need robust strategies for data integrity and high availability. Kubernetes can facilitate high availability through pod replicas and distributed deployments, but ensuring data consistency and durability across database instances and search indexes requires careful consideration and often additional tooling.

  • Performance: Kubernetes networking and storage configurations can introduce performance overhead compared to native cloud services. For latency-sensitive applications or high-throughput workloads, these factors become critical in maintaining optimal performance.

  • Observability: Troubleshooting issues in a Kubernetes environment, especially related to database and search engine performance, can be complex. Managed services typically come with built-in monitoring, logging, and alerting capabilities tailored to the specific service, making it easier to identify and resolve issues.

  • Security and compliance: Kubernetes environments require careful attention to security best practices, including network policies, access controls, and encryption. Managed services often come pre-configured with security features and compliance certifications, reducing the burden on teams to implement and maintain these measures.

Authenticate with OCI registry

Copy the snippet below and replace the placeholder text with the credentials provided to you by your customer success manager:

Setup

  1. Create a Kubernetes namespace named immuta for Immuta and its third-party dependencies.

  2. Switch to namespace immuta.

  3. 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.

PostgreSQL

  1. Create a Helm values file named pg-values.yaml with the following content:

  2. Update all placeholder values in the pg-values.yaml file.

  1. Deploy PostgreSQL.

  2. Wait for all pods in the namespace to become ready.

  3. Determine the name of the PostgreSQL database pod. This will be referenced in a subsequent step.

  4. Exec into the PostgreSQL database pod using the psql command and immuta user to configure the PostgreSQL user used by Immuta.

  5. Alter the search_path for the immuta user.

  6. Enable the pgcrypto extension.

  7. Type \q then press Enter to exit.

Install Immuta

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

  1. Create a Helm values file named immuta-values.yaml with the following content:

  2. Update all placeholder values in the immuta-values.yaml file.

  1. Deploy Immuta.

Validation

  1. Wait for all pods in the namespace to become ready.

  2. Determine the name of the Secure service.

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

  4. Navigate to http://localhost:8080 in a web browser.

Next steps

Last updated

Was this helpful?