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
wget https://github.com/doublewordai/shenron/releases/download/v0.6.0/Qwen06B-cu126-TP1.yml
shenron .
docker compose up -d

shenron . 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/.

Current starter config:

  • configs/Qwen06B-cu126-TP1.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.
  • 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.6.3.tar.gz (27.7 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.6.3-cp311-cp311-manylinux_2_34_x86_64.whl (414.2 kB view details)

Uploaded CPython 3.11manylinux: glibc 2.34+ x86-64

File details

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

File metadata

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

File hashes

Hashes for shenron-0.6.3.tar.gz
Algorithm Hash digest
SHA256 ee6020fcd48c1657c58b670e8d63f5d5abaa40667efa2796a66f8678b15ce218
MD5 b5957db96ef75f727fa1a597e6bd8714
BLAKE2b-256 b8613a04aec84213bd7fe4d67df2ddb20f4cc9476cb3ab670f4a4531e2d9416e

See more details on using hashes here.

Provenance

The following attestation bundles were made for shenron-0.6.3.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.6.3-cp311-cp311-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for shenron-0.6.3-cp311-cp311-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 e19fef658b7cddb85dd38fcb1b02a00f9181d2031a011c921953f26e32d3e44f
MD5 7e08a20f7da6c87caef60bdfeec1f2f4
BLAKE2b-256 040d2956d9e321a1c33c4d54828f3c790aa6dfb7781247da79cc97ea2ed29b53

See more details on using hashes here.

Provenance

The following attestation bundles were made for shenron-0.6.3-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