Files
sencho/docs/features/atomic-deployments.mdx
T
Anso f516275834 refactor(licensing): replace Pro branding with Community/Skipper/Admiral tiers (#375)
Eliminate all references to "Pro" across backend, frontend, and docs.
Internal tier value renamed from 'pro' to 'paid'; user-facing text now
uses the thematic tier names (Community, Skipper, Admiral).

- Rename LicenseTier 'pro' to 'paid' in backend and frontend types
- Rename requirePro guard to requirePaid, error code PRO_REQUIRED to PAID_REQUIRED
- Rename ProGate.tsx to PaidGate.tsx with updated copy
- Fix: trial users can now see upgrade/purchase cards in Settings
- Update all docs and openapi.yaml to use correct tier names
2026-04-05 05:59:36 -04:00

40 lines
2.1 KiB
Plaintext

---
title: Atomic Deployments
description: Zero-downtime deployments with automatic rollback for Skipper and Admiral users.
---
<Note>
Atomic Deployments require a **Sencho Skipper** or **Admiral** license. Community Edition uses standard deployments without backup or rollback.
</Note>
Sencho wraps every deployment in a safety net on Skipper and Admiral tiers. Before applying changes, it backs up your current configuration. If the deployment fails, it automatically rolls back to the previous working state.
## How it works
1. **Backup** - Before a deploy or update, Sencho copies your `compose.yaml` and `.env` files to a backup directory inside the stack folder
2. **Deploy** - Sencho runs the requested compose operation (up, pull + recreate, etc.)
3. **Health probe** - After deployment, Sencho waits briefly, then checks whether any containers exited with a non-zero exit code
4. **Auto-rollback** - If a crash is detected, Sencho restores the backed-up files and re-deploys automatically
This entire sequence happens transparently. You see a single deploy action; Sencho handles the safety logic behind the scenes.
## Which operations are protected
Atomic deployments apply to:
- **Deploy** from the stack editor (compose down + up)
- **Update** from the stack editor (pull latest images + recreate)
- **Webhook triggers** for deploy and pull actions
- **Scheduled tasks** that perform deploys or updates
- **App Store installs** when deploying a new stack
## Manual rollback
You can manually roll back to the previous deployment at any time by clicking the **Rollback** button in the stack editor's action bar. The button only appears when a backup exists from a prior deployment.
Hover over the Rollback button to see a tooltip with the timestamp of the last backup. Clicking it restores the backed-up `compose.yaml` and `.env` files, then re-deploys the stack with the restored configuration.
## Community Edition behavior
Community users continue to use the standard deploy flow: no backup is created and no rollback is available. Upgrading to Skipper or Admiral enables atomic deployments immediately with no configuration required.