Skip to content

Latest commit

 

History

History

README.md

Running Hackolade Studio CLI in Docker

Docker Image Version (latest by date)

Run the Hackolade Studio CLI in Docker — typically in CI/CD pipelines.

Not supported: running the Hackolade GUI in a container.

Requires Docker.

Writable paths — /data and /tmp (recommended)

Prefer /data + /tmp. License state, logs, models, output, and settings go under /data; sockets, caches, and scratch go to /tmp. The image redirects runtime writes there via XDG environment variables.

Legacy bind mounts (/home/hackolade/.config, /home/hackolade/Documents/*, …) from older examples can still work on a writable root filesystem, but the consolidated layout is recommended — especially for hardened Compose, read-only rootfs, and Kubernetes.

Mount both /data and /tmp on every run. With read_only: true, only those two paths are writable.

Full breakdown: getting-started-hck-cli.md.

Documentation

Guide Description
getting-started-hck-cli.md Start here — /data + /tmp layout, profiles, quick start
example-offline-metadata-pipeline.md Full worked example — image upgrade, offline license, version / showLicense / listLogs / showLogs, revEng → compMod → forweng → genDoc
docker-cli-howto.md docker run templates (local and hardened)
license-validation.md Floating license — online and offline
k8s/README.md Kubernetes Jobs (Restricted profile)
custom-certificates.md Trust private CAs
getting-started.md Legacy — custom-built hackolade/studio images
docker compose -f compose.hardened.yml run --rm hck-cli

Always use run --rm for one-off CLI jobs — without it, stopped …-run-… containers pile up and Compose warns about orphans.

Compose & manifests

File Profile
compose.yml Local — /data + /tmp, writable rootfs
compose.hardened.yml Hardened (CI / production) — read-only rootfs, cap_drop: ALL
k8s/ Kubernetes — same mounts + Restricted Pod Security Standard

Custom builds (legacy)

Build your own image when you need a custom plugin set: build.md, Dockerfile, docker-compose.yml.

Windows batch helpers: docker-help.bat, docker-validateKey.bat, docker-genDoc.bat.

Licensing

Docker CLI requires a floating license with an available seat. Workstation licenses do not work in containers. See license-validation.md. Contact support@hackolade.com to purchase.