docker/Studio/compose.yml at main · hackolade/docker · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
#
# Copyright © 2016-2026 by IntegrIT S.A. dba Hackolade.  All rights reserved.
#
# The copyright to the computer software herein is the property of IntegrIT S.A.
# The software may be used and/or copied only with the written permission of
# IntegrIT S.A. or in accordance with the terms and conditions stipulated in
# the agreement/contract under which the software has been supplied.
#

# Example Docker Compose file for the pre-built hackolade/hck-cli image from Docker Hub.
# The image includes Hackolade Studio and all plugins — ready to use without a build step.
#
# WRITABLE PATHS: prefer /data and /tmp (consolidated mounts).
#   /data  persistent volume — license (/data/app), logs, models, output, settings
#   /tmp   tmpfs — sockets, caches, scratch (ephemeral)
# Legacy /home/hackolade/.config and /home/hackolade/Documents/* may still work
# on a writable rootfs, but use /data + /tmp for new setups (see getting-started-hck-cli.md).
#
# Same two paths in compose.hardened.yml and k8s/ — hardened adds read-only rootfs + caps.
# Image: hackolade/hck-cli:<version> or <version>-hardened (see doc/image-variants.md).
#
# Documentation: doc/getting-started-hck-cli.md
# Custom builds on hackolade/studio: docker-compose.yml + doc/getting-started.md
#
# Usage: docker compose run --rm …  (always --rm for one-off CLI jobs)

services:
  # Run a CLI command (defaults to version).
  # Paths below are inside the container. Mount host files or folders through volumes.
  #
  # Examples:
  #   docker compose run -t --rm validateKeyOnline
  #   docker compose run -t --rm hck-cli genDoc --format=HTML \
  #     --model '/data/models/MongoDB/Yelp Challenge dataset.hck.json' \
  #     --doc /data/output/doc-test --jsonSchema
  hck-cli: &hck-cli
    image: hackolade/hck-cli:8.12.8
    command: ["version"]
    restart: 'no'
    # network_mode: 'none'
    volumes:
      # Persistent state — license, logs, models, output (see doc/getting-started-hck-cli.md).
      - hackolade-studio-data:/data
      - ${PWD}/models:/data/models
    tmpfs:
      # Ephemeral scratch — same consolidated layout as compose.hardened.yml and k8s/.
      - /tmp:rw,size=1g,mode=1777

  showComputerIdForOfflineValidation:
    extends: hck-cli
    # Prints Computer ID + ready-to-open QLM URL for LicenseFile.xml download
    command: ["getComputerId"]

  # validateKeyOfflineFromFile:
  #   extends: hck-cli
  #   network_mode: 'none'
  #   command:
  #     - validateKey
  #     - --file
  #     - /data/LicenseFile.xml
  #   volumes:
  #     - $HOME/Downloads/LicenseFile.xml:/data/LicenseFile.xml

  # validateKeyOnlineFromFile:
  #   extends: hck-cli
  #   command:
  #     - validateKey
  #     - --key
  #     - /data/license-key.txt
  #   volumes:
  #     - $HOME/Downloads/license-key.txt:/data/license-key.txt

  validateKeyOffline:
    extends: hck-cli
    network_mode: 'none'
    command: ["validateKey"]
    secrets:
      - license_file

  validateKeyOnline:
    extends: hck-cli
    command: ["validateKey"]
    network_mode: host
    secrets:
      - license_key

volumes:
  # Required for licensing and persistent CLI state.
  hackolade-studio-data:

secrets: # Don't change the secret names — the CLI looks them up by these values.
  license_key:
    file: ${HOME}/Downloads/license-key.txt
  license_file:
    file: ${HOME}/Downloads/LicenseFile.xml