Skip to content

docs(deploy): add sandbox deploy runbook and recreate-relay script - #768

Open
Ferryx349 wants to merge 3 commits into
mainfrom
feat/deploy-runbook
Open

Ferryx349 wants to merge 3 commits into
mainfrom
feat/deploy-runbook

Conversation

@Ferryx349

Copy link
Copy Markdown
Collaborator

Description

Document the manual post-pull migrate and recreate flow, rollback steps, and /readyz verification. Closes the gap where the webhook pull stack loads images but does not restart the relay.

Related Issue

closes:- #767

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Non-functional change (docs, style, minor refactor)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my code changes.
  • I added a changeset, or this is docs-only and I added an empty changeset.
  • All new and existing tests passed.

@changeset-bot

changeset-bot Bot commented Sep 10, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 622e2ba

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
nostream Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@Ferryx349
Ferryx349 force-pushed the feat/deploy-runbook branch from da7ac54 to df40b32 Compare October 4, 2026 05:02
Document post-image update steps for single-relay and HAProxy stacks;
link deploy README to the runbook without duplicating health/HAProxy setup.
@Ferryx349
Ferryx349 force-pushed the feat/deploy-runbook branch from df40b32 to 4baf9b9 Compare October 4, 2026 05:10
@greptile-apps

greptile-apps Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

RetriggerConfidence Score: 3/5

[Low risk] Adds deployment documentation and a helper script.

The PR is not ready to merge until the rollback procedure can reliably restore the previous image without rerunning migrations.

Findings

  1. P1 Rollback records the new image ▶
  2. P1 Rollback reruns migrations ▶
  3. P2 Migration status is not explicit ▶
  4. P2 Host lacks the script ▶
Summary

The PR adds a manual deployment runbook and a single-relay script to migrate, recreate, and check readiness after image delivery.

  • The rollback instructions need correction: image capture can select the new image, and the single-relay rollback reruns migrations.
  • The migration gate and host-side script instructions should be made explicit.
Diagram
%%{init: {'theme': 'neutral'}}%%
flowchart LR
  A[New image delivered] --> B[Run migrations]
  B -->|success| C[Recreate relay]
  C --> D[Check /readyz]
  D -->|failure| E[Restore previous image]
  E --> F[Recreate without migrations]
Loading

Reviews (1) · Last reviewed commit: "docs(deploy): add deploy runbook and sin..."

Comment thread docs/DEPLOY-RUNBOOK.md Outdated
Comment thread docs/DEPLOY-RUNBOOK.md Outdated
Comment thread deploy/recreate-relay.sh Outdated
Comment thread docs/DEPLOY-RUNBOOK.md Outdated
Capture the running relay image before deploy, document script install path,
use compose exit-code-from for migrate, and add SKIP_MIGRATE for rollback.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant