Skip to main content

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: there is no default tag, and only the tag you name is pulled.

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> -r
wos-deploy deploy

Commands

Command Description
wos-deploy setup-folder <name> Create a deployment folder
wos-deploy setup-private --wosgw H:P Configure a private ring (host arch auto-detected)
wos-deploy setup-global Configure a global ring
wos-deploy setup-rfq Configure a tick-quote add-on instance
wos-deploy deploy [--skip-pull] Pull images and start services
wos-deploy re-setup Regenerate an instance's generated layer
wos-deploy restart [SERVICE] Restart services without reinitialising
wos-deploy shutdown [SERVICE] Stop services
wos-deploy status [-j] Container status
wos-deploy logs [-f] [SERVICE] Service logs
wos-deploy shell <SERVICE> Interactive shell in a container
wos-deploy config Resolved configuration (secrets masked)
wos-deploy rollback Return to the images of the previous deploy
wos-deploy reset Remove containers, volumes and state

Building from source

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

Licence

Apache-2.0 (see LICENSE).

Metadata

Release files for wos-deploy 2.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for wos-deploy 2.1.0
File Size Uploaded
wos_deploy-2.1.0.tar.gz 53.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for wos-deploy 2.1.0
File Interpreter ABI Platform
wos_deploy-2.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 119.7 kB

Release files / wos_deploy-2.1.0.tar.gz

Download URL wos_deploy-2.1.0.tar.gz
Size 53.7 kB
Tags Source
SHA-256 checksum
How to use checksums
2d2e6941d8f226a374fe8e9196543db20b86a7942889f26e41c7cfb83536448c
BLAKE2b-256 checksum
How to use checksums
2a50f17f9b125102512ffcbfded8bc638037eb96048be4535386a5f172190af7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.11

Release files / wos_deploy-2.1.0-py3-none-any.whl

Download URL wos_deploy-2.1.0-py3-none-any.whl
Size 66.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cd7b7030cebddb29caf2ba488e87ca6343c6d97770d514b8fe9517c0bcf81111
BLAKE2b-256 checksum
How to use checksums
4f09c7fbefc2f5f87c392bf7eebace9cc82d85f66879d632214c0db9ffedb2a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.11

Release history Release notifications | RSS feed

This release

2.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page