dohertj2/ScadaBridge
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: add deployments/ catalog with per-deployment markdown

Browse Source 
One file per local Docker cluster (docker-cluster, docker-cluster-env2)
keyed by Transport.SourceEnvironment. README indexes the set.
This commit is contained in:
Joseph Doherty
2026-05-28 09:27:43 -04:00
parent d8eda2f508
commit 6d87ee3c3b
3 changed files with 262 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
deployments/README.md
+15
View File
@@ -0,0 +1,15 @@
# Deployments
Catalog of ScadaLink deployments. Each entry below has a corresponding markdown file with topology, ports, infrastructure dependencies, and operational commands. The deployment **ID** matches the `Transport.SourceEnvironment` value stamped into exported bundle manifests (Component #24), so an audit trail of "where did this bundle come from" maps 1:1 to a file in this folder.
| Deployment ID | Type | Topology | Doc |
|---------------|------|----------|-----|
| `docker-cluster` | Local Docker (primary) | 2 central + 3 sites × 2 nodes (8 nodes) | [docker-cluster.md](docker-cluster.md) |
| `docker-cluster-env2` | Local Docker (secondary) | 2 central + 1 site × 2 nodes (4 nodes) | [docker-cluster-env2.md](docker-cluster-env2.md) |
## Conventions
- One markdown file per deployment, named for the deployment ID.
- Add a new file **and** a row above when introducing a new environment.
- Keep the deployment ID, container-name prefix, host-port range, and database names consistent across the doc, `appsettings.*.json`, and any `Transport.SourceEnvironment` value.
- When a deployment is decommissioned, move its row to a `## Decommissioned` section rather than deleting the file — the ID may still appear in historic Transport bundle manifests.