Skip to main content

Generate Shenron docker-compose deployments from model config files

Project description

Shenron

Shenron now ships as a config-driven generator for production LLM docker-compose deployments.

shenron reads a model config YAML and generates:

  • docker-compose.yml
  • .generated/onwards_config.json
  • .generated/prometheus.yml
  • .generated/scouter_reporter.env
  • .generated/vllm_start.sh

Quick Start

uv pip install shenron
shenron get
docker compose up -d

shenron get reads a per-release config index asset, shows available configs with arrow-key selection, downloads the chosen config, and generates deployment artifacts in the current directory. Using --release latest also rewrites shenron_version in the downloaded config to latest. You can also override config values on download with:

  • --api-key (writes api_key)
  • --scouter-api-key (writes scouter_ingest_api_key)
  • --scouter-collector-instance (writes scouter_collector_instance; alias: --scouter-colector-instance)

shenron . still works and expects exactly one config YAML (*.yml or *.yaml) in the current directory, unless you pass a config file path directly.

Configs

Repo configs are stored in configs/.

Available starter configs:

  • configs/Qwen06B-cu126-TP1.yml
  • configs/Qwen06B-cu129-TP1.yml
  • configs/Qwen06B-cu130-TP1.yml
  • configs/Qwen30B-A3B-cu126-TP1.yml
  • configs/Qwen30B-A3B-cu129-TP1.yml
  • configs/Qwen30B-A3B-cu129-TP2.yml
  • configs/Qwen30B-A3B-cu130-TP2.yml
  • configs/Qwen235-A22B-cu129-TP2.yml
  • configs/Qwen235-A22B-cu129-TP4.yml
  • configs/Qwen235-A22B-cu130-TP2.yml

This file uses the same defaults that were previously hardcoded in docker/run_docker_compose.sh.

Generated Compose Behavior

docker-compose.yml is fully rendered from config values:

  • model image tag from shenron_version + cuda_version
  • onwards image tag from onwards_version
  • service ports from config
  • no ${SHENRON_VERSION} placeholders

Development

# Run tests (Rust + CLI + compose checks)
./scripts/ci.sh

# Install local package for manual testing
python3 -m pip install -e .

# Generate from repo config
shenron configs/Qwen06B-cu126-TP1.yml --output-dir /tmp/shenron-test

Release Automation

  • release-assets.yaml publishes stamped config files (*.yml) as release assets.
  • release-assets.yaml also publishes configs-index.txt, which powers shenron get.
  • python-release.yaml builds/publishes the shenron package to PyPI on release tags.
  • Docker image build/push via Depot remains in ci.yaml and still triggers when docker/Dockerfile.cu* or VERSION changes.

License

MIT, see LICENSE.

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

shenron-0.10.0.tar.gz (33.1 kB view details)

Uploaded Source

Built Distribution

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

shenron-0.10.0-cp311-cp311-manylinux_2_34_x86_64.whl (417.7 kB view details)

Uploaded CPython 3.11manylinux: glibc 2.34+ x86-64

File details

Details for the file shenron-0.10.0.tar.gz.

File metadata

  • Download URL: shenron-0.10.0.tar.gz
  • Upload date:
  • Size: 33.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for shenron-0.10.0.tar.gz
Algorithm Hash digest
SHA256 478703b125e20a443f5e1c5bee5adaf3e634b774ca0089c6754e78c2555cdbaa
MD5 b5d2d976e625314d783360423340ace6
BLAKE2b-256 e134947899da2080d6eba3790173f35559363ddb6cf03b8bafce2ed3984b0430

See more details on using hashes here.

Provenance

The following attestation bundles were made for shenron-0.10.0.tar.gz:

Publisher: python-release.yaml on doublewordai/shenron

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file shenron-0.10.0-cp311-cp311-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for shenron-0.10.0-cp311-cp311-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 7f8abbc15f60efabef879708da06359725ea1befdba1dfab0c2dfc3f866b62f5
MD5 e6a09bf359fed4abc3b14a2874856762
BLAKE2b-256 ca76179b38830590709e348c967fe615934cbcfcfa4b0f000c66130def26dadc

See more details on using hashes here.

Provenance

The following attestation bundles were made for shenron-0.10.0-cp311-cp311-manylinux_2_34_x86_64.whl:

Publisher: python-release.yaml on doublewordai/shenron

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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