Skip to content

Commit f9e3652

Browse files
feat(calm): rename observability to deployment-details in deployment decorator
Refs #1908
1 parent 6321098 commit f9e3652

File tree

7 files changed

+10
-10
lines changed

7 files changed

+10
-10
lines changed

calm/draft/2026-03/standards/deployment/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This directory contains standardized deployment decorator schemas for tracking d
44

55
## Overview
66

7-
Deployment decorators attach deployment tracking information to architecture elements without modifying the core architecture definition. They enable tracking of deployment status, timing, observability links, and platform-specific details across the architecture lifecycle.
7+
Deployment decorators attach deployment tracking information to architecture elements without modifying the core architecture definition. They enable tracking of deployment status, timing, deployment details links, and platform-specific details across the architecture lifecycle.
88

99
## Base Deployment Decorator
1010

@@ -14,7 +14,7 @@ The base deployment decorator standard (`deployment.decorator.standard.json`) de
1414
- **status**: Current deployment status (pending, in-progress, completed, failed, rolled-back) (required)
1515
- **target-type**: Type of resources this decorator targets - must be ["architecture"] (required)
1616
- **end-time**: ISO 8601 timestamp of when the deployment completed or failed
17-
- **observability**: URI linking to logs, metrics, or observability dashboards
17+
- **deployment-details**: URI linking to logs, metrics, or observability dashboards
1818
- **notes**: Free-form notes or comments about the deployment
1919

2020
## Platform-Specific Extensions
@@ -42,7 +42,7 @@ Platform-specific deployment decorators extend the base deployment standard and
4242
"start-time": "2026-02-23T10:00:00Z",
4343
"end-time": "2026-02-23T10:05:00Z",
4444
"status": "completed",
45-
"observability": "https://grafana.example.com/d/api-service",
45+
"deployment-details": "https://grafana.example.com/d/api-service",
4646
"notes": "Successful deployment with zero downtime"
4747
}
4848
}
@@ -62,7 +62,7 @@ Platform-specific deployment decorators extend the base deployment standard and
6262
"start-time": "2026-02-23T10:00:00Z",
6363
"end-time": "2026-02-23T10:08:00Z",
6464
"status": "completed",
65-
"observability": "https://grafana.example.com/d/k8s-prod",
65+
"deployment-details": "https://grafana.example.com/d/k8s-prod",
6666
"notes": "Rolling update with new features",
6767
"kubernetes": {
6868
"helm-chart-version": "1.2.3",

calm/draft/2026-03/standards/deployment/deployment.decorator.standard.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
],
4949
"description": "Current status of the deployment"
5050
},
51-
"observability": {
51+
"deployment-details": {
5252
"type": "string",
5353
"format": "uri",
5454
"description": "URI linking to deployment logs, metrics, dashboards, or observability platform"

calm/draft/2026-03/standards/deployment/examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ See: `kubernetes-deployment.decorator.json`
8686
1. **Unique IDs**: Use descriptive unique-id values that include the service name and deployment identifier
8787
2. **Target Type**: Always include `"target-type": ["architecture"]` as deployment decorators only target architecture files
8888
3. **Timestamps**: Always use ISO 8601 format with timezone (preferably UTC)
89-
4. **Observability Links**: Link to deployment-specific dashboards or filtered log views
89+
4. **Deployment Details Links**: Link to deployment-specific dashboards or filtered log views
9090
5. **Notes**: Include context about what changed, why, and any issues encountered
9191

9292
## Validation

calm/draft/2026-03/standards/deployment/examples/failed-deployment.decorator.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"start-time": "2026-02-23T08:15:00Z",
1616
"end-time": "2026-02-23T08:23:45Z",
1717
"status": "failed",
18-
"observability": "https://grafana.example.com/d/payment-processor-prod",
18+
"deployment-details": "https://grafana.example.com/d/payment-processor-prod",
1919
"notes": "Deployment failed due to database migration timeout. Rolling back to 2.9.1."
2020
}
2121
}

calm/draft/2026-03/standards/deployment/examples/kubernetes-deployment.decorator.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"start-time": "2026-02-23T14:30:00Z",
1717
"end-time": "2026-02-23T14:42:15Z",
1818
"status": "completed",
19-
"observability": "https://grafana.example.com/d/platform-services",
19+
"deployment-details": "https://grafana.example.com/d/platform-services",
2020
"notes": "Rolling update with new authentication features",
2121
"kubernetes": {
2222
"helm-chart-version": "2.1.0",

calm/draft/2026-03/standards/deployment/examples/multi-target-deployment.decorator.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"data": {
1818
"start-time": "2026-02-23T12:00:00Z",
1919
"status": "in-progress",
20-
"observability": "https://datadog.example.com/dashboard/release-2024-02-23",
20+
"deployment-details": "https://datadog.example.com/dashboard/release-2024-02-23",
2121
"notes": "Coordinated release across frontend and backend services for new feature rollout",
2222
"kubernetes": {
2323
"helm-chart-version": "3.0.0",

calm/draft/2026-03/standards/deployment/examples/simple-deployment.decorator.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"start-time": "2026-02-23T10:00:00Z",
1616
"end-time": "2026-02-23T10:05:30Z",
1717
"status": "completed",
18-
"observability": "https://grafana.example.com/d/web-service-prod",
18+
"deployment-details": "https://grafana.example.com/d/web-service-prod",
1919
"notes": "Initial production deployment with baseline configuration"
2020
}
2121
}

0 commit comments

Comments
 (0)