A sample payments API service used as the running example in the Kargo book.
This service is intentionally simple: it stores payments in memory and exposes a REST API. The focus is on demonstrating Kargo's continuous promotion workflows, not on building a production payment system.
| Method | Path | Description |
|---|---|---|
GET |
/healthz |
Liveness probe |
GET |
/readyz |
Readiness probe |
GET |
/version |
Build version and commit SHA |
GET |
/api/v1/payments |
List all payments |
POST |
/api/v1/payments |
Create a payment |
GET |
/api/v1/payments/{id} |
Get a payment by ID |
# Run locally
make run
# Run tests
make test
# Build Docker image
make docker-build VERSION=1.0.0| Variable | Default | Description |
|---|---|---|
PORT |
8080 |
HTTP listen port |
Published to ghcr.io/kargobook/payments-api on every push to main and on semver tags.
docker run -p 8080:8080 ghcr.io/kargobook/payments-api:latest- kargobook/auth-service — Companion auth service (used in multi-service chapters)
- kargobook/demo-gitops — GitOps repo with Kustomize overlays, Argo CD Applications, and Kargo resources
This example is referenced throughout the book, including:
- Chapter 4 — Introducing Kargo (Warehouse and Stage concepts)
- Chapter 6 — Your First Promotion
- Chapter 7 — Warehouses and Artifact Lineage
- Chapter 8 — Stage Graph Modeling
- Chapter 9 — Automatic and Manual Promotion
- Chapter 11 — Multi-Service Promotion (with auth-service)
- Chapter 12 — Multi-Team and Platform Patterns
- Chapter 14 — Enterprise Governance and RBAC
- Chapter 15 — Enterprise Integrations
MIT