All in one

All In One helm chart which contains all dependencies in a single package.

TLDR

$ helm repo add ilum https://charts.ilum.cloud
$ helm install ilum ilum/ilum
$ kubectl port-forward svc/ilum-ui 9777:9777

Installing the Chart

To install the chart with the release name ilum:

$ helm install --dependency-update ilum ilum/ilum

The command deploys ilum on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.

Uninstalling the Chart

To uninstall/delete the ilum deployment:

$ helm delete ilum

The command removes all the Kubernetes components associated with the chart and deletes the release.

Parameters

All the default parameters to ilum components are provided in values.yaml file.

They are configured with some default values for ilum to be operational just out of the box.

To check all supported parameters and their default values visit README.md files in ilum-core and ilum-ui charts.

Example deployments

Using kafka as a communication type

helm install --dependency-update --set kafka.enabled=true --set ilum-core.communication.type=kafka ilum ilum/ilum

Using gRPC as a communication type (default)

helm install --dependency-update ilum ilum/ilum

Using gRPC as a communication type and gRPC port exposed

e.g. for Yarn to be able to reach gRPC service

helm install --dependency-update --set kafka.enabled=false --set ilum-core.communication.type=grpc --set ilum-core.grpc.host=<k8s-exposed-host> --set ilum-core.grpc.nodePort=<k8s-exposed-port> --set ilum-core.grpc.type=NodePort ilum ilum/ilum

ilum-livy-proxy

Please be aware, that ilum-livy-proxy is not bundled in ilum package by default. If you want to run this service, add --set ilum-livy-proxy.enabled=true to your installation command.

Jupyter

Please be aware, that Jupyter notebook is not bundled in ilum package by default. If you want to run this service, add --set ilum-jupyter.enabled=true to your installation command.

Zeppelin

Please be aware, that Zeppelin notebook is not bundled in ilum package by default. If you want to run this service, add --set ilum-zeppelin.enabled=true to your installation command.

ilum-core

TLDR

$ helm repo add ilum https://charts.ilum.cloud
$ helm install ilum-core ilum/ilum-core

Installing the Chart

To install the chart with the release name ilum-core:

$ helm install ilum-core ilum/ilum-core

The command deploys ilum-core on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.

Uninstalling the Chart

To uninstall/delete the ilum-core deployment:

$ helm delete ilum-core

The command removes all the Kubernetes components associated with the chart and deletes the release.

Parameters

Common parameters

Name	Description	Value
nameOverride	String to partially override ilum-core.fullname template (will maintain the release name)	""
fullnameOverride	String to fully override ilum-core.fullname template	""

ilum-core deployment parameters

Name	Description	Value
image	ilum-core image	docker.ilum.cloud/ilum-core:5.1.0
pullPolicy	ilum-core image pull policy	IfNotPresent

ilum-core communication parameters

Name	Description	Value
communication.type	ilum-core communication type with spark jobs, available options: grpc, kafka	grpc

ilum-core service parameters

Name	Description	Value
service.type	ilum-core service type	ClusterIP
service.port	ilum-core service port	9888
service.nodePort	ilum-core service node port - required when type is LoadBalancer or NodePort	""
service.clusterIP	ilum-core service cluster IP - required when type is ClusterIP	""
service.loadBalancerIP	ilum-core service load balancer IP - required when type is LoadBalancer	""

ilum-core ingress parameters

Name	Description	Value
ingress.enabled	ilum-core ingress enabled flag	false
ingress.version	ilum-core ingress version	v1
ingress.className	ilum-core ingress class name	""
ingress.host	ilum-core ingress host	host
ingress.tls	ilum-core ingress tls configuration	[]
ingress.tls[x].secretName	ilum-core ingress secret name to apply for a single tls configuration entry
ingress.tls[x].hosts	ilum-core ingress hosts list to apply for a single tls configuration entry
ingress.annotations	ilum-core ingress annotations in yaml format	nginx.ingress.kubernetes.io/rewrite-target: /$1 nginx.ingress.kubernetes.io/proxy-body-size: "600m" nginx.org/client-max-body-size: "600m"
ingress.path	ilum-core ingress path	/(.*)
ingress.pathType	ilum-core ingress pathType	Prefix

ilum-core livenessProbe/readinessProbe parameters

Name	Description	Value
readinessProbe	ilum-core readinessProbe configuration	readinessProbe: failureThreshold: 3 httpGet: path: /api/dev/reactive/health port: http scheme: HTTP initialDelaySeconds: 60 periodSeconds: 10 successThreshold: 1 timeoutSeconds: 1
livenessProbe	ilum-core livenessProbe configuration	livenessProbe: failureThreshold: 3 httpGet: path: /api/dev/reactive/health port: http scheme: HTTP initialDelaySeconds: 60 periodSeconds: 10 successThreshold: 1 timeoutSeconds: 1

ilum-core mongo parameters

Name	Description	Value
mongo.instances	ilum-core mongo instances to connect to	mongo:27017
mongo.replicaSetName	ilum-core mongo replica set name	rs0

ilum-core kafka parameters

Name	Description	Value
kafka.address	ilum-core kafka address to connect to	kafka:9092

ilum-core grpc service parameters

Name	Description	Value
grpc.service.type	ilum-core grpc service type	ClusterIP
grpc.service.port	ilum-core grpc service port	9999
grpc.service.nodePort	ilum-core grpc service node port - required when type is LoadBalancer or NodePort	""
grpc.service.clusterIP	ilum-core grpc service cluster IP - required when type is ClusterIP	""
grpc.service.loadBalancerIP	ilum-core grpc service load balancer IP - required when type is LoadBalancer	""

ilum-core grpc parameters for spark job

Name	Description	Value
grpc.job.host	ilum-core grpc host for spark job to connect to	ilum-grpc
grpc.job.port	ilum-core grpc port for spark job to connect to	9999

ilum-core kubernetes cluster initializer parameters

Name	Description	Value
kubernetes.initClusterOnStartup	ilum-core default kubernetes cluster initialization flag	true
kubernetes.api.url	ilum-core default kubernetes cluster api url	https://kubernetes.default.svc
kubernetes.container.image	ilum-core default kubernetes cluster container image	docker.ilum.cloud/ilum-spark:3.3.0
kubernetes.sparkNamespace	ilum-core default kubernetes cluster namespace to store spark resources	{{ .Release.Namespace }}
kubernetes.s3.host	ilum-core default kubernetes cluster S3 storage host to store spark resources	s3
kubernetes.s3.port	ilum-core default kubernetes cluster S3 storage port to store spark resources	7000
kubernetes.s3.bucket	ilum-core default kubernetes cluster S3 storage bucket to store spark resources	ilum-files
kubernetes.s3.accessKey	ilum-core default kubernetes cluster S3 storage access key to store spark resources	""
kubernetes.s3.secretKey	ilum-core default kubernetes cluster S3 storage secret key to store spark resources	""

Important! Make sure S3 bucket is already created and reachable!

ilum-core security parameters

Name	Description	Value
security.admin.username	ilum-core admin username	admin
security.admin.password	ilum-core admin password	admin
security.token.expiration	ilum-core token expiration time in hours	24

ilum-core license parameters

Name	Description	Value
license.privateKey	ilum license key	""

ilum-ui

TLDR

$ helm repo add ilum https://charts.ilum.cloud
$ helm install ilum-ui ilum/ilum-ui

Installing the Chart

To install the chart with the release name ilum-ui:

$ helm install ilum-ui ilum/ilum-ui

The command deploys ilum-ui on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.

Uninstalling the Chart

To uninstall/delete the ilum-ui deployment:

$ helm delete ilum-ui

The command removes all the Kubernetes components associated with the chart and deletes the release.

Parameters

Common parameters

Name	Description	Value
nameOverride	String to partially override ilum-ui.fullname template (will maintain the release name)	""
fullnameOverride	String to fully override ilum-ui.fullname template	""

ilum-ui deployment parameters

Name	Description	Value
image	ilum-ui image	docker.ilum.cloud/ilum-ui:5.1.0
pullPolicy	ilum-ui image pull policy	IfNotPresent

ilum-ui service parameters

Name	Description	Value
service.type	ilum-ui service type	ClusterIP
service.port	ilum-ui service port	9777
service.nodePort	ilum-ui service node port - required when type is LoadBalancer or NodePort	""
service.clusterIP	ilum-ui service cluster IP - required when type is ClusterIP	""
service.loadBalancerIP	ilum-ui service load balancer IP - required when type is LoadBalancer	""

ilum-ui ingress parameters

Name	Description	Value
ingress.enabled	ilum-ui ingress enabled flag	false
ingress.version	ilum-ui ingress version	v1
ingress.className	ilum-ui ingress class name	""
ingress.tls	ilum-ui ingress tls configuration	[]
ingress.tls[x].secretName	ilum-ui ingress secret name to apply for a single tls configuration entry
ingress.tls[x].hosts	ilum-ui ingress hosts list to apply for a single tls configuration entry
ingress.annotations	ilum-ui ingress annotations in yaml format	nginx.ingress.kubernetes.io/rewrite-target: /$2 nginx.ingress.kubernetes.io/proxy-body-size: "600m" nginx.org/client-max-body-size: "600m"
ingress.path	ilum-core ingress path	/(.*)
ingress.pathType	ilum-core ingress pathType	Prefix