Skip to content

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

Merged
cameri merged 5 commits into
mainfrom
feat/deploy-runbook
Oct 10, 2026
Merged

cameri merged 5 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: e781c91

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: 5/5

[Low impact] The PR appears safe to merge, with a non-blocking gap in the HAProxy refresh instructions.

Findings

  1. P2 Proxy settings stay old ▶

Summary

Adds a manual deploy runbook and a single-relay update script.

  • Single-relay updates now run migrations and wait for readiness.
  • Operators can follow one runbook to update or roll back relay hosts.

Diagram

%%{init: {'theme': 'neutral'}}%%
flowchart TD
  A[Load new image] --> B{Stack}
  B -->|Single relay| C[Run migrations]
  C --> D[Recreate relay]
  D --> E[Check readiness]
  B -->|HAProxy| F[Run migrations]
  F --> G[Replace backends one at a time]
  G --> E
Loading

Reviews (3) · Last reviewed commit: "Merge branch 'main' into feat/deploy-run..." · Reviewed by Greptile

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.
Comment thread docs/DEPLOY-RUNBOOK.md Outdated
Comment thread docs/DEPLOY-RUNBOOK.md
Comment thread deploy/recreate-relay.sh Outdated
Comment thread docs/DEPLOY-RUNBOOK.md
Comment on lines +77 to +79
cp "$REPO/deploy/docker-compose.haproxy.yml" "$REPO/deploy/rolling-relay-recreate.sh" /opt/nostream/
cp -r "$REPO/deploy/haproxy" /opt/nostream/
chmod +x /opt/nostream/rolling-relay-recreate.sh

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Proxy settings stay old

The refresh commands copy the new haproxy.cfg, but nothing reloads or recreates haproxy. The later commands replace only the relay backends. If a release changes proxy settings, operators following this runbook keep serving traffic with the old settings.

Add a config check and an explicit reload or recreate step, noting any downtime.

@cameri
cameri merged commit 8a5600b into main Oct 10, 2026
13 checks passed
@cameri
cameri deleted the feat/deploy-runbook branch October 10, 2026 13:55
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.

2 participants