Upgrade guide
Plan, validate, and roll back Velocity upgrades without guesswork.
Last updated October 8, 2025View on GitHub
Stay current without drama
Velocity ships regular minor releases and occasional breaking changes. Follow this checklist to keep clusters fresh while protecting availability.
Pre-flight
Task | Owner | Time |
---|---|---|
Review release notes for schema or API changes | Tech lead | 30 min |
Stage environment mirrors production topology | Platform team | 1 hr |
Freeze conflicting change windows | Change manager | 10 min |
Sync these with your maintenance calendar so the upgrade never surprises on-call engineers.
Core flow
- Fetch artefacts from the release page (checksums, signatures). Verify before distributing.
- Run automation: unit tests, integration suites, and smoke tests for the edge runtime.
- Deploy to staging using the same pipeline you’ll use for production.
- Observe for at least one business cycle—watch handshake latency, downgrade percentage, and ticket rotation health.
- Promote to production via canary, blue/green, or rolling upgrade depending on footprint.
Validate success
velocity --version
matches across all nodes.velocity-cli admin diagnostics --summary
shows the expected schema version and ticket cadence.- Config reload logs are clean—no deprecations or parse warnings.
- Dashboards show handshake success ≥ baseline and downgrades within thresholds.
- Synthetic probes (or Chaos tests) return within the agreed latency budget.
Rollback ready
- Quiesce traffic with
velocity-cli admin quiesce
. - Redeploy the previous artefact or container image.
- Restore the prior config bundle if schemas moved.
- Resume traffic, monitor for 15 minutes, and file an incident ticket capturing root cause.
Keep a rollback runbook next to the upgrade plan so the team practises both paths.
Stay ahead of changes
- Subscribe to release emails or RSS.
- Watch issues tagged
upgrade
,breaking-change
, anddeprecation
. - Fold lessons into your automation—if a manual step keeps failing, script it and link the script from this guide.