birdcage's Introduction

Birdcage

Introduction

This is a simple tool providing an API and UI for the manual approval of a canary deployments via Flagger.

Deployment

Run with OpenID Connect Authentication.

  docker run -p 8080:4000 \
    -e PORT=4000 \
    -e SECRET_KEY_BASE=<32-64 characters long> \
    -e APP_URL=https://birdcage.local:8080 \
    docker.pkg.github.com/cognizant-softvision/birdcage/birdcage:latest

Run with OpenID Connect Authentication.

  docker run -p 8080:4000 \
    -e PORT=4000 \
    -e SECRET_KEY_BASE=<32-64 characters long> \
    -e APP_URL=https://birdcage.local:8080 \
    -e OIDC_ENABLED=true \
    -e OIDC_DISCOVERY_DOCUMENT_URI=https://auth.birdcage.local/auth/realms/test/.well-known/openid-configuration \
    -e OIDC_CLIENT_ID=birdcage \
    -e OIDC_CLIENT_SECRET=+o7y6mn2IMCvazRv2Xxv6erd1ImYL9hg \
    -e OIDC_CLIENT_ROLE=user \
    -e OIDC_REDIRECT_URI=https://birdcage.local:8080/session/callback \
    docker.pkg.github.com/cognizant-softvision/birdcage/birdcage:latest

Run with Slack bot enabled.

  docker run -p 8080:4000 \
    -e PORT=4000 \
    -e SECRET_KEY_BASE=<32-64 characters long> \
    -e APP_URL=https://birdcage.local:8080 \
    -e BOT_ENABLED=true \
    -e BOT_SLACK_TOKEN=<Slack Token> \
    -e BOT_NAME=birdcage \
    -e BOT_ALIAS=birdcage \
    docker.pkg.github.com/cognizant-softvision/birdcage/birdcage:latest

Configuring Flagger Webhooks

https://docs.flagger.app/usage/webhooks#manual-gating

webhooks:
  - name: 'Confirm Rollout'
    type: confirm-rollout
    url: https://birdcage.local:8080/api/confirm/rollout
  - name: 'Confirm Promotion'
    type: confirm-promotion
    url: https://birdcage.local:8080/api/confirm/promotion