40 lines
1.5 KiB
Markdown
40 lines
1.5 KiB
Markdown
|
---
|
||
|
|
name: deployment-basics
|
||
|
|
description: Deployment documentation, environment setup, runbook, and rollback basics.
|
||
|
|
tags: ['operations', 'deployment']
|
||
|
|
---
|
||
|
|
|
||
|
|
# Deployment Basics
|
||
|
|
|
||
|
|
## Purpose
|
||
|
|
Standardize deployment operations: environment documentation, runbook creation, rollback procedures.
|
||
|
|
|
||
|
|
## When to Use
|
||
|
|
- Before any production deployment
|
||
|
|
- When setting up a new environment
|
||
|
|
- After a release for handoff
|
||
|
|
- When rollback is needed
|
||
|
|
|
||
|
|
## Procedure: Environment Setup
|
||
|
|
1. Document required variable names from safe sources only (`.env.example`, docs, schemas, compose placeholders, Coolify redacted status). Do not read live `.env`, runtime env dumps, credential stores, shell history, or logs to discover secret values.
|
||
|
|
2. Document required system dependencies
|
||
|
|
3. Document required network access (ports, domains)
|
||
|
|
4. Create env.example file with placeholders
|
||
|
|
|
||
|
|
## Procedure: Runbook
|
||
|
|
1. Pre-deploy: verify env, run tests, backup current state
|
||
|
|
2. Deploy: step-by-step commands with expected output
|
||
|
|
3. Post-deploy: health check, optional public reachability test, bounded error-log review
|
||
|
|
4. Rollback: revert steps, restore backup, verify
|
||
|
|
|
||
|
|
## Procedure: Rollback
|
||
|
|
1. Identify the last known good state
|
||
|
|
2. Revert code (git checkout <tag>)
|
||
|
|
3. Restore database (if schema changed)
|
||
|
|
4. Verify health and public reachability tests; skip authenticated tests unless user-provided test account exists for this task
|
||
|
|
5. Document rollback reason in worklog
|
||
|
|
|
||
|
|
## See Also
|
||
|
|
- Tool: `deployment_runner` (if available in plugin)
|
||
|
|
- Help: `operations/runtime.md`
|