Skip to main content

CLI installer and management tool for the Ilum Data Lakehouse platform

Project description

ilum

CLI tool for deploying and managing the Ilum Data Lakehouse platform on Kubernetes.

Manage Helm-based Ilum deployments with module dependency resolution, values safety, interactive wizards, health checks, and structured output — all from a single command.

Install

pip install ilum

Requires Python 3.12+.

Quick Start

# Interactive setup — walks you through cluster selection and module configuration
ilum init
ilum install

# Or one command — detects/creates a cluster and installs with defaults
ilum quickstart

# Check release status
ilum status

# Enable an optional module (resolves dependencies automatically)
ilum module enable sql

Key Features

  • Install and upgradeilum install / ilum upgrade with module resolution, stuck-release recovery, and breaking-change warnings
  • 32 optional modules — enable/disable with automatic dependency resolution (ilum module enable langfuse pulls in postgresql + clickhouse)
  • Values safety — every upgrade detects external drift, computes a diff, and shows it for confirmation before applying
  • Health checksilum doctor runs 13 checks covering binaries, cluster connectivity, pod health, RBAC, PVCs, and endpoints
  • Deployment presets--preset production, --preset data-engineering, --preset air-gapped
  • Local clustersilum cluster create spins up k3d/minikube/kind with preset resource profiles
  • Log streamingilum logs core --follow tails pod logs by module name
  • Resource monitoringilum top shows per-module CPU/memory usage
  • Shell accessilum exec core opens an interactive shell in any module pod
  • Configuration profiles — named profiles with cross-platform config (Linux, macOS, Windows)
  • Machine-readable output--output json|yaml|csv on all query commands for CI/CD pipelines
  • Shell completionilum --install-completion bash/zsh/fish

Commands

Command Description
ilum init Interactive setup wizard
ilum quickstart One-command install with defaults
ilum install Install the platform
ilum upgrade Upgrade an existing installation
ilum status Release info, pod readiness, modules
ilum module enable/disable Manage modules with dependency resolution
ilum module list List all 32 available modules
ilum doctor Run health checks
ilum logs <module> Stream pod logs
ilum exec <module> Shell into a pod
ilum top Resource usage per module
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 connect Attach to an existing Ilum release
ilum cleanup Tiered full-environment teardown

Prerequisites

ilum wraps Helm and kubectl — these must be available on your machine:

Tool Minimum Version
Helm 3.12+
kubectl 1.28+
Docker 24.0+ (for local clusters)

Missing tools? ilum deps install will install them for you.

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-6.7.0.tar.gz (358.7 kB view details)

Uploaded Source

Built Distribution

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

ilum-6.7.0-py3-none-any.whl (176.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ilum-6.7.0.tar.gz
  • Upload date:
  • Size: 358.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","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-6.7.0.tar.gz
Algorithm Hash digest
SHA256 29d61fd1739c06857bf3ef71338cf8d0098229e979f0a6f49441409d1dacafb7
MD5 921482e7ba7d4c612caca21099a2f3f4
BLAKE2b-256 aab74a6284b3d3fc4b651b6692a5fa2cdfbb796dbb6da37f95e7e46a74240a27

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ilum-6.7.0-py3-none-any.whl
  • Upload date:
  • Size: 176.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","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-6.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7f3969c24a0280531b6a10a8eb55a17beb3ddd42260383d0c46bfc9231647344
MD5 a1f5288a991ae687a02a006546968433
BLAKE2b-256 949f44bd82bae2f2a21aa743d7f0e9ed9f4f6af9e2c7a9fe6f27075213c1aa63

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