Skip to content

Latest commit

 

History

History
212 lines (151 loc) · 5.95 KB

Docker_Build_Pipeline.md

File metadata and controls

212 lines (151 loc) · 5.95 KB

Docker Build Pipeline

This document covers the CI/CD infrastructure for building and deploying worker-flash Docker images.

Overview

The worker-flash repository maintains four Docker images:

  1. GPU Image (runpod/flash) - Queue-based serverless worker with CUDA
  2. CPU Image (runpod/flash-cpu) - Queue-based serverless worker for CPU-only
  3. Load Balancer GPU Image (runpod/flash-lb) - HTTP-based Load Balancer worker with CUDA
  4. Load Balancer CPU Image (runpod/flash-lb-cpu) - HTTP-based Load Balancer worker for CPU-only

All images are automatically built and pushed via GitHub Actions workflows.

Pipeline Stages

Stage 1: Pull Request Testing

Trigger: All pull requests and pushes to main

Jobs:

  • docker-test - Validates GPU image builds
  • docker-test-lb - Validates Load Balancer GPU image builds
  • docker-test-lb-cpu - Validates Load Balancer CPU image builds

What it does:

  • Builds the Docker images locally
  • Validates Dockerfile syntax
  • Checks that all dependencies resolve
  • Does NOT push to Docker Hub

Status checks: Required to pass before merging

Stage 2: Main Branch Deployment

Trigger: Pushes to main branch (when no release is created)

Jobs:

  • docker-main-gpu - Pushes GPU image
  • docker-main-cpu - Pushes CPU image
  • docker-main-lb - Pushes Load Balancer GPU image
  • docker-main-lb-cpu - Pushes Load Balancer CPU image

What it does:

  • Builds the Docker images
  • Pushes to Docker Hub with :main tag
  • Useful for testing development versions
  • Skipped if a release was just created

Image tags:

  • runpod/flash:main
  • runpod/flash-cpu:main
  • runpod/flash-lb:main
  • runpod/flash-lb-cpu:main

Stage 3: Release Deployment

Trigger: When a release is created via release-please

Jobs:

  • docker-prod-gpu - Pushes GPU image with version tags
  • docker-prod-cpu - Pushes CPU image with version tags
  • docker-prod-lb - Pushes Load Balancer GPU image with version tags
  • docker-prod-lb-cpu - Pushes Load Balancer CPU image with version tags

What it does:

  • Builds the Docker images
  • Pushes with semantic version tags (e.g., 0.7.3)
  • Also pushes :latest tag
  • Automatically triggered by release-please

Image tags:

  • runpod/flash:0.7.3 and runpod/flash:latest
  • runpod/flash-cpu:0.7.3 and runpod/flash-cpu:latest
  • runpod/flash-lb:0.7.3 and runpod/flash-lb:latest
  • runpod/flash-lb-cpu:0.7.3 and runpod/flash-lb-cpu:latest

Pipeline Flow

graph TD
    A["Pull Request"] --> B["test"]
    A --> C["lint"]
    B --> D["docker-test"]
    C --> D
    B --> E["docker-test-lb"]
    C --> E
    D --> F["release"]
    E --> F
    F --> G["docker-main-gpu"]
    F --> H["docker-main-cpu"]
    F --> I["docker-main-lb"]

    J["Main Branch Push<br/>with Release"] --> K["release-please"]
    K --> L["docker-prod-gpu"]
    K --> M["docker-prod-cpu"]
    K --> N["docker-prod-lb"]

    style D fill:#FF9800,stroke:#E65100,stroke-width:2px,color:#fff
    style E fill:#FF9800,stroke:#E65100,stroke-width:2px,color:#fff
    style G fill:#4CAF50,stroke:#2E7D32,stroke-width:2px,color:#fff
    style H fill:#4CAF50,stroke:#2E7D32,stroke-width:2px,color:#fff
    style I fill:#4CAF50,stroke:#2E7D32,stroke-width:2px,color:#fff
    style L fill:#F44336,stroke:#C62828,stroke-width:2px,color:#fff
    style M fill:#F44336,stroke:#C62828,stroke-width:2px,color:#fff
    style N fill:#F44336,stroke:#C62828,stroke-width:2px,color:#fff
    style F fill:#2196F3,stroke:#1565C0,stroke-width:2px,color:#fff
Loading

Building Locally

Build GPU Image

make build-gpu

Builds runpod/flash:local for testing locally.

Build CPU Image

make build-cpu

Builds runpod/flash-cpu:local for testing locally.

Build Load Balancer Image

make build-lb

Builds runpod/flash-lb:local for testing locally.

Build CPU Load Balancer Image

make build-lb-cpu

Builds runpod/flash-lb-cpu:local for testing locally.

Build All Images

make build

Builds both GPU and CPU images (does not build Load Balancer image).

Docker Hub Credentials

The pipeline requires Docker Hub credentials configured as GitHub repository secrets:

  • DOCKERHUB_USERNAME - Docker Hub username
  • DOCKERHUB_TOKEN - Docker Hub password or personal access token

These are used by the docker/login-action step to authenticate with Docker Hub.

Release Process

Releases are managed automatically via release-please:

  1. Detect conventional commits on main branch
  2. Create pull request with version bump and changelog
  3. User merges the release PR
  4. release-please creates a Git tag and release
  5. CI/CD triggers production image builds and pushes

Commit Message Convention

Use conventional commit messages to trigger releases:

  • feat: - Feature (triggers minor version bump)
  • fix: - Bug fix (triggers patch version bump)
  • BREAKING CHANGE: - Breaking change (triggers major version bump)

Example:

git commit -m "feat(executor): add async function execution support"
git commit -m "fix(handler): correct dependency installation order"

Troubleshooting

Docker Build Fails

  1. Check pyproject.toml syntax
  2. Verify Dockerfile* line endings (LF not CRLF)
  3. Ensure uv.lock is up to date: uv lock --upgrade
  4. Test locally: make build-lb (for Load Balancer)

Image Not Pushed to Docker Hub

  1. Verify Docker Hub credentials are set in GitHub secrets
  2. Check CI/CD job logs for authentication errors
  3. Ensure you're on main branch for main builds
  4. Ensure release tag exists for production builds

Release PR Not Created

  1. Check that commits follow conventional commit format
  2. Ensure release-please workflow is enabled
  3. Verify release-please app has access to repository
  4. Check repository settings > Actions permissions

See Also