Initial skeleton: services/README.md
This commit is contained in:
@@ -0,0 +1,36 @@
|
|||||||
|
# Services — Configuration & Runbook Index
|
||||||
|
|
||||||
|
This directory documents all services operated by the Daystrom Institute. Each subdirectory contains deployment configuration notes, dependency maps, and links to operational runbooks.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Service Catalog
|
||||||
|
|
||||||
|
| Service Name | Stack | Host(s) | Runbook | Status |
|
||||||
|
|--------------|-------|---------|---------|--------|
|
||||||
|
| `<!-- service -->` | `<!-- stack -->` | `<!-- host -->` | [Runbook](<!-- link -->) | `<!-- status -->` |
|
||||||
|
|
||||||
|
> **Note:** Replace placeholder rows with actual service entries.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Directory Layout (per service)
|
||||||
|
|
||||||
|
```
|
||||||
|
services/<service-name>/
|
||||||
|
├── README.md ← Overview, ports, dependencies
|
||||||
|
├── config/ ← Non-secret configuration files or excerpts
|
||||||
|
└── runbook.md ← Operational procedures (link or inline)
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Standards
|
||||||
|
|
||||||
|
- Document all exposed ports and upstream dependencies.
|
||||||
|
- Reference the canonical runbook from `runbooks/` rather than duplicating procedures.
|
||||||
|
- Mark services under active change with `⚠ IN FLUX` in the Status column.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*Directory last reviewed: <!-- date -->*
|
||||||
Reference in New Issue
Block a user