migration/json-schema/migration-cutover-plan-schema.json at main · api-evangelist/migration · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/migration/refs/heads/main/json-schema/migration-cutover-plan-schema.json",
  "title": "CutoverPlan",
  "description": "A cutover plan describing the ordered steps, windows, and rollback procedures for transitioning from a source environment to a target environment during a migration.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the cutover plan.",
      "example": "cutover-erp-2026-06"
    },
    "migration_project_id": {
      "type": "string",
      "description": "Identifier of the migration project this cutover plan belongs to.",
      "example": "mig-2026-erp-aws"
    },
    "name": {
      "type": "string",
      "description": "Name of the cutover plan.",
      "example": "ERP Production Cutover - June 15"
    },
    "description": {
      "type": "string",
      "description": "Summary of the cutover plan.",
      "example": "Production cutover of ERP database and application tier from on-prem Oracle to AWS Aurora PostgreSQL."
    },
    "cutover_window": {
      "type": "object",
      "description": "Planned cutover window.",
      "properties": {
        "start": { "type": "string", "format": "date-time", "example": "2026-06-15T02:00:00Z" },
        "end": { "type": "string", "format": "date-time", "example": "2026-06-15T06:00:00Z" },
        "timezone": { "type": "string", "example": "UTC" }
      },
      "required": ["start", "end"]
    },
    "downtime_budget_minutes": {
      "type": "integer",
      "description": "Maximum acceptable downtime in minutes during the cutover.",
      "example": 120
    },
    "steps": {
      "type": "array",
      "description": "Ordered list of cutover steps.",
      "items": {
        "type": "object",
        "properties": {
          "order": { "type": "integer", "example": 1 },
          "name": { "type": "string", "example": "Freeze writes on source" },
          "owner": { "type": "string", "example": "dba-team" },
          "expected_duration_minutes": { "type": "integer", "example": 10 },
          "status": {
            "type": "string",
            "enum": ["pending", "in-progress", "completed", "failed", "skipped"],
            "example": "pending"
          }
        },
        "required": ["order", "name"]
      }
    },
    "validation_gates": {
      "type": "array",
      "description": "Required validation checks before the cutover is considered successful.",
      "items": { "type": "string" },
      "example": [
        "row-count-parity",
        "checksum-match",
        "smoke-tests-green",
        "business-sign-off"
      ]
    },
    "rollback_plan": {
      "type": "object",
      "description": "Procedure to roll back to the source if validation fails.",
      "properties": {
        "trigger": { "type": "string", "example": "Smoke tests fail or data parity below 99.99%" },
        "max_time_minutes": { "type": "integer", "example": 30 },
        "steps": {
          "type": "array",
          "items": { "type": "string" },
          "example": [
            "Re-enable writes on source",
            "Redirect application traffic to source",
            "Pause replication"
          ]
        }
      }
    },
    "status": {
      "type": "string",
      "description": "Current status of the cutover plan.",
      "enum": ["draft", "scheduled", "in-progress", "completed", "rolled-back", "cancelled"],
      "example": "scheduled"
    },
    "approvers": {
      "type": "array",
      "description": "Stakeholders who must approve the cutover.",
      "items": { "type": "string" },
      "example": ["cto", "head-of-platform", "head-of-data"]
    }
  },
  "required": ["id", "migration_project_id", "name", "cutover_window", "steps", "status"]
}