Upgrade Notes

Upgrade notes

NOTE TEMPLATE

1. Change

Feature:

Feature description

Values deleted - chart name

Name	Reason
helm.value	Helm value deletion reason

Values added - chart name

Values section description

Name	Description	Value
helm.value	Helm value description	default value

Names changed - chart name

Old Name	New Name
old name	new name

⚠️⚠️⚠️ Warnings

Values changed - chart name

Name	Old value	New Value
helm.value	old value	new value

NEXT RELEASE

RELEASE 6.3.1

1. Added extra buckets to storage config

Feature

Added ability to include extra buckets to ilum cluster spark storage configuration.

Values added - ilum-core

Name	Description	Value
kubernetes.s3.extraBuckets	ilum-core default kubernetes cluster S3 storage extra buckets to include	[]
kubernetes.gcs.extraBuckets	ilum-core default kubernetes cluster GCS storage extra buckets to include	[]
kubernetes.wasbs.extraContainers	ilum-core default kubernetes cluster WASBS storage extra containers to include	[]
kubernetes.hdfs.extraCatalogs	ilum-core default kubernetes cluster HDFS storage extra catalogs to include	[]

2. Enhanced LDAP

Added the ability to map users, groups, and roles — along with their properties and relationships — from an LDAP server to Ilum Core based on mapping configurations in Helm. Enabled the option to assign Admin role to LDAP users.

Values added - ilum-core

Name	Description	Value
security.ldap.userMapping.base	LDAP base of user entries	""
security.ldap.userMapping.filter	LDAP filter used for users search	"uid={0}"
security.ldap.userMapping.username	Name of LDAP attribute that should be mapped to user`s username	uid
security.ldap.userMapping.password	Name of LDAP attribute that should be mapped to user`s password	userPassword
security.ldap.userMapping.description	Name of LDAP attribute that should be mapped to user`s description	""
security.ldap.userMapping.fullname	Name of LDAP attribute that should be mapped to user`s fullname	""
security.ldap.userMapping.department	Name of LDAP attribute that should be mapped to user`s department	""
security.ldap.userMapping.email	Name of LDAP attribute that should be mapped to user`s email	""
security.ldap.userMapping.enabled	Name of LDAP attribute that should be mapped to user`s state	""
security.ldap.userMapping.enabledValue	Value of attribute with the name of userMapping.enabled that stands for ENABLED	""
security.ldap.groupMapping.base	LDAP base for group entries	""
security.ldap.groupMapping.filter	LDAP filter used for groups search	(member={0})
security.ldap.groupMapping.name	Name of LDAP attribute that should be mapped to group`s name	cn
security.ldap.groupMapping.description	Name of LDAP attribute that should be mapped to group`s description	""
security.ldap.groupMapping.memberAttribute	Name of LDAP attribute that lists users having the group	uid
security.ldap.groupMapping.roles	LDAP attribute that lists the roles that the group includes	""
security.ldap.groupMapping.roleFilterAttribute	LDAP attribute of roles that represents a role in groupMapping.roles attribute	""
security.ldap.groupMapping.enabled	Name of LDAP attribute that should be mapped to group`s state	""
security.ldap.groupMapping.enabledTrue	Value of attribute from groupMapping.enabled that stands for ENABLED	""
security.ldap.roleMapping.base	LDAP base for role entries	""
security.ldap.roleMapping.filter	LDAP filter used for roles search	""
security.ldap.roleMapping.memberAttribute	Name of LDAP attribute that lists users having the role	""
security.ldap.roleMapping.name	Name of LDAP attribute that should be mapped to role`s name	""
security.ldap.roleMapping.description	Name of LDAP attribute that should be mapped to role`s description	""
security.ldap.roleMapping.enabled	Name of LDAP attribute that should be mapped to role`s state	""
security.ldap.roleMapping.enabledTrue	Value of attribute from roleMapping.enabled that stands for ENABLED	""

Values deleted - ilum-core

Name	Reason
security.ldap.userSearch	Replaced with security.ldap.userMapping
security.ldap.groupSearch	Replaced with security.ldap.groupMapping

Names changed - ilum-core

Old Name	New Name
security.internal.users[*].password	security.internal.users[*].initialPassword

3. sparkmagic default config

Values changed - ilum-jupyter configuration parameters change because of the introduction of the spark session form.

Name	Old value	New Value
sparkmagic.config.sessionConfigs.conf	'{ "pyRequirements": "pandas", "cluster": "default", "autoPause": "false", "spark.example.config": "You can change the default configuration in ilum-jupyter-config k8s configmap" }'	'{}'

Values deleted - ilum-jupyter

Name	Reason
sparkmagic.config.sessionConfigs.executorCores	Not needed anymore because of the new spark session form

Values deleted - ilum-jupyter

Name	Reason
sparkmagic.config.sessionConfigs.driverMemory	Not needed anymore because of the new spark session form

RELEASE 6.3.0

1. Changed image tag version of kyuubi

Values changed - sparkmagic configuration parameters

Name	Old value	New Value
sparkmagic.config.sessionConfigs.conf	'{ "pyRequirements": "pandas", "spark.example.config": "You can change the default configuration in ilum-jupyter-config k8s configmap" }'	'{ "pyRequirements": "pandas", "cluster": "default", "autoPause": "false", "spark.example.config": "You can change the default configuration in ilum-jupyter-config k8s configmap" }'

2. Added property to set kafka address for ilum-core

Feature

Added ability to set kafka address for ilum-core pod, separate from global kafka address configuration for both spark jobs and ilum-core pod set via kafka.address property.

Values added - ilum-core

Name	Description	Value
kafka.ilum.address	ilum-core kafka address only for ilum-core pod, overrides kafka.address	not defined

3. Changed ilum job healthcheck tolerance time

Values changed - ilum job healthcheck configuration parameters

Name	Old value	New Value
job.healthcheck.tolerance	120	3600

4. Introducing embedded git repo

Feature

Added Gitea as a module providing build in git server for ilum platform.

Values added - gitea

Name	Description	Value
gitea.enabled	Enable or disable Gitea deployment	true
gitea.image.rootless	Run Gitea in rootless mode	false
gitea.gitea.config.database.DB_TYPE	Database type used for Gitea	postgres
gitea.gitea.config.database.HOST	Database host and port for Gitea	ilum-postgresql-hl:5432
gitea.gitea.config.database.NAME	Database name for Gitea	gitea
gitea.gitea.config.database.USER	Database username for Gitea	ilum
gitea.gitea.config.database.PASSWD	Database password for Gitea (Change required)	CHANGEMEPLEASE
gitea.gitea.admin.existingSecret	Gitea secret to store init credentials	ilum-git-credentials
gitea.gitea.admin.email	Gitea admin email	ilum@ilum
gitea.gitea.admin.passwordMode	Password mode for admin account	initialOnlyNoReset
gitea.gitea.additionalConfigFromEnvs[0].name	Enable push-create user	GITEA__REPOSITORY__ENABLE_PUSH_CREATE_USER
gitea.gitea.additionalConfigFromEnvs[0].value	Value for enabling push-create user	true
gitea.gitea.additionalConfigFromEnvs[1].name	Enable push-create organization	GITEA__REPOSITORY__ENABLE_PUSH_CREATE_ORG
gitea.gitea.additionalConfigFromEnvs[1].value	Value for enabling push-create organization	true
gitea.gitea.additionalConfigFromEnvs[2].name	Default repository branch	GITEA__REPOSITORY__DEFAULT_BRANCH
gitea.gitea.additionalConfigFromEnvs[2].value	Value for default repository branch	master
gitea.gitea.additionalConfigFromEnvs[3].name	Root URL of the Gitea server	GITEA__SERVER__ROOT_URL
gitea.gitea.additionalConfigFromEnvs[3].value	Value for Gitea server root URL	http://git.example.com/external/gitea/
gitea.gitea.additionalConfigFromEnvs[4].name	Static URL prefix	GITEA__SERVER__STATIC_URL_PREFIX
gitea.gitea.additionalConfigFromEnvs[4].value	Value for static URL prefix	/external/gitea/
gitea.redis-cluster.enabled	Enable or disable Redis cluster	false
gitea.redis.enabled	Enable or disable Redis	false
gitea.postgresql.enabled	Enable or disable standalone PostgreSQL	false
gitea.postgresql-ha.enabled	Enable or disable PostgreSQL HA	false

Values added - ilum-jupyter

Name	Description	Value
ilum-jupyter.git.enabled	Enable or disable Git integration	false
ilum-jupyter.git.username	Git username for authentication	ilum
ilum-jupyter.git.password	Git password for authentication	ilum
ilum-jupyter.git.email	Git email address	ilum@ilum
ilum-jupyter.git.repository	Git repository name	jupyter
ilum-jupyter.git.address	Git server address	ilum-gitea-http:3000
ilum-jupyter.git.init.image	Git initialization image	bitnami/git:2.48.1

Values added - ilum-airflow

Name	Description	Value
airflow.dags.gitSync.enabled	Enable or disable Git synchronization for DAGs	true
airflow.dags.gitSync.repo	Git repository URL for DAGs	http://ilum-gitea-http:3000/ilum/airflow.git
airflow.dags.gitSync.branch	Git branch to sync from	master
airflow.dags.gitSync.ref	Git reference to sync	HEAD
airflow.dags.gitSync.depth	Git clone depth	1
airflow.dags.gitSync.maxFailures	Maximum allowed synchronization failures	0
airflow.dags.gitSync.subPath	Subpath within the repository to sync	""
airflow.dags.gitSync.credentialsSecret	Secret used for Git authentication	ilum-git-credentials

5. Ilum SQL configuration naming changes

Change the naming of Ilum Sql Configuration to better reflect the current usage of Kyuubi

Names changed - ilum-core

Old Name	New Name
kyuubi.*	sql.*

Names changed - ilum-aio

Old Name	New Name
ilum-kyuubi.*	ilum-sql.*

⚠️⚠️⚠️ Warnings

Due to the changes in naming and in the inner workings of the SQL engine launching, and restrictions on what can be done via a helm upgrade, it is required to manually delete the old stateful set (e.g. kubectl delete sts ilum-sql) before upgrading to this version. This will ensure that during the update, a new stateful set is created with the correct configuration. The breaking changes are related to the labels and volume mounts that are used by the ilum-sql stateful set.

6. Add configurations for Ilum Submit for Spark Sql engines

Ilum Submit enhances the process of launching Spark SQL engines via both the Ilum Web Application and the JDBC endpoint by automatically applying the configurations of the selected cluster. This improvement eliminates the need to manually provide Kyuubi's Spark configuration to Ilum Core.

Valued deleted - ilum-core

Name	Reason
sql.sparkConfig	Unnecessary after the change

Values added - ilum-kyuubi

Name	Description	Value
ilumSubmit.enabled	Flag to enable ilum submit service	false
ilumSubmit.ilum.host	Host of Ilum REST service	ilum-core
ilumSubmit.ilum.port	Port of Ilum REST service	9888

Values added - ilum-aio

Name	Description	Value
ilum-sql.ilumSubmit.enabled	Flag to enable SQL engine creation through Ilum	true

⚠️⚠️⚠️ Warnings

Since Kyuubi's Spark config is not needed in Ilum Core anymore, the default spark config should be supplied directly to ilum-sql.config.spark.defaults instead of the global value.

7. Moving security related values in ilum-core from config map to secret

Feature

Security‑related configuration (including internal user credentials, LDAP, OAuth2, JWT, and authorities settings) has been moved from the config map to a dedicated Kubernetes Secret. This improves the security of sensitive data by isolating it from non‑sensitive configuration.

Values added - ilum-core

Name	Description	Value
security.secret.name	Name of the secret that holds security‑related configuration. Use this to override the default secret name.	ilum-security

8. Changed ilum-ui service type

Because of the problems with kubectl port-forward we are exposing a NodePort by default.

Values changed - ilum-ui healthcheck configuration parameters

Name	Old value	New Value
service.type	ClusterIP	NodePort
service.nodePort	``	31777

RELEASE 6.2.1

1. Change the value of Kyuubi's url

Feature

Change the value of Kyuubi's url in ilum-core. The default value should work now out of the box.

Values changed - ilum-core

Name	Old value	New Value
kyuubi.host	ilum-sql-rest	ilum-sql-headless

RELEASE 6.2.1-RC1

1. Spark job's memory settings configuration in ilum-core

Feature

Added spark job's memory settings configuration in ilum-core. When default cluster in ilum-core is being created, it will have memory settings parameters set to those values.

Values added - ilum-core

Name	Description	Value
job.memorysettings.executors	spark jobs executor count	2
job.memorysettings.executorMemory	spark jobs executor memory allocation	1g
job.memorysettings.driverMemory	spark jobs driver memory allocation	1g
job.memorysettings.executorCores	spark jobs executor core count	1
job.memorysettings.driverCores	spark jobs driver core count	1
job.memorysettings.dynamicAllocationEnabled	spark jobs dynamic allocation enabled flag	false
job.memorysettings.minExecutors	spark jobs minimum number of executors	0
job.memorysettings.initialExecutors	spark jobs initial number of executors	0
job.memorysettings.maxExecutors	spark jobs maximum number of executors	20

2. Spark history server retention parameters addition

Feature

Added spark history server retention parameters to ilum-core. These parameters allow the user to configure the retention of spark history server logs.

Values added - ilum-core

Name	Description	Value
historyServer.parameters.spark.history.fs.cleaner.enabled	history server cleaner enabled flag	true
historyServer.parameters.spark.history.fs.cleaner.interval	history server cleaner interval	1d
historyServer.parameters.spark.history.fs.cleaner.maxAge	history server logs max age	7d

3. Split Kyuubi's url into host and port

Feature

Split Kyuubi's url into host and port in ilum-core. This change was necessary for us to be able to create custom engines.

Values added - ilum-core

Name	Description	Value
kyuubi.host	Kyuubi host	ilum-sql-rest
kyuubi.port	Kyuubi port	10099

Values deleted - ilum-core

Name	Reason
kyuubi.url	Unnecessary after the change

4. Extra entries in helm_ui nginx server config map

Feature

Added enabled flags for history server, minio, ilum-jupyter, airflow, mlflow and lineage to ilum-ui. These flags allow the user to enable or disable the access to these services through ilum-ui. These values will be used in nginx server config map.

Values added - ilum-ui chart

Name	Description	Value
nginx.config.ilum-jupyter.enabled	ilum-ui nginx config ilum-jupyter enabled flag	false
nginx.config.airflow.enabled	ilum-ui nginx config airflow enabled flag	false
nginx.config.minio.enabled	ilum-ui nginx config minio enabled flag	false
nginx.config.historyServer.enabled	ilum-ui nginx config historyServer enabled flag	false
nginx.config.mlflow.enabled	ilum-ui nginx config mlflow enabled flag	false
nginx.config.lineage.enabled	ilum-ui nginx config lineage enabled flag	false

5. Superset in ilum-aio chart

Feature

Superset in ilum AIO chart. Superset is fast, lightweight, intuitive, and loaded with options that make it easy for users of all skill sets to explore and visualize their data, from simple line charts to highly detailed geospatial charts. Superset is one of modules integrated with Ilum platform.

Values added - ilum-ui

log aggregation config

Name	Description	Value
runtimeVars.supersetUrl	superset service url	http://ilum-superset:8088/
nginx.config.superset.enabled	ilum-ui nginx config superset enabled flag	false

4. Ilum default kubernetes cluster config from helm values

Feature

From now on, the default ilum cluster parameters will be set based on the helm values.

Values added - ilum-core chart

Name	Description	Value
kubernetes.defaultCluster.config	ilum-core default kubernetes cluster configuration	config:   spark.driver.extraJavaOptions: "-Divy.cache.dir=/tmp -Divy.home=/tmp"   spark.kubernetes.container.image: "ilum/spark:3.5.2-delta"   spark.databricks.delta.catalog.update.enabled: "true"

RELEASE 6.2.0

1. Changed image tag version of kyuubi

Values changed - ilum-kyuubi chart

Name	Old value	New Value
image.tag	1.9.2-spark	1.10.0-spark

2. Changed kyuubi spark configuration in ilum-kyuubi chart

Added spark.driver.memory=2g in global.kyuubi.sparkConfig

RELEASE 6.2.0-RC2

1. Minio status probe addition

Feature

Added status probe in ilum-core that checks whether minio storage is ready

Values added - ilum-core

Name	Description	Value
minio.statusProbe.enabled	minio status probe enabled flag	true
minio.statusProbe.image	minio status probe image	curlimages/curl:8.5.0
minio.statusProbe.baseUrl	minio base url	"http://ilum-minio:9000"

2. Kyuubi configuration in ilum-core

Feature

Added Kyuubi configuration in ilum-core helm chart. Kyuubi will allow the user to execute SQL queries on many different data sources using ILUM UI.

Values added - ilum-core

Name	Description	Value
kyuubi.enabled	Kyuubi enabled flag	true
kyuubi.url	Url of Kyuubi's rest service	http://ilum-sql-rest:10099

⚠️⚠️⚠️ Warnings

In order to properly manage SQL engines, we need to pass Kyuubi's spark configuration to ilum-core. This is done by configuring Kyuubi's spark in global.kyuubi.sparkConfig and allows the user to write one configuration which can be passed to both Kyuubi and ilum-core.

3. MongoDb uri configuration in ilum-core

Feature

Change the way mongoDb uri is passed to ilum-core. Now it is passed as a single string, which enables the user to provide more granular configuration such as authSource.

Values added - ilum-core

Name	Description	Value
mongo.uri	MongoDb connection string	mongodb://mongo:27017/ilum-default?replicaSet=rs0

Values deleted - ilum-core

Name	Reason
mongo.instances	Unnecessary after the change
mongo.replicaSetName	Unnecessary after the change

⚠️⚠️⚠️ Warnings

The mongo.uri, if set incorrectly, will cause the application to not work properly. Make sure to provide the correct connection string.

Previously the format was: mongodb://{ mongo.instances }/ilum-{ release_namespace }?replicaSet={ mongo.replicaSetName } By default in the ilum-aio chart these values were:

• mongo.instances - ilum-mongodb-0.ilum-mongodb-headless:27017,ilum-mongodb-1.ilum-mongodb-headless:27017
• mongo.replicaSetName - rs0
• release_namespace - default

4. Autopausing configuration in ilum-core

Feature

Added autopausing in ilum-core, which periodically checks if any groups are idle for the specified time and pauses the group. Each group has to have autopausing exclicitly turned on for this to take place.

Values added - ilum-core

Name	Description	Value
job.autoPause.enabled	Feature flag to enable auto pausing	true
job.autoPause.period	Interval in seconds to check the idleness groups	180
job.autoPause.idleTime	Time in seconds that the group needs to be idle to be auto paused	3600

5. Graphite exporter in ilum-aio chart

Feature

Graphite exporter in ilum AIO chart and Graphite configuration in ilum-core chart. Graphite exporter is a Prometheus exporter for metrics exported in the Graphite plaintext protocol.

Values added - graphite-exporter

Newly added whole chart, check its values on the chart's page

6. Graphite configuration in ilum-core

Feature

Added Graphite configuration in ilum-core helm chart. Graphite will allow Spark jobs to send their metrics to graphite sink, which will be scraped by Prometheus.

Values added - ilum-core

Name	Description	Value
job.graphite.enabled	Graphite enabled flag	false
job.graphite.host	Graphite host	ilum-graphite-graphite-tcp
job.graphite.port	Graphite port	9109
job.graphite.period	Interval between sending job metrics	10
job.graphite.units	Time unit	seconds

RELEASE 6.1.4

1. Jupyter default sparkmagic configuration change

Feature

Changed method of passing spark default configs to jupyter notebook, now it is passed as json string

Values added - ilum-jupyter

sparkmagic configuration parameters

Name	Description	Value
sparkmagic.config.sessionConfigs.conf	sparkmagic session spark configuration	'{ "pyRequirements": "pandas", "spark.jars.packages": "io.delta:delta-core_2.12:2.4.0", "spark.sql.extensions": "io.delta.sql.DeltaSparkSessionExtension", "spark.sql.catalog.spark_catalog": "org.apache.spark.sql.delta.catalog.DeltaCatalog"}'
sparkmagic.config.sessionConfigsDefaults.conf	sparkmagic session defaults spark configuration	'{ "pyRequirements": "pandas", "spark.jars.packages": "io.delta:delta-core_2.12:2.4.0", "spark.sql.extensions": "io.delta.sql.DeltaSparkSessionExtension", "spark.sql.catalog.spark_catalog": "org.apache.spark.sql.delta.catalog.DeltaCatalog"}'

2. Kyuubi in ilum-aio chart

Feature

Kyuubi in ilum AIO chart. Kyuubi is a distributed multi-tenant gateway providing SQL query services for data warehouses and lakehouses. It provides both JDBC and ODBC interfaces, and a REST API for clients to interact with.

Values added - ilum-kyuubi

Newly added whole chart, check its values on the chart's page

RELEASE 6.1.3

1. Jupyter configuration and persistent storage

Feature

Added extended configuration of jupyter notebook helm chart through helm values. Moreover added persitent storage to jupyter pod. All data saved in work directory will now be available after jupyter restart/update.

Values added - ilum-jupyter

pvc parameters

Name	Description	Value
pvc.annotations	persistent volume claim annotations	{}
pvc.selector	persistent volume claim selector	{}
pvc.accessModes	persistent volume claim accessModes	ReadWriteOnce
pvc.storage	persistent volume claim storage requests	4Gi
pvc.storageClassName	persistent volume claim storageClassName	``

sparkmagic configuration parameters

Name	Description	Value
sparkmagic.config.kernelPythonCredentials.username	sparkmagic python kernel username	""
sparkmagic.config.kernelPythonCredentials.password	sparkmagic python kernel password	""
sparkmagic.config.kernelPythonCredentials.auth	sparkmagic python kernel auth mode	"None"
sparkmagic.config.kernelScalaCredentials.username	sparkmagic python kernel username	""
sparkmagic.config.kernelScalaCredentials.password	sparkmagic scala kernel password	""
sparkmagic.config.kernelScalaCredentials.auth	sparkmagic scala kernel auth mode	"None"
sparkmagic.config.kernelRCredentials.username	sparkmagic r kernel username	""
sparkmagic.config.kernelRCredentials.password	sparkmagic r kernel password	""
sparkmagic.config.waitForIdleTimeoutSeconds	sparkmagic timeout waiting for idle state	15
sparkmagic.config.livySessionStartupTimeoutSeconds	sparkmagic timeout waiting for the session to start	300
sparkmagic.config.ignoreSslErrors	sparkmagic ignore ssl errors flag	false
sparkmagic.config.sessionConfigs.conf	sparkmagic session spark configuration	[pyRequirements: pandas, spark.jars.packages: io.delta:delta-core_2.12:2.4.0, spark.sql.extensions: io.delta.sql.DeltaSparkSessionExtension,spark.sql.catalog.spark_catalog: org.apache.spark.sql.delta.catalog.DeltaCatalog]
sparkmagic.config.sessionConfigs.driverMemory	sparkmagic session driver memory	1000M
sparkmagic.config.sessionConfigs.executorCores	sparkmagic session executor cores	2
sparkmagic.config.sessionConfigsDefaults.conf	sparkmagic session defaults spark configuration	[pyRequirements: pandas, spark.jars.packages: io.delta:delta-core_2.12:2.4.0, spark.sql.extensions: io.delta.sql.DeltaSparkSessionExtension,spark.sql.catalog.spark_catalog: org.apache.spark.sql.delta.catalog.DeltaCatalog]
sparkmagic.config.sessionConfigsDefaults.driverMemory	sparkmagic session defaults driver memory	1000M
sparkmagic.config.sessionConfigsDefaults.executorCores	sparkmagic session defaults executor cores	2
sparkmagic.config.useAutoViz	sparkmagic use auto viz flag	true
sparkmagic.config.coerceDataframe	sparkmagic coerce dataframe flag	true
sparkmagic.config.maxResultsSql	sparkmagic max sql result	2500
sparkmagic.config.pysparkDataframeEncoding	sparkmagic pyspark dataframe encoding	utf-8
sparkmagic.config.heartbeatRefreshSeconds	sparkmagic heartbeat refresh seconds	30
sparkmagic.config.livyServerHeartbeatTimeoutSeconds	sparkmagic livy server heartbeat timeout seconds	0
sparkmagic.config.heartbeatRetrySeconds	sparkmagic heartbeat retry seconds	10
sparkmagic.config.serverExtensionDefaultKernelName	sparkmagic server extension default kernel name	pysparkkernel
sparkmagic.config.retryPolicy	sparkmagic retry policy	configurable
sparkmagic.config.retrySecondsToSleepList	sparkmagic retry seconds to sleep list	[0.2, 0.5, 1, 3, 5]
sparkmagic.config.configurableRetryPolicyMaxRetries	sparkmagic retry policy max retries	8

RELEASE 6.1.2

1. Hive metastore in ilum-aio chart

Feature

Hive metastore in ilum AIO chart. HMS is a central repository of metadata for Hive tables and partitions in a relational database, and provides clients (including Hive, Impala and Spark) access to this information using the metastore service API. With hive metastore enabled in ilum AIO helm stack spark jobs run by ilum can be configured to autmatically access it.

Values added - ilum-hive-metastore

Newly added whole chart, check its values on chart page

Values added - ilum-core

Name	Description	Value
hiveMetastore.enabled	passing hive metastore config to ilum spark jobs flag	false
hiveMetastore.address	hive metastore address	thrift://ilum-hive-metastore:9083
hiveMetastore.warehouseDir	hive metastore warehouse directory	s3a://ilum-data/

2. Postgres extensions added

Feature

Few of ilum AIO subchars use postgresql, to make it easier to manage deployment of them we have added postgres extension resource to create postgresql databases for ilum sucharts.

Values added - ilum-aio

postgresql extensions parameters

Name	Description	Value
postgresExtensions.enabled	postgres extensions enabled flag	true
postgresExtensions.image	image to run extensions in	bitnami/postgresql:16
postgresExtensions.pullPolicy	image pull policy	IfNotPresent
postgresExtensions.imagePullSecrets	image pull secrets	[]
postgresExtensions.host	postgresql database host	ilum-postgresql-0.ilum-postgresql-hl
postgresExtensions.port	postgresql database port	5432
postgresExtensions.databasesToCreate	comma separated list of databases to create	marquez,airflow,metastore
postgresExtensions.auth.username	postgresql account username	ilum
postgresExtensions.auth.password	postgresql account password	CHANGEMEPLEASE
postgresExtensions.nodeSelector	postgresql extensions pods node selector	{}
postgresExtensions.tolerations	postgresql extensions pods tolerations	[]

3. Loki and promtail in ilum-aio chart

Feature

Loki and promtail in ilum AIO chart. Loki is a horizontally scalable, highly available, multi-tenant log aggregation system inspired by Prometheus. Promtail is an agent which ships the contents of local logs to a Grafana Loki instance. Ilum will now use loki to aggregate logs from spark job pods to be able to clean cluster resources after jobs are done. Loki and promtail are preconfigured to scrap logs only from spark pods run by ilum in order to fetch job logs after their finish.

Values added - ilum-core

log aggregation config

Name	Description	Value
global.logAggregation.enabled	ilum log aggregation flag, if enabled Ilum will fetch logs of finished kubernetes spark pods from loki	false
global.logAggregation.loki.url	loki gateway address to access logs	http://ilum-loki-gateway

Values added - ilum-aio

log aggregation - loki config

Name	Description	Value
loki.nameOverride	subchart name override	ilum-loki
loki.monitoring.selfMonitoring.enabled	self monitoring enabled flag	false
loki.monitoring.selfMonitoring.grafanaAgent.installOperator	self monitoring grafana agent operator install flag	false
loki.monitoring.selfMonitoring.lokiCanary.enabled	self monitoring canary enabled flag	false
loki.test.enabled	tests enabled flag	false
loki.loki.auth_enabled	authentication enabled flag	false
loki.loki.storage.bucketNames.chunks	storage chunks bucket	ilum-files
loki.loki.storage.bucketNames.ruler	storage ruler bucket	ilum-files
loki.loki.storage.bucketNames.admin	storage admin bucket	ilum-files
loki.loki.storage.type	storage type	s3
loki.loki.s3.endpoint	s3 storage endpoint	http://ilum-minio:9000
loki.loki.s3.region	s3 storage endpoint	us-east-1
loki.loki.s3.secretAccessKey	s3 storage secret access key	minioadmin
loki.loki.s3.accessKeyId	s3 storage access key id	minioadmin
loki.loki.s3.s3ForcePathStyle	s3 storage path style access flag	true
loki.loki.s3.insecure	s3 storage insecure flag	true
loki.loki.compactor.retention_enabled	logs retention enabled flag	true
loki.loki.compactor.deletion_mode	deletion mode	filter-and-delete
loki.loki.compactor.shared_store	shared store	s3
loki.loki.limits_config.allow_deletes	allow logs deletion flag	true

log aggregation - loki config

Name	Description	Value
promtail.config.clients[0].url	first client url	http://ilum-loki-write:3100/loki/api/v1/push
promtail.snippets.pipelineStages[0].match.selector	pipeline stage to drop non ilum logs selector	{ilum_logAggregation!="true"}
promtail.snippets.pipelineStages[0].match.action	pipeline stage to drop non ilum logs action	drop
promtail.snippets.pipelineStages[0].match.drop_counter_reason	pipeline stage to drop non ilum logs drop_counter_reason	non_ilum_log
promtail.snippets.extraRelabelConfigs[0].action	relabel config to keep ilum pod labels action	labelmap
promtail.snippets.extraRelabelConfigs[0].regex	relabel config to keep ilum pod labels regex	__meta_kubernetes_pod_label_ilum(.*)
promtail.snippets.extraRelabelConfigs[0].replacement	relabel config to keep ilum pod labels replacement	ilum${1}
promtail.snippets.extraRelabelConfigs[1].action	relabel config to keep spark pod labels action	labelmap
promtail.snippets.extraRelabelConfigs[1].regex	relabel config to keep spark pod labels regex	__meta_kubernetes_pod_label_spark(.*)
promtail.snippets.extraRelabelConfigs[1].replacement	relabel config to keep spark pod labels replacement	spark${1}

RELEASE 6.1.1

1. Added health checks for ilum interactive jobs

Feature

To prevent situations with unexpected crushes of ilum groups we added healthchecks to make sure they work as they should.

Values added - ilum-core

ilum-job parameters

Name	Description	Value
job.healthcheck.enabled	spark interactive jobs healthcheck enabled flag	true
job.healthcheck.interval	spark interactive jobs healthcheck interval in seconds	300
job.healthcheck.tolerance	spark interactive jobs healthcheck response time tolerance in seconds	120

2. Parameterized replica scale for ilum scalable services

Feature

The configuration of the number of replicas for ilum scalable services was extracted to helm values.

Values added - ilum-core

ilum-core common parameters

Name	Description	Value
replicaCount	number of ilum-core replicas	1

Values added - ilum-ui

ilum-ui common parameters

Name	Description	Value
replicaCount	number of ilum-ui replicas	1

RELEASE 6.1.0

1. Deleted unneeded parameters from ilum cluster wasbs storage

Feature

WASBS storage containers no longer needs to have sas token porvided in helm values as it turned out to be unnecessary

Values deleted - ilum-core

wasbs storage parameters

Name	Reason
kubernetes.wasbs.sparkContainer.name	Moved to kubernetes.wasbs.sparkContainer value
kubernetes.wasbs.sparkContainer.sasToken	Turned out to be unnecessary
kubernetes.wasbs.dataContainer.name	Moved to kubernetes.wasbs.dataContainer value
kubernetes.wasbs.dataContainer.sasToken	Turned out to be unnecessary

Values added - ilum-core

wasbs storage parameters

Name	Description	Value
kubernetes.wasbs.sparkContainer	default kubernetes cluster WASBS storage container name to store spark resources	ilum-files
kubernetes.wasbs.dataContainer	default kubernetes cluster WASBS storage container name to store ilum tables	ilum-tables

2. Added init containers to check service availability

Feature

To make Ilum deployment more gracefully, from now on Ilum containers have containers waiting for the availability of the services they depend on.

Values added - ilum-core

Name	Description	Value
mongo.statusProbe.enabled	mongo status probe enabled flag	true
mongo.statusProbe.image	init container that waits for mongodb to be available image	mongo:7.0.5
kafka.statusProbe.enabled	kafka status probe enabled flag	true
kafka.statusProbe.image	init container that waits for kafka to be available image	bitnami/kafka:3.4.1
historyServer.statusProbe.enabled	ilum history server ilum-core status probe enabled flag	true
historyServer.statusProbe.image	ilum history server init container that waits for ilum-core to be available image	curlimages/curl:8.5.0

Values added - ilum-livy-proxy

Name	Description	Value
statusProbe.enabled	ilum-core status probe enabled flag	true
statusProbe.image	init container that waits for ilum-core to be available image	curlimages/curl:8.5.0

Values added - ilum-ui

Name	Description	Value
statusProbe.enabled	ilum-core status probe enabled flag	true
statusProbe.image	init container that waits for ilum-core to be available image	curlimages/curl:8.5.0

3. Parameterized kafka producers in ilum-core chart

Feature

In kafka communication mode ilum interactive jobs responses to interactive job instances using kafka producers. With newly added helm values kafka producer can be adapted to match user needs.

Values added - ilum-core

kafka parameters

Name	Description	Value
kafka.maxPollRecords	kafka max.poll.records parameter for ilum jobs kafka consumer, it determines how much requests ilum-job kafka consumer will fetch with each poll	500
kafka.maxPollInterval	kafka max.poll.interval.ms parameter for ilum jobs kafka consumer, it determines the maximum delay between invocations of poll, which in ilum-job context means time limit for processing requests fetched in poll	60000

RELEASE 6.1.0-RC1

1. added support for service annotations

Feature

Ilum helm charts services annotations may now be configured through helm values

Values added - ilum-core

service parameters

Name	Description	Value
service.annotations	service annotations	{}
grpc.service.annotations	grpc service annotations	{}
historyServer.service.annotations	history server service annotations	{}

Values added - ilum-jupyter

service parameters

Name	Description	Value
service.annotations	service annotations	{}

Values added - ilum-livy-proxy

service parameters

Name	Description	Value
service.annotations	service annotations	{}

Values added - ilum-ui

service parameters

Name	Description	Value
service.annotations	service annotations	{}

Values added - ilum-zeppelin

service parameters

Name	Description	Value
service.annotations	service annotations	{}

2. Pulled out security oauth2 parameters to global values

Feature

Ilum security oauth2 configuration is now being set through global values

Values added - ilum-aio

security parameters

Name	Description	Value
global.security.oauth2.clientId	oauth2 client ID	``
global.security.oauth2.issuerUri	oauth2 URI that can either be an OpenID Connect discovery endpoint or an OAuth 2.0 Authorization Server Metadata endpoint defined by RFC 8414	``
global.security.oauth2.audiences	oauth2 audiences	``
global.security.oauth2.clientSecret	oauth2 client secret	``

Values deleted - ilum-core

security parameters

Name	Reason	Value
security.oauth2.clientId	oauth2 security parameters are now configured through global values	``
security.oauth2.issuerUri	oauth2 security parameters are now configured through global values	``

3. Runtime environment variables for frontend

Feature

Configuration for frontend environment variables throuhg helm ui values.

Values added - ilum-ui

runtime variables

Name	Description	Value
runtimeVars.defaultConfigMap.enabled	default config map for frontend runtime environment variables	true
runtimeVars.debug	debug logging flag	false
runtimeVars.backenUrl	ilum-core backend url	http://ilum-core:9888
runtimeVars.historyServerUrl	url of history server ui	http://ilum-history-server:9666
runtimeVars.jupyterUrl	url of jupyter ui	http://ilum-jupyter:8888
runtimeVars.airflowUrl	url of airflow ui	http://ilum-webserver:8080
runtimeVars.minioUrl	url of minio ui	http://ilum-minio:9001
runtimeVars.mlflowUrl	url of mlflow ui	http://mlflow:5000
runtimeVars.historyServerPath	ilum-ui proxy path to history server ui	/external/history-server/
runtimeVars.jupyterPath	ilum-ui proxy path to jupyter ui	/external/jupyter/lab/tree/work/IlumIntro.ipynb
runtimeVars.airflowPath	ilum-ui proxy path to airflow ui	/external/airflow/
runtimeVars.dataPath	ilum-ui proxy path to minio ui	/external/minio/
runtimeVars.mlflowPath	ilum-ui proxy path to mlflow ui	/external/mlflow/

Values deleted - ilum-ui

Name	Reason
debug	moved to runtimeVars section
backenUrl	moved to runtimeVars section
historyServerUrl	moved to runtimeVars section
jupyterUrl	moved to runtimeVars section
airflowUrl	moved to runtimeVars section

4. Kube-prometheus-stack in ilum-aio chart

Feature

Kube prometheus stack in ilum AIO chart. Preconfigured to automatically work wiht ilum deployment in order to collect metrics of ilum pods and spark jobs run by ilum. Ilum provides prometheus service monitors to autoamtically scrape metrics from spark driver pods run by ilum and ilum backend services. Additionally ilum_aio chart provides built-in grafana dashboards that can be found in Ilum folder.

Values added - ilum-aio

kube-prometheus-stack variables - for extended configuration check kube-prometheus stack helm chart

Name	Description	Value
kube-prometheus-stack.enabled	kube-prometheus-stack enabled flag	false
kube-prometheus-stack.releaseLabel	kube-prometheus-stack flag to watch resource only from ilum_aio release	true
kube-prometheus-stack.kubeStateMetrics.enabled	kube-prometheus-stack Component scraping kube state metrics enabled flag	false
kube-prometheus-stack.nodeExporter.enabled	kube-prometheus-stack node exporter daemon set deployment flag	false
kube-prometheus-stack.alertmanager.enabled	kube-prometheus-stack alert manager flag	false
kube-prometheus-stack.grafana.sidecar.dashboards.folderAnnotation	kube-prometheus-stack, If specified, the sidecar will look for annotation with this name to create folder and put graph here	grafana_folder
kube-prometheus-stack.grafana.sidecar.dashboards.provider.foldersFromFilesStructure	kube-prometheus-stack, allow Grafana to replicate dashboard structure from filesystem	true

Values added - ilum-core

Name	Description	Value
job.prometheus.enabled	prometheus enabled flag, If true spark jobs run by Ilum will share metrics in prometheus format	true

5. Marquez OpenLineage in ilum-aio chart

Feature

Marquez OpenLineage in ilum AIO chart. Marquez enables consuming, storing, and visualizing OpenLineage metadata from across an organization, serving use cases including data governance, data quality monitoring, and performance analytics. With marquez enabled in ilum AIO helm stack spark job run by Ilum will share lineage information with marquez backend. Marquez web interface visualize data lienage information collected from spark jobs and it is accesible through ilum UI as iframe.

Values added - ilum-aio

Name	Description	Value
global.lineage.enabled	marquez enabled flag	false

Values added - ilum-core

Name	Description	Value
job.openLineage.transport.type	marquez communication type	http
job.openLineage.transport.serverUrl	marquez backend url	http://ilum-marquez:9555/
job.openLineage.transport.endpoint	marquez backend endpoint	/external/lineage/api/v1/lineage

Values added - ilum-marquez

Newly added whole chart, check its values on chart page

Values added - ilum-ui

Name	Description	Value
runtimeVars.lineageUrl	url to provide marquez openlineage UI iframe	http://ilum-marquez-web:9444
runtimeVars.lineagePath	ilum-ui proxy path to marquez openlineage UI	/external/lineage/

RELEASE 6.0.3

1. Parameterized kafka producers max.request.size parameter in ilum-core chart

Feature

In kafka communication mode ilum interactive jobs responses to interactive job instances using kafka producers. With newly added helm value max.request.size kafka producer parameter can be adapted to match responses size needs.

Values added - ilum-core

kafka parameters

Name	Description	Value
kafka.requestSize	kafka max.request.size parameter for ilum jobs kafka producers	20000000

RELEASE 6.0.2

1. Support for hdfs, gcs and azure blob storage in ilum-core chart

Feature

Ilum cluster no longer has to be attached to s3 storage, from now default cluster can be configured to use hdfs, gcs or azure blob as storage as well. It can be achieved using newly added values in ilum-core helm chart.

Values deleted - ilum-core

Name	Reason
kubernetes.s3.bucket	From now on two separated buckets must be set with new values: kubernetes.s3.sparkBucket, kubernetes.s3.dataBucket

Values added - ilum-core

kubernetes storage parameters

Name	Description	Value
kubernetes.upgradeClusterOnStartup	default kubernetes cluster upgrade from values in config map flag	false
kubernetes.storage.type	default kubernetes cluster storage type, available options: s3, gcs, wasbs, hdfs	s3

s3 kubernetes storage parameters

Name	Description	Value
kubernetes.s3.host	default kubernetes cluster S3 storage host to store spark resources	s3
kubernetes.s3.port	default kubernetes cluster S3 storage port to store spark resources	7000
kubernetes.s3.sparkBucket	default kubernetes cluster S3 storage bucket to store spark resources	ilum-files
kubernetes.s3.dataBucket	default kubernetes cluster S3 storage bucket to store ilum tables	ilum-tables
kubernetes.s3.accessKey	default kubernetes cluster S3 storage access key to store spark resources	""
kubernetes.s3.secretKey	default kubernetes cluster S3 storage secret key to store spark resources	""

gcs kubernetes storage parameters

Name	Description	Value
kubernetes.gcs.clientEmail	default kubernetes cluster GCS storage client email	""
kubernetes.gcs.sparkBucket	default kubernetes cluster GCS storage bucket to store spark resources	"ilum-files"
kubernetes.gcs.dataBucket	default kubernetes cluster GCS storage bucket to store ilum tables	"ilum-tables"
kubernetes.gcs.privateKey	default kubernetes cluster GCS storage private key to store spark resources	""
kubernetes.gcs.privateKeyId	default kubernetes cluster GCS storage private key id to store spark resources	""

wasbs kubernetes storage parameters

Name	Description	Value
kubernetes.wasbs.accountName	default kubernetes cluster WASBS storage account name	""
kubernetes.wasbs.accessKey	default kubernetes cluster WASBS storage access key to store spark resources	""
kubernetes.wasbs.sparkContainer.name	default kubernetes cluster WASBS storage container name to store spark resources	"ilum-files"
kubernetes.wasbs.sparkContainer.sasToken	default kubernetes cluster WASBS storage container sas token to store spark resources	""
kubernetes.wasbs.dataContainer.name	default kubernetes cluster WASBS storage container name to store ilum tables	"ilum-tables"
kubernetes.wasbs.dataContainer.sasToken	default kubernetes cluster WASBS storage container sas token to store ilum tables	""

hdfs kubernetes storage parameters

Name	Description	Value
kubernetes.hdfs.hadoopUsername	default kubernetes cluster HDFS storage hadoop username	""
kubernetes.hdfs.config	default kubernetes cluster HDFS storage dict of config files with name as key and base64 encoded content as value	""
kubernetes.hdfs.sparkCatalog	default kubernetes cluster HDFS storage catalog to store spark resources	"ilum-files"
kubernetes.hdfs.dataCatalog	default kubernetes cluster HDFS storage catalog to store ilum-tables	"ilum-tables"
kubernetes.hdfs.keyTab	default kubernetes cluster HDFS storage keytab file base64 encoded content	""
kubernetes.hdfs.principal	default kubernetes cluster HDFS storage principal name	""
kubernetes.hdfs.krb5	default kubernetes cluster HDFS storage krb5 file base64 encoded content	""
kubernetes.hdfs.trustStore	default kubernetes cluster HDFS storage trustStore file base64 encoded content	""
kubernetes.hdfs.logDirectory	default kubernetes cluster HDFS storage directory absolute path to store eventLog for history server	""

Important! Make sure S3/GCS buckets or WASBS containers are already created and reachable!

2. Added spark history server to ilum-core helm chart

Feature

Spark history server can be deployed from now on along with ilum-core. History server config is being passed to every spark job ilum runs. History server UI can now be accesesed by ilum UI. If enabled it will use default kubernetes cluster storage configured with kubernetes.[STORAGE_TYPE].[PARAMETER] values as eventLog storage.

Values added - ilum-core

history server parameters

Name	Description	Value
historyServer.enabled	spark history server flag	true
historyServer.image	spark history server image	ilum/spark-launcher:spark-3.5.3
historyServer.address	spark history server address	http://ilum-history-server:9666
historyServer.pullPolicy	spark history server image pull policy	IfNotPresent
historyServer.imagePullSecrets	spark history server image pull secrets	[]
historyServer.parameters	spark history server custom spark parameters	[]
historyServer.resources	spark history server pod resources	limits: memory: "500Mi" requests: memory: "300Mi"
historyServer.service.type	spark history server service type	ClusterIP
historyServer.service.port	spark history server service port	9666
historyServer.service.nodePort	spark history server service nodePort	""
historyServer.service.clusterIP	spark history server service clusterIP	""
historyServer.service.loadBalancerIP	spark history server service loadbalancerIP	""
historyServer.ingress.enabled	spark history server ingress flag	false
historyServer.ingress.version	spark history server ingress version	"v1"
historyServer.ingress.className	spark history server ingress className	""
historyServer.ingress.host	spark history server ingress host	"host"
historyServer.ingress.path	spark history server ingress path	"/(.*)"
historyServer.ingress.pathType	spark history server ingress pathType	Prefix
historyServer.ingress.annotations	spark history server annotations	nginx.ingress.kubernetes.io/rewrite-target: /$1 nginx.ingress.kubernetes.io/proxy-body-size: "600m" nginx.org/client-max-body-size: "600m"

Warnings

1. Make sure HDFS logDirectory (helm value kubernetes.hdfs.logDirectory) is absolute path of configured sparkCatalog with /ilum/logs suffix! Eg for kubernetes.hdfs.sparkCatalog=spark-catalog put hdfs://name-node/user/username/spark-catalog/ilum/logs

3. Job retention in ilum-core chart

Feature

Ilum jobs will be deleted after the configured retention period expires

Values added - ilum-core

job retention parameters

Name	Description	Value
job.retain.hours	spark jobs retention hours limit	168