Skip to main content

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.

Python 3.11+

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ilum-0.0.4.1.tar.gz (366.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ilum-0.0.4.1-py3-none-any.whl (177.7 kB view details)

Uploaded Python 3

File details

Details for the file ilum-0.0.4.1.tar.gz.

File metadata

  • Download URL: ilum-0.0.4.1.tar.gz
  • Upload date:
  • Size: 366.4 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

Hashes for ilum-0.0.4.1.tar.gz
Algorithm Hash digest
SHA256 ac947c26bc223cd3fd0fc6d961951de59bef6437588cb20babdfd0338b306bc9
MD5 bf1900e3e23406714caa62b060545ed1
BLAKE2b-256 409d25729c472f56c5a2d3551567476d9a2e9cc7d1ec2c0324a05c380047ab5a

See more details on using hashes here.

File details

Details for the file ilum-0.0.4.1-py3-none-any.whl.

File metadata

  • Download URL: ilum-0.0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 177.7 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

Hashes for ilum-0.0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 484e4ec22cc3b2512c8f05452a61f19184be44ccb2398ad661ab4d3bf1951521
MD5 b57eeb535661d7a6bd9534a63d3a7dad
BLAKE2b-256 ff5effb7c0b7407dcdcfbcb9ff3f372a6e8231e19f31af1df1e3f6906b44460a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page