CLI installer and management tool for the Ilum Data Lakehouse platform
Project description
ilum CLI
Deploy and manage the Ilum Data Lakehouse platform on Kubernetes — from a single command.
What is ilum?
The ilum CLI wraps Helm and kubectl into a single tool purpose-built for the Ilum platform. It manages 32 modules with automatic dependency resolution, detects configuration drift between upgrades, and provides interactive wizards, health checks, and structured output — so you never have to hand-edit Helm values or chase dependency order again.
Quickstart
Install
Linux / macOS
curl -fsSL https://get.ilum.cloud/cli | bash
Windows (PowerShell)
irm https://get.ilum.cloud/cli/windows | iex
pip / pipx / uv
pip install ilum # or: pipx install ilum / uv tool install ilum
Deploy
ilum quickstart
One command that:
- Checks prerequisites (Helm, kubectl, Docker)
- Detects an existing cluster or creates a local one (k3d/minikube/kind)
- Installs the Ilum platform with sensible defaults
- Shows deployment status when complete
Once running:
ilum status # release info, pod readiness, enabled modules
ilum access open # open the Ilum UI in your browser
Step-by-step alternative
Prefer full control? Use the interactive wizard instead:
ilum init # configure cluster, select modules, set options
ilum install # deploy with your configuration
Key Commands
| Command | Description | |
|---|---|---|
| Setup | ilum init |
Interactive setup wizard |
ilum quickstart |
One-command install with defaults | |
ilum install |
Install the platform | |
ilum upgrade |
Upgrade an existing installation | |
ilum connect |
Attach to an existing Ilum release | |
| Operations | ilum status |
Release info, pod readiness, modules |
ilum doctor |
Run 13 health checks | |
ilum logs <module> |
Stream pod logs | |
ilum exec <module> |
Shell into a pod | |
ilum top |
Resource usage per module | |
| Modules | ilum module enable <name> |
Enable a module (resolves deps) |
ilum module disable <name> |
Disable a module | |
ilum module list |
List all 32 available modules | |
| Config | ilum values |
View live Helm values |
ilum diff |
Compare values across sources | |
ilum rollback |
Roll back to a previous revision | |
ilum config |
Manage CLI configuration and profiles | |
ilum cleanup |
Tiered full-environment teardown |
Modules
Ilum ships with 32 optional modules organized into 10 categories. When you enable a module, the CLI automatically resolves and enables its dependencies.
| Category | Modules |
|---|---|
| Core | core, ui, api, livy-proxy |
| Notebooks | jupyter, jupyterhub, zeppelin |
| SQL & Catalogs | sql (Kyuubi), trino, hive-metastore, nessie, unity-catalog |
| Orchestration | airflow, kestra, n8n, nifi, mageai |
| Analytics | superset, streamlit, marquez |
| AI & ML | mlflow, langfuse |
| Infrastructure | mongodb, kafka, postgresql, gitea, clickhouse |
| Storage | minio |
| Monitoring | monitoring (Prometheus + Grafana), loki, graphite |
| Security | openldap |
# Enable langfuse — automatically pulls in postgresql + clickhouse
ilum module enable langfuse
Prerequisites
| Tool | Minimum Version | Notes |
|---|---|---|
| Helm | 3.12+ | Required |
| kubectl | 1.28+ | Required |
| Docker | 24.0+ | For local clusters only |
ilum quickstart and ilum deps install handle missing tools automatically.
Documentation
Full documentation is available at ilum.cloud/docs.
Links
- ilum.cloud — Platform homepage
- Documentation
- Issues
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ilum-0.0.4.2.tar.gz.
File metadata
- Download URL: ilum-0.0.4.2.tar.gz
- Upload date:
- Size: 366.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.5 {"installer":{"name":"uv","version":"0.10.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f64566572e29e21a61389dcd5778cd2b67031e15b80b52b2844f8c85bf01d070
|
|
| MD5 |
bd0bd738baeea42b56fa8450bad3e2dd
|
|
| BLAKE2b-256 |
eed25b24770ae2197ff67389672311eb8f730d3f258c1dbb4dc92d2fcc5c59c1
|
File details
Details for the file ilum-0.0.4.2-py3-none-any.whl.
File metadata
- Download URL: ilum-0.0.4.2-py3-none-any.whl
- Upload date:
- Size: 177.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.5 {"installer":{"name":"uv","version":"0.10.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
17b81b380457db9bd08847bc95298318d321065b646ad6fd64162f259000fd1c
|
|
| MD5 |
012357aa66e56644e6ca76e91711c94a
|
|
| BLAKE2b-256 |
8d19052b9c3f04810bf9a46db730c590bfd045e136b9a2df0df96d31d5e95596
|