Changes:
Update to immuta-deploy-tools v2.4.6
Optimized memory usage when restoring database backups
Optimized disk usage when creating database backups
Added extraEnv and extraVolumeMounts to web service init containers
Added support for custom annotations for ConfigMaps and Secrets
Changes:
Web Service port is now configurable
Update to immuta-deploy-tools v2.4.4
Only allow privileged users to drop and create database during restore
Only connect to Postgres database during restore when running as a superuser
Fix:
Fixed bug where Google Cloud credentials were not properly mounted during restore process
Changes:
Added support for <component>.image.digest to allow image digests to be used instead of image tags.
Added endpointslices to built-in Ingress Controller Role.
Fix:
No longer deploy database-initialize resources when restore is disabled.
Google Cloud Secret Key is no longer referenced when restore is disabled.
Changes:
Update to immuta-deploy-tools v2.4.3
Fix:
Fix malformed YAML error during generation of database-initialize hook manifest when backup.restore.enabled is true
Fix:
Update to immuta-deploy-tools v2.4.2
Adds support for Azure managed identities.
Support non-superuser restore from backup taken by a superuser.
Changes:
Support for Query Engine rehydration.
Use queryEngine.rehydration.enabled
Deprecate openSSLConfig in favor of openSSLConfigMapName.
Where openSSLConfigMapName is an existing Configmap that's managed outside of Helm, but located in the same namespace.
Do not manage external database backup/restore process when a superuser is not set.
Deprecate externalDatabase.backup.enabled and externalDatabase.restore.enabled
Use backup.enabled and backup.restore.enabled.
Fix:
Update immuta-deploy-tools to v2.3.1
Vulnerability fixes
Fix:
Update to immuta-deploy-tools v2.3.0
Fixed bug where backup files would be cleaned up based on Last Modified Date instead of the timestamp in the filename.
Vulnerability fixes
Changes:
All replica counts default to 1
Database Migrations execute as init-container for internal and external metadata
Enabled Patroni Failsafe mode by default
Persistence is enabled by default
Deprecate HA Redis Cache feature
Deprecate hooks.databaseMigration and hooks.databaseInitialize.initVars
Deprecate ingressClass
Use web.ingress.ingressClassName or web.ingress.annotation instead
Immuta Helm 4.11.1 includes bug fixes and stability improvements.
Fix:
Update to immuta-deploy-tools v2.2.0.
Fixed bug where database migrations failed to execute on databases not named bometadata.
Only set automountServiceAccountToken on Pods when rbac.create is enabled.
Immuta Helm 4.11.0 includes bug-fixes for database backups.
Update:
Update immuta-deploy-tools image to v2.1.9.
Immuta Helm Chart 4.10.0 contains bug fixes and stability improvements.
Fix:
Update immuta-deploy-tools to v2.1.8.
Default to Immuta 2022.4.1.
Backups failed when tls.enabled was set to false.
extraEnv processing returned null if valueFrom was used instead of value.
Use tls-secret.type of kubernetes.io/tls when nginxIngress.enabled is set to false.
Base Web Ingress annotations couldn't be removed or overridden.
Couldn't disable external TLS while leaving internal TLS enabled.
Couldn't restore from a specific backup file in Helm Chart.
Immuta Helm backup failed when storageClass did not support ReadWriteMany.
Couldn't enable database restores by default on new Helm deployments.
Fix regression when using max-backup-count for database backups.
Update:
Kubernetes 1.24 support.
Increase default Patroni log level to INFO instead of WARNING.
Immuta Helm 4.9.7 includes bug-fixes for external metadata database migrations.
Update:
Update immuta-deploy-tools image to v2.1.7.
Default to Immuta 2022.3.1.
Immuta Helm 4.9.6 includes bug-fixes for external metadata database migrations.
Update:
Update immuta-deploy-tools image to v2.1.6.
Support Immuta 2022.3.0.
Immuta Helm 4.9.5 includes bug-fixes for external metadata db and backups.
Update:
Update immuta-deploy-tools image to v2.1.5.
Default to Immuta 2022.1.1.
Fix:
Fix TLS behavior when external is disabled.
Fix restore when specifying backup file.
Fix backup.maxBackupCount behavior. A previous version introduced a regression that ignored the value.
Immuta Helm 4.9.3 includes bug-fixes and small database initialization configuration updates.
Update:
Support passing database initialization variables to immuta-deploy-tools.
Fix:
Fix backup.restore.allowMissingArchive value reference typo.
Fix validation logic for external database passwords when existingSecret is specified.
Helm 4.9.2 adds functionality to improve security context granularity.
Update:
Default to Immuta 2022.1.0.
Remove service token auto mounting.
Deprecate <component>.securityContext in favor of <component>.podSecurityContext.
Granular security context support.
Immuta Helm 4.9.0 includes bug-fixes and updates to various components.
Update:
Update immuta-deploy-tools image to v2.1.4
Fix:
Do not create or mount volume to /var/lib/immuta for older versions of Immuta (<2022.1.0)
Immuta Helm 4.8.1 includes bug-fixes and enables some use-cases that were previously blocked.
Update:
Add volume to support uploading Immuta plugins for restricted OpenShift security contexts.
Add support for custom Azure blob domain for backups.
Fix:
Use credentials from existing secret when creating backups.
Remove validation requirement for external database passwords when an existing secret is provided.
Set Patroni config environment variable for interactive shell sessions.
Don't create an ODBC volume (/var/lib/immuta/odbc) for older versions of Immuta (< 2021.4.0).
This release includes changes to support deploying Immuta on OpenShift and updates the built-in Ingress-Nginx controller to support Kubernetes 1.22+.
It is now possible to deploy the Immuta Helm Chart on OpenShift Kubernetes clusters. For more details see Deploy Immuta on OpenShift.
The Ingress-Nginx controller has been updated from v0.x to v1.x in order to support Kubernetes 1.22+. Due to breaking changes, the v1 release of Ingress-Nginx does not support Kubernetes versions older than 1.19. Users who have existing deployments on older Kubernetes clusters can set nginxIngress.controller.image.tag=v0.49.3 in the Immuta Helm values.
Update:
Upgrade Ingress-Nginx controller to v1.1.0.
Creation of Ingress resources can now be disabled.
Support configuring Patroni to use ConfigMaps for leader election (required for deployment on OpenShift).
Added pod anti-affinity rules for Redis cache Pods.
Allow annotations to be set on the Query Engine client Service.
Add Helm value cache.updateStrategy to allow update strategy to be set for cache workloads.
Fix:
Fix for database restores from blob storage into an external database.
Fix for backup SecurityContext overrides not taking effect.
This release includes new features and other changes intended to improve the usability of the Immuta Helm Chart.
New features include the ability to use an external PostgreSQL database for Immuta metadata and the option to use Redis as a cache. Other notable improvements are the ability to set a global image registry override, support for the PodSecurityPolicy RunAsUser rule MustRunAsNonRoot, configurable SecurityContext runAsUser settings for most components, and support for Kubernetes API resources that have moved out of beta.
It is now possible to use an external PostgreSQL instance as the Immuta Metadata Database when running Immuta in Kubernetes. When enabled, this functionality replaces the built-in PostgreSQL metadata database that runs in Kubernetes. This functionality is enabled by setting database.enabled=false and passing the connection information for the PostgreSQL instance under the key externalDatabase.
For existing deployments it is possible to migrate from the built-in database to an external database. In order to migrate, backups must be configured, and a backup should be taken immediately prior to migrating. The process of migrating can be done by running helm upgrade with the external database Helm values and backup.restore.enabled=true.
This functionality is compatible with Immuta 2021.3+.
There is now the option to use Redis as the cache implementation for Immuta. The primary motivation for offering this option is to enable the use of TLS for network traffic between the Immuta web service and cache pods.
In order to select Redis as the cache implementation for Immuta, set the Helm value cache.type=redis when installing the Immuta Helm Chart.
TLS is enabled for internal network traffic by default when Redis is used, so unless tls.enabledInternal=false is set, TLS will be used for network traffic between Immuta and Redis.
When Redis is selected as the cache for Immuta, the Immuta Web Service pods will contain an additional container that runs envoy as an ambassador sidecar; the envoy container is named "cache-proxy-sidecar." In this configuration, kubectl logs commands must include the flag --container=service in order to access logs for the Immuta Web Service.
It is now possible to configure the container image registry globally for all images referenced by the Immuta Helm Chart.
The default value for global.imageRegistry is registry.immuta.com.
Immuta images are referenced relative to the configured image registry by adding the repository prefix immuta/, for example registry.mycorp.com/immuta/immuta-service.
Third-party images are referenced without the immuta/ prefix. The images that this applies to are
ingress-ngnix-controller
memcached
redis
envoyproxy-envoy-alpine
If these images are not available in the custom registry under the root prefix, it is possible to configure the image repository. This may be the case if you have pulled these images and pushed them to your registry under the immuta/ prefix.
MustRunAsNonRoot PoliciesInit containers for initializing database and Query Engine persistent volumes no longer run as root. In addition to increasing overall security by running init containers as an unprivileged user, this also means that Immuta is now compatible with the PodSecurityPolicy RunAsUser rule MustRunAsNonRoot or other similar policies.
runAsUser for Most ComponentsThe Pod SecurityContext is now configurable for all components except for Nginx Ingress. This means that the user ID that the Pods run as can now be customized by setting securityContext.runAsUser for the components that support it. The following table shows which components are configurable for various Immuta versions.
The resources created by the Immuta Helm Chart will now use stable versions of the following resources when they are available on the Kubernetes cluster.
networking.k8s.io/v1 for Ingress resources.
batch/v1 for CronJob resources.
policy/v1 for PodDisruptionBudget resources.
Upgrading to 4.7.0 from 4.6 should be possible with minimal or no changes to the Helm values. The following section identifies any caveats or recommendations that should be taken into account when upgrading.
helm upgrade --reuse-values not supported for upgrade from 4.6 to 4.7Due to changes in the Chart's default values.yaml file, helm upgrade --reuse-values does not work. If you have a saved values file, use that when calling helm upgrade. If you don't have a saved values file, you can use helm get values to save the Helm values locally before calling helm upgrade.
Some values have been deprecated in this release. The following table indicates the deprecated values and the migration path for each one. Update any custom Helm values referencing the deprecated values at the earliest convenience to avoid any issues when the deprecated values are removed.
Update Kubernetes Batch API versions.
Update Kubernetes Networking API versions.
Update Kubernetes Policy API versions.
Startup init container checks now have a time out.
Support for disabling built-in database and using an external database.
Database and Query Engine initContainers no longer run as root.
Runtime user ID is now configurable for all Pods except Nginx Ingress.
Added shared memory volume for Database and Query Engine by default.
It is now possible to set a Docker image registry globally in Helm values.
The environment variable noproxy will now be configured such that internal network connections do not use the proxy if extraEnv values are used to set HTTP_PROXY or HTTPS_PROXY.
Added option to deploy Redis with TLS instead of Memcached for the cache.
Fix:
Database and Query Engine Pods now crash and restart when the backup restore process fails.
The TLS generation hook will now regenerate TLS certs if the externalHostname value changes.
This release makes it possible to increase the size of /dev/shm in the Database and Query Engine Pods. This functionality makes use of memory-backed emptyDir Volumes.
Update:
Add support for memory-backed volumes to increase the size of /dev/shm.
Update Helm Chart appVersion to 2021.3.5.
This release includes an update to the default image tag for the bundled Nginx Ingress Controller.
The ingress-nginx project has released a few updates since v0.47.0. This release updates the default version to v0.49.3, which includes an update to Alpine Linux v3.14.2. This update addresses CVE-2021-3711, which v0.47.0 was vulnerable to.
To upgrade the Nginx Ingress Controller without upgrading the Immuta Helm Chart, you can set the following Helm values.
Update:
Update Helm Chart appVersion to 2021.3.4.
Update ingress-nginx controller to v0.49.3.
This release updates the Immuta Helm Chart appVersion to 2021.2.2 and adds support for using an S3-compatible server for backup and restore. It also contains a fix for the metrics export CronJob in Immuta 2021.2+.
In order to use a custom S3 endpoint for backup and restore, new Helm values have been added. The example below shows how to configure an S3 compatible endpoint.
Update:
Update Helm Chart appVersion to 2021.2.2.
Add blob storage endpoint support for backup storage.
Fix:
Fix Metrics CronJob errors for Immuta 2021.2+
This release includes usability and stability improvements and an update to the bundled Nginx Ingress Controller. Usability improvements include the option to use an existing Kubernetes Secret for Immuta database passwords. Stability improvements include a change in configuration for the Immuta database and Query Engine StatefulSets.
This release adds the option to use an existing Kubernetes Secret for Immuta database passwords used in the Helm installation. Using an existing Secret can be useful when you want more control over the creation of the Secret or do not want to include the sensitive values in the Immuta Helm values file.
To use an existing Kubernetes Secret, you must first create a Secret containing the required data keys.
Note: This is an example showing the required data keys and some sample values. For more details on creating Secrets in Kubernetes, see the Kubernetes Documentation.
Reference the Secret by name in the Immuta Helm values.
If you have an existing release, you can migrate to an existing Kubernetes Secret by creating the Secret with the values previously defined in your Helm values by using the following mappings.
Set the existingSecret value and removing the password values from your Immuta Helm values file. Apply the change by running helm upgrade for your release, referencing the values file.
This release includes a change in the default settings for Patroni, which is used in the database and Query Engine StatefulSets. This setting has been shown to improve the stability of the StatefulSets when the pods are restarted frequently due to cluster operations, such as node upgrades.
For new installations, no action is necessary to make use of this configuration change. For existing installations, the change must be applied manually to the StatefulSet pods.
Note: Replace "RELEASE_NAME" with the name of your Immuta Helm release.
The ingress-nginx project released an update to mitigate a vulnerability in Nginx. We've updated the bundled ingress controller to this new release. More details are available in this GitHub issue.
Update:
Add support for using an existing Kubernetes Secret for passwords.
Enable use_pg_rewind for Patroni by default.
Update ingress-nginx controller to v0.47.0 to mitigate CVE-2021-23017.
This release updates versions for various components.
Update:
Update Helm Chart app version to 2021.2.0.
Update immuta-deploy-tools image to 1.1.2.
Update default ingress-nginx controller image to v0.46.0.
This release adds support for Immuta 2021.2 and to allow scaling Immuta web service pods to zero.
Update:
Update container uid and gid in securityContext for 2021.2.
Remove dependency on pgrep and getopt from scripts.
Allow web pod replicas to be set to zero.
This release updates the default Immuta version to 2021.1.3 and the default memcached image tag to 1.6-alpine.
Update:
Update memcached image to 1.6-alpine.
This release contains a fix for an issue where setting resource requests and limits was not possible for some containers created by the Immuta Helm Chart.
Fix:
Set configurable resource limits for all containers and init containers
This release contains updates that enable the configuration of options that were previously not exposed in the Helm Chart.
The Immuta Fingerprint service configuration can now be set in Helm values. For example, to set the worker_timeout option to a value of 300, set the following values.
The log level for the Immuta Fingerprint service can also be configured. Valid values include DEBUG, INFO, WARNING, ERROR, and CRITICAL.
Feature:
Add ability to pass in configuration for Immuta Fingerprint service
Fix:
Add port 8008 to Database and Query Engine Endpoints
When upgrading to 4.6.2 with nginxIngress.enabled set to true, a new ConfigMap was introduced to be used by the NGINX Ingress Controller for leader election. This will cause the old ConfigMap, named ingress-controller-leader-immuta-<RELEASE>-ingress, to be orphaned. This will not affect the operation of Immuta and may be removed by running
Fix:
When using --reuse-values coming from 4.5.x charts, extraEnv value throws a templating error.
Use Immuta config item publicPostgres.useSSL instead of publicPostgres.ssl starting with Immuta Version 2020.3.
Adopt nginx-ingress leader election ConfigMap into the chart when using Optional Ingress Controller component.
Feature:
Set log_error_verbosity = TERSE in Postgres configuration.
Update default version to 2020.4.0.
Add port 8008 to primary database and query-engine services.
Add ability to set annotations on all service accounts.
Set .spec.terminationGracePeriodSeconds for all Immuta pods.
Update Query Engine readiness and liveness probes to use Patroni REST API endpoints.
Update Database readiness and liveness probes to use Patroni REST API endpoints.
Fix:
Database password is no longer used in Query Engine init-container.
Feature:
Add support for LDAPS-backed Query Engine Authentication.
Fix:
Web Service pods now wait for database migrations to execute before startup.
This release contains a fix for a race condition introduced in 4.5.3 when performing a new install.
Fix:
Removed Endpoint resource for Database and Query Engine components to prevent race condition with Service. Endpoints are now created by Database and Query Engine Service resource.
This release contains a few fixes and updates the default Immuta application version to 2020.2.8.
Feature:
Update appVersion to 2020.2.8.
Fix:
Support EndpointSlices for Database and Immuta Query Engine in Kubernetes 1.17+.
This release contains a few fixes and updates the default Immuta application version to 2020.2.7.
Feature:
Update appVersion to 2020.2.7.
Update default values for Immuta Query Engine to support Elastic.
Fix:
Helm hooks fail to run with helm older than 3.2.0.
TLS Ciphers used in NGINX Ingress Controller incompatibility with default TLS cipher suites set in Databricks.
This release contains a fix for a bug introduced with the last release that caused helm install to timeout and fail when used with the --wait flag.
If you are using Argo CD to deploy the Immuta Helm Chart, then you may notice that the TLS secret will be marked OutOfSync (requires pruning). The TLS secret (which is used for the encryption of inter-pod network traffic) should not be pruned. Update the Helm values with the following so that the TLS secret can be monitored as a resource without the risk of unwanted pruning.
Fixes:
Fix issue with TLS generation and the helm install --wait flag.
The Immuta Helm Chart now supports deployment using Argo CD. Prior to this, the TLS generation hook would create a Secret that was not tracked by Helm. In Argo CD this resource would appear to need pruning. There was also an issue with the database and Query Engine endpoints, in which they would appear to be out of sync, but syncing them would remove the runtime changes that were being applied by Patroni. These issues have been resolved, and Argo CD is now supported.
For Argo CD versions older than 1.7.0 you must use the following Helm values in order for the TLS generation hook to run successfully.
Starting with Argo CD version 1.7.0 the default Immuta Helm Chart values can be used.
The bundled version of ingress-nginx has been upgraded to 0.34.1. In addition to upgrading the default version, the cluster scoped resources that used to be created (ClusterRole and ClusterRoleBinding) are no longer required and have been removed.
Setting the Helm value nginxIngress.controller.service.isInternal will now cause an internal Azure load balancer to be created for nginx ingress.
externalTrafficPolicyA new value was added to set the externalTrafficPolicy on the nginx ingress Service. Setting this value to "Local" can be useful for preserving client IP addresses. See the Kubernetes Documentation for more information on preserving the client source IP.
When upgrading an existing Helm release from chart version <=4.4 that was using the default values tls.enabled=true and tls.create=true, you must first annotate and label the Immuta TLS Secret so that it can be adopted by Helm.
You will need to complete these steps if you encounter either of the following errors when running the helm upgrade command.
To resolve these upgrade errors, run the following commands, being sure to substitute the proper Helm release name and namespace.
After this, you can proceed to run helm upgrade.
Feature:
Refactored Helm Chart hooks to work with Argo CD.
Updated Helm Chart description.
Update web pod annotations so that password changes cause a rolling restart.
Upgrade ingress-nginx to 0.34.1.
Support setting externalTrafficPolicy on the nginx ingress Service.
Update nginx ingress Service to include Azure annotations.
Bug:
Fix issue with release names that contain periods.
Bug:
Fix fingerprint configuration when TLS is disabled.
It is now possible to set pod annotations and labels at a global level. When set, these labels and annotations will be used for all pods that the Immuta Helm Chart creates. Pod labels and annotations can be set using the Helm values global.podAnnotations and global.podLabels to a map of string to string.
Labels and annotations can also be set individually for each component in the Immuta Helm Chart. To set labels and annotations for an individual component, set the Helm values <componentName>.podAnnotations and <componentName>.podLabels to a map of string to string.
Feature:
Support labels/annotations on all pods.
Bug:
Fix for Query Engine pod referencing image repository from database values.
Cleanup:
Remove the option to configure Data Source CA certificates using a ConfigMap.
nodeSelector and tolerationsIt is now possible to set custom nodeSelector and tolerations for each component in the Immuta Helm Chart.
To set a custom nodeSelector, set the Helm value for <componentName>.nodeSelector to a valid nodeSelector. See the Kubernetes documentation for more details.
To set a custom tolerations, set the Helm value for <componentName>.tolerations to a valid tolerations. See the Kubernetes documentation for more details.
Feature:
Support setting nodeSelector and tolerations on all pods.
| New Setting | Description |
|---|---|
| New Setting | Description |
|---|---|
| Immuta Version | Components |
|---|---|
| Deprecated Value | Replacement Value |
|---|---|
| Helm Value | Secret Data Key |
|---|---|
hooks.databaseInitialize.initVars
Key/value dictionary of variables passed to database initialization process.
podSecurityContext
Pod level security features on all pods.
containerSecurityContext
Container level security features on all containers.
<component>.podSecurityContext
Pod level security features for individual component.
<component>.containerSecurityContext
Container level security features for individual component.
Any
backup, cache
2021.2+
backup, cache, fingerprint
2021.4+
backup, cache, database, fingerprint, queryEngine, web
configHook.imageRepository
deployTools.image.registry and deployTools.image.repository
configHook.imageTag
deployTools.image.tag
configHook.imagePullPolicy
deployTools.imagePullPolicy
database.imageRepository
database.image.registry and database.image.repository
database.imageTag
database.image.tag
fingerprint.imageRepository
fingerprint.image.registry and fingerprint.image.repository
fingerprint.imageTag
fingerprint.image.tag
memcached.imagePullPolicy
cache.memcached.imagePullPolicy
memcached.imageRepository
cache.memcached.image.registry and cache.memcached.image.repository
memcached.imageTag
cache.memcached.image.tag
memcached.nodeSelector
cache.nodeSelector
memcached.podAnnotations
cache.podAnnotations
memcached.podLabels
cache.podLabels
memcached.replicas
cache.replicas
memcached.resources
cache.resources
memcached.tolerations
cache.tolerations
memcached.maxItemMemory
cache.memcached.maxItemMemory
queryEngine.imageRepository
queryEngine.image.registry and queryEngine.image.repository
queryEngine.imageTag
queryEngine.image.tag
web.imageRepository
web.image.registry and web.image.repository
web.imageTag
web.image.tag
database.password
databasePassword
database.patroniApiPassword
databasePatroniApiPassword
database.replicationPassword
databaseReplicationPassword
database.superuserPassword
databaseSuperuserPassword
queryEngine.password
queryEnginePassword
queryEngine.patroniApiPassword
queryEnginePatroniApiPassword
queryEngine.replicationPassword
queryEngineReplicationPassword
queryEngine.superuserPassword
queryEngineSuperuserPassword