docker-rollout

<div align="center">
<h1>
<code>docker rollout</code><br>
Zero Downtime Deployment for Docker Compose
</h1>

[Documentation](https://docker-rollout.wowu.dev)
</div>


Docker CLI plugin that updates Docker Compose services without downtime.

Simply replace `docker compose up -d <service>` with `docker rollout <service>` in your deployment scripts. This command will scale the service to twice the current number of instances, wait for the new containers to be ready, and then remove the old containers.

- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
  - [⚠️ Caveats](#️-caveats)
  - [Sample deployment script](#sample-deployment-script)
  - [Draining old containers](#draining-old-containers)
- [Community integrations](#community-integrations)
- [Why?](#why)
- [License](#license)

## Features

- ⏳ Zero downtime deployment for Docker Compose services
- 🐳 Works with Docker Compose and `docker-compose`
- ❤️ Supports Docker healthchecks out of the box

## Installation

```bash
# Create directory for Docker cli plugins
mkdir -p ~/.docker/cli-plugins

# Download docker-rollout script to Docker cli plugins directory
curl https://raw.githubusercontent.com/wowu/docker-rollout/main/docker-rollout -o ~/.docker/cli-plugins/docker-rollout

# Make the script executable
chmod +x ~/.docker/cli-plugins/docker-rollout
```

If you use docker with sudo, or want to make docker-rollout available for all users, install it to `/usr/local/lib/docker/cli-plugins/` instead.

## Usage

Run `docker rollout <name>` instead of `docker compose up -d <name>` to update a service without downtime. If you have both `docker compose` plugin and `docker-compose` command available, docker-rollout will use `docker compose` by default.

```bash
$ docker rollout -f docker-compose.yml <service-name>
```

Options:

- `-f | --file PATH` - (not required) - Path to compose file, can be specified multiple times, as in `docker compose`.
- `-t | --timeout SECONDS` - (not required) - Timeout in seconds to wait for new container to become healthy, if the container has healthcheck defined in `Dockerfile` or `docker-compose.yml`. Default: 60
- `-w | --wait SECONDS` - (not required) - Time to wait for new container to be ready if healthcheck is not defined. Default: 10
- `--wait-after-healthy SECONDS` - (not required) - Time to wait after new container is healthy before removing old container. Works when healthcheck is defined. Gives the proxy time to register the new container. Default: 3
- `--env-file PATH` - (not required) - Path to env file, can be specified multiple times, as in `docker compose`.
- `-p | --project-name NAME` - (not required) - Project name, as in `docker compose`.
- `--profile NAME` - (not required) - Specify a profile to enable, as in `docker compose`.
- `--pre-stop-hook CMD` - (not required) - Command to run in the old container before stopping it. Can be used for marking the container as unhealthy to make proxy stop sending requests to it, see [container dr