Skip to main content

No project description provided

Project description

## Shepherd

Shepherd provides a system for configuring and launching clusters (or flocks) of Docker containers.

Feature include:
  • YAML definition of each “flock” including environment, volumes, external networks.

  • API and HTTP API for starting, stopping, pausing and resuming instances of each flock.

  • User overrides, including environment variables and ‘descendant’ images

  • Multiple pools for managing running flocks/

  • Queuing with fixed pool size and queing (fixed size pool)

  • Persistent pool for time-slicing flock execution.

### Comparison to Docker Compose

The flock format is inspired by compose and supports a limited subset of compose spec. Unlike with Compose, which runs a single docker-compose.yml at a time, the intent of Shepherd is to manage multiple instances of each available flock, and to schedule their execution. Each instance is given a unique id which can be used to refer to the instance.

### Use Cases and Test Suite

This library does not include any specific flocks and is designed to be as generic as possible.

It only uses very small public Docker containers for the test suite, which can be run via: python setup.py test after installing with python setup.py install

For an example implementation that uses Shepherd and additional flock definitions, see https://github.com/oldweb-today/browser-shepherd

### Other dependencies

Besides Docker, Shepherd relies on Redis to store internal state (though can be used with an in-memory ‘fake’ redis as well).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shepherd-1.1.0.tar.gz (280.6 kB view details)

Uploaded Source

Built Distribution

shepherd-1.1.0-py2.py3-none-any.whl (283.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file shepherd-1.1.0.tar.gz.

File metadata

  • Download URL: shepherd-1.1.0.tar.gz
  • Upload date:
  • Size: 280.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.1 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.1

File hashes

Hashes for shepherd-1.1.0.tar.gz
Algorithm Hash digest
SHA256 c9ec8c2e9630ba1a6124ff3e7987f705ee69ea93e02ccabbe6850c951f5cfdf3
MD5 5c428539ce7795b7bae7e329124f2155
BLAKE2b-256 cc4158df6c72ecfbc1cd686fcda880918a09cb230647ffca35c547fa8253f92e

See more details on using hashes here.

File details

Details for the file shepherd-1.1.0-py2.py3-none-any.whl.

File metadata

  • Download URL: shepherd-1.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 283.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.1 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.1

File hashes

Hashes for shepherd-1.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9fc3414e2a9b7469f75d95ad59b3814e2e55b45e11d182304df19aac3ed8f982
MD5 3faadf674b77c87a2359598a010de8f8
BLAKE2b-256 71f7edab2812124f488f86967affed4ee3268b10b1d092d184a071eb3f02e4da

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page