Deployment Upgrade Runbook

Production-style upgrade checklist and rollback plan

Page scope (operations runbook niche): This page is for operator workflows (preflight, rollout, smoke tests, rollback). For config migration details use Upgrading / Migrating. For release history use Releases.

Pre-upgrade gate

  1. Create a backup: openclaw backup create.
  2. Capture current version and health: openclaw --version, openclaw doctor.
  3. Verify maintenance window and owner comms (channel impact, rollback owner).
  4. Confirm host resources (disk, memory, network) and dependency versions.

Upgrade execution

Execution sequence
openclaw update
openclaw doctor --fix
openclaw gateway restart
openclaw doctor

If migration-related warnings appear, continue with Upgrading / Migrating and provider-specific guides.

Post-upgrade smoke tests

  • Gateway health: service starts cleanly, no auth/pairing regressions.
  • Tool path: run one safe tool call and verify expected response.
  • Channel path: send one test message and confirm delivery + reply.
  • Provider path: test at least one model/provider call relevant to your production flow.

Rollback plan

  1. Stop active automation if behavior is unstable.
  2. Restore known-good backup/config.
  3. Restart gateway and re-run smoke tests.
  4. Document incident scope and root cause before retrying upgrade.