Compose Flow

This utility is built on top of Docker Compose and Swarm Mode. It establishes workflow conventions that are easily shared between team members -- and butlers -- who need to manage and deploy services, including:

managing Stacks across multiple Swarms (e.g. separate dev and prod Swarms)
connecting to and working with service containers
building and publishing images
sharing service configuration between team members

Installation

pip install compose-flow

Compose-Flow configuration

Create the file ~/.compose/config.yml with the following sections.

Build
Remotes
Options (for local dev)

ex:

build:
  image_prefix: registry.osslabs.net
remotes:
  test:
    backend: rancher
    rancher:
      project: Ops
      cluster: prod
  dev:
    backend: rancher
  prod:
    backend: rancher
options:
  local:
    dirty_working_copy_okay: True

With this in place you're ready to go onto your project setup.

A basic example

This is the most basic file to get started.

Place this at compose/compose-flow.yml in your project directory:

profiles:
  local:
    - docker-compose.yml

Alongside it, place the file compose/docker-compose.yml:

version: '3.7'
services:
  app:
    build: ..
    image: ${DOCKER_IMAGE}

For building, run: compose-flow build.

For publishing: compose-flow publish.

For deploying as configured above: compose-flow -e local deploy.

More information at docs/advanced.md

Metadata

Release files for compose-flow 4.0.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 compose-flow 4.0.0
File	Size	Uploaded
compose-flow-4.0.0.tar.gz	98.1 kB	Jul 31, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for compose-flow 4.0.0
File	Interpreter	ABI	Platform	Reset
compose_flow-4.0.0-py3.9.egg 186.2 kB Jul 31, 2023	Legacy Egg format	-	-	Details

Total release size: 284.3 kB

Release files / compose-flow-4.0.0.tar.gz

Download URL	compose-flow-4.0.0.tar.gz
Size	98.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`6a0c22a77fa2517affdf705cdd77dbfdd1a92e5a73521d89f303fd84f90d23ba`
BLAKE2b-256 checksum How to use checksums	`fd026abd9c23105aad1b98dbc1d6a5c5ffd491921a4f864d3ee630ee218e6992`
Upload date	Jul 31, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.9.17`

Release files / compose_flow-4.0.0-py3.9.egg

Download URL	compose_flow-4.0.0-py3.9.egg
Size	186.2 kB
Tags	Egg
SHA-256 checksum How to use checksums	`503c6ff2440c6f7a4d1163ec56c7de8202a494098f982b441729857ede4b08df`
BLAKE2b-256 checksum How to use checksums	`b2d0a07d93bcaccdbd02b12f0bb037010778063421ca633d2d345d48c714c0b7`
Upload date	Jul 31, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.9.17`