wos-deploy

wos-deploy — create and operate WOS server instances with Docker Compose on published wos-prod-s* images: a private ring, a global ring, or a tick-quote add-on (RFQ) instance with an optional realtime CTP feeder.

Requirements

• Python 3.9+ (the tool is stdlib-only)
• Docker Engine with the compose plugin (docker compose)
• Linux or macOS host, x86_64 or arm64

Install

pip install wos-deploy
wos-deploy --version

wos is installed as a short alias of wos-deploy; every command below works with either name.

Quick start — a tick-quote add-on (RFQ) instance

wos-deploy setup-folder ./my-rfq --env prod --port-offset 37
cd my-rfq
wos-deploy setup-rfq -r --image-tag <tag-with-the-rfq-role>   # add --registry HOST:PORT for a private registry
wos-deploy deploy
wos-deploy config        # prints the storage-master and upload-web endpoints

--image-tag is required on every setup-* kind: there is no default tag, and only the tag you name is pulled (WOS_PRIMARY_IMAGE=<repository>:<tag> names the whole reference instead).

Ports are published on 127.0.0.1 by default (this host only). --publish-lan (all interfaces) or --bind ADDRESS opens them to other machines — including the database and the container's SSH; the tool warns and names them. An instance set up with 2.1 or earlier keeps publishing on all interfaces after the upgrade (recorded as WOS_BIND=0.0.0.0 in its .env with a one-line notice); set WOS_BIND=127.0.0.1 there and wos-deploy restart to move it to loopback.

With --enable_ctp (and --enable_secondary on an arm64 host) the realtime CTP feeder runs on an x64 service with your own CTP account; the inputs are stored only in ./rfq-ctp.env (mode 0600). See wos-deploy setup-rfq --help.

Quick start — a private ring

wos-deploy setup-folder ./my-ring --env prod --port-offset 3
cd my-ring
wos-deploy setup-private --wosgw <global-gateway-host>:<port> --image-tag <tag> -r
wos-deploy deploy

Commands

Building from source

./build.sh --wheel-only     # dist/wos_deploy-<version>-py3-none-any.whl + sdist

Licence

Apache-2.0 (see LICENSE).