# wowu/docker-rollout architecture

> Architecture diagram of the GitHub repository wowu/docker-rollout, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/wowu/docker-rollout
- Repository: https://github.com/wowu/docker-rollout

## Overview

##### Project type and purpose
- This is a small open-source CLI plugin (“docker-rollout”) for zero-downtime deployments using Docker Compose. It extends the Docker CLI with a single command that scales services, waits for healthchecks, and removes old containers.

##### File structure
- Top level:
- docker-rollout (the executable script/CLI plugin)
- README.md, LICENSE, CI workflows
- docs/ (static site with usage guides, examples, caveats)
- No traditional “frontend/backend” split—this is a tooling project around Docker Compose.
- No compiled binaries or microservices; a single-binary/script interacts with Docker Engine.

##### README for insights
- The tool runs as a Docker CLI plugin.
- It detects whether to call `docker compose` or `docker-compose`.
- It implements a three-phase rollout: scale up, wait (healthchecks or fixed timeout), scale down.
- External services needed: reverse proxy (Traefik/nginx-proxy) for traffic routing.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Nodes
    Terminal["Terminal / CI Scripts"]:::terminal
    Plugin["docker-rollout Plugin Script\n(flags: --timeout, --wait)"]:::plugin
    subgraph "Docker Runtime"
        CLI["Docker CLI\n(docker compose/docker-compose)"]:::cli
        API["Docker Engine API"]:::engine
        Engine["Docker Engine"]:::engine
    end
    subgraph "Service Containers"
        New["New Replicas"]:::containerNew
        Old["Old Replicas"]:::containerOld
    end
    Proxy["Reverse Proxy\n(Traefik/nginx-proxy)"]:::proxy

    %% Flow
    Terminal -->|"docker rollout <service>"| Plugin
    Plugin -->|"invoke compose"| CLI
    CLI -->|"REST calls"| API
    API -->|"start N new"| Engine
    Engine --> New
    Engine --> Old
    Engine -->|"healthcheck polling\n(timeout, health-check)"| New
    New -->|"labels & health"| Proxy
    Proxy --> New
    Plugin -->|"remove old containers"| API
    API -->|"stop N old"| Engine
    Engine --> Old
    Old -->|"labels update"| Proxy

    %% Click Events
    click Terminal "https://github.com/wowu/docker-rollout/tree/main/.github/workflows/"
    click Plugin "https://github.com/wowu/docker-rollout/tree/main/./docker-rollout"
    click CLI "https://github.com/wowu/docker-rollout/tree/main/./docs/"
    click Proxy "https://github.com/wowu/docker-rollout/tree/main/docs/examples/"
    click Proxy "https://github.com/wowu/docker-rollout/blob/main/docs/cli-options.md"
    click Proxy "https://github.com/wowu/docker-rollout/blob/main/docs/getting-started.md"
    click Proxy "https://github.com/wowu/docker-rollout/blob/main/docs/uninstalling.md"
    click Proxy "https://github.com/wowu/docker-rollout/blob/main/docs/upgrading.md"
    click CLI "https://github.com/wowu/docker-rollout/blob/main/.github/workflows/lint.yml"
    click CLI "https://github.com/wowu/docker-rollout/blob/main/.github/workflows/pages.yml"
    click CLI "https://github.com/wowu/docker-rollout/blob/main/README.md"
    click CLI "https://github.com/wowu/docker-rollout/tree/main/LICENSE"

    %% Styles
    classDef terminal fill:#2196F3,stroke:#000,color:#fff
    classDef plugin fill:#4CAF50,stroke:#000,color:#fff
    classDef cli fill:#eeeeee,stroke:#000,color:#000
    classDef engine fill:#666666,stroke:#000,color:#fff
    classDef containerNew fill:#FFA500,stroke:#000,color:#000
    classDef containerOld fill:#FF6347,stroke:#000,color:#000
    classDef proxy fill:#9370DB,stroke:#000,color:#fff
```
