ai-flow-dev 2.7.0 → 2.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (171) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +573 -570
  3. package/package.json +74 -74
  4. package/prompts/backend/flow-build-phase-0.md +535 -535
  5. package/prompts/backend/flow-build-phase-1.md +626 -626
  6. package/prompts/backend/flow-build-phase-10.md +340 -340
  7. package/prompts/backend/flow-build-phase-2.md +573 -573
  8. package/prompts/backend/flow-build-phase-3.md +834 -834
  9. package/prompts/backend/flow-build-phase-4.md +554 -554
  10. package/prompts/backend/flow-build-phase-5.md +703 -703
  11. package/prompts/backend/flow-build-phase-6.md +524 -524
  12. package/prompts/backend/flow-build-phase-7.md +1001 -1001
  13. package/prompts/backend/flow-build-phase-8.md +1407 -1407
  14. package/prompts/backend/flow-build-phase-9.md +477 -477
  15. package/prompts/backend/flow-build.md +137 -137
  16. package/prompts/backend/flow-check-review.md +656 -20
  17. package/prompts/backend/flow-check-test.md +526 -14
  18. package/prompts/backend/flow-check.md +725 -67
  19. package/prompts/backend/flow-commit.md +88 -119
  20. package/prompts/backend/flow-docs-sync.md +354 -354
  21. package/prompts/backend/flow-finish.md +919 -0
  22. package/prompts/backend/flow-release.md +949 -0
  23. package/prompts/backend/flow-work-feature.md +61 -61
  24. package/prompts/backend/flow-work-fix.md +46 -46
  25. package/prompts/backend/flow-work-refactor.md +48 -48
  26. package/prompts/backend/flow-work-resume.md +34 -34
  27. package/prompts/backend/flow-work.md +1098 -1286
  28. package/prompts/desktop/flow-build-phase-0.md +359 -359
  29. package/prompts/desktop/flow-build-phase-1.md +295 -295
  30. package/prompts/desktop/flow-build-phase-10.md +357 -357
  31. package/prompts/desktop/flow-build-phase-2.md +282 -282
  32. package/prompts/desktop/flow-build-phase-3.md +291 -291
  33. package/prompts/desktop/flow-build-phase-4.md +308 -308
  34. package/prompts/desktop/flow-build-phase-5.md +269 -269
  35. package/prompts/desktop/flow-build-phase-6.md +350 -350
  36. package/prompts/desktop/flow-build-phase-7.md +297 -297
  37. package/prompts/desktop/flow-build-phase-8.md +541 -541
  38. package/prompts/desktop/flow-build-phase-9.md +439 -439
  39. package/prompts/desktop/flow-build.md +156 -156
  40. package/prompts/desktop/flow-check-review.md +656 -20
  41. package/prompts/desktop/flow-check-test.md +526 -14
  42. package/prompts/desktop/flow-check.md +725 -67
  43. package/prompts/desktop/flow-commit.md +88 -119
  44. package/prompts/desktop/flow-docs-sync.md +354 -354
  45. package/prompts/desktop/flow-finish.md +910 -0
  46. package/prompts/desktop/flow-release.md +662 -0
  47. package/prompts/desktop/flow-work-feature.md +61 -61
  48. package/prompts/desktop/flow-work-fix.md +46 -46
  49. package/prompts/desktop/flow-work-refactor.md +48 -48
  50. package/prompts/desktop/flow-work-resume.md +34 -34
  51. package/prompts/desktop/flow-work.md +1202 -1390
  52. package/prompts/frontend/flow-build-phase-0.md +425 -425
  53. package/prompts/frontend/flow-build-phase-1.md +626 -626
  54. package/prompts/frontend/flow-build-phase-10.md +33 -33
  55. package/prompts/frontend/flow-build-phase-2.md +573 -573
  56. package/prompts/frontend/flow-build-phase-3.md +782 -782
  57. package/prompts/frontend/flow-build-phase-4.md +554 -554
  58. package/prompts/frontend/flow-build-phase-5.md +703 -703
  59. package/prompts/frontend/flow-build-phase-6.md +524 -524
  60. package/prompts/frontend/flow-build-phase-7.md +1001 -1001
  61. package/prompts/frontend/flow-build-phase-8.md +872 -872
  62. package/prompts/frontend/flow-build-phase-9.md +94 -94
  63. package/prompts/frontend/flow-build.md +137 -137
  64. package/prompts/frontend/flow-check-review.md +656 -20
  65. package/prompts/frontend/flow-check-test.md +526 -14
  66. package/prompts/frontend/flow-check.md +725 -67
  67. package/prompts/frontend/flow-commit.md +88 -119
  68. package/prompts/frontend/flow-docs-sync.md +550 -550
  69. package/prompts/frontend/flow-finish.md +910 -0
  70. package/prompts/frontend/flow-release.md +519 -0
  71. package/prompts/frontend/flow-work-api.md +1540 -0
  72. package/prompts/frontend/flow-work-feature.md +61 -61
  73. package/prompts/frontend/flow-work-fix.md +38 -38
  74. package/prompts/frontend/flow-work-refactor.md +48 -48
  75. package/prompts/frontend/flow-work-resume.md +34 -34
  76. package/prompts/frontend/flow-work.md +1583 -1320
  77. package/prompts/mobile/flow-build-phase-0.md +425 -425
  78. package/prompts/mobile/flow-build-phase-1.md +626 -626
  79. package/prompts/mobile/flow-build-phase-10.md +32 -32
  80. package/prompts/mobile/flow-build-phase-2.md +573 -573
  81. package/prompts/mobile/flow-build-phase-3.md +782 -782
  82. package/prompts/mobile/flow-build-phase-4.md +554 -554
  83. package/prompts/mobile/flow-build-phase-5.md +703 -703
  84. package/prompts/mobile/flow-build-phase-6.md +524 -524
  85. package/prompts/mobile/flow-build-phase-7.md +1001 -1001
  86. package/prompts/mobile/flow-build-phase-8.md +888 -888
  87. package/prompts/mobile/flow-build-phase-9.md +90 -90
  88. package/prompts/mobile/flow-build.md +135 -135
  89. package/prompts/mobile/flow-check-review.md +656 -20
  90. package/prompts/mobile/flow-check-test.md +526 -14
  91. package/prompts/mobile/flow-check.md +725 -67
  92. package/prompts/mobile/flow-commit.md +88 -119
  93. package/prompts/mobile/flow-docs-sync.md +620 -620
  94. package/prompts/mobile/flow-finish.md +910 -0
  95. package/prompts/mobile/flow-release.md +751 -0
  96. package/prompts/mobile/flow-work-api.md +1493 -0
  97. package/prompts/mobile/flow-work-feature.md +61 -61
  98. package/prompts/mobile/flow-work-fix.md +46 -46
  99. package/prompts/mobile/flow-work-refactor.md +48 -48
  100. package/prompts/mobile/flow-work-resume.md +34 -34
  101. package/prompts/mobile/flow-work.md +1593 -1329
  102. package/prompts/shared/mermaid-guidelines.md +102 -102
  103. package/prompts/shared/scope-levels.md +114 -114
  104. package/prompts/shared/smart-skip-preflight.md +214 -214
  105. package/prompts/shared/story-points.md +55 -55
  106. package/prompts/shared/task-format.md +74 -74
  107. package/prompts/shared/task-summary-template.md +277 -277
  108. package/templates/AGENT.template.md +443 -443
  109. package/templates/backend/.clauderules.template +112 -112
  110. package/templates/backend/.cursorrules.template +102 -102
  111. package/templates/backend/README.template.md +2 -2
  112. package/templates/backend/ai-instructions.template.md +2 -2
  113. package/templates/backend/copilot-instructions.template.md +2 -2
  114. package/templates/backend/docs/api.template.md +320 -320
  115. package/templates/backend/docs/business-flows.template.md +97 -97
  116. package/templates/backend/docs/code-standards.template.md +2 -2
  117. package/templates/backend/docs/contributing.template.md +3 -3
  118. package/templates/backend/docs/data-model.template.md +520 -520
  119. package/templates/backend/docs/testing.template.md +2 -2
  120. package/templates/backend/project-brief.template.md +2 -2
  121. package/templates/backend/specs/configuration.template.md +2 -2
  122. package/templates/backend/specs/security.template.md +2 -2
  123. package/templates/desktop/.clauderules.template +112 -112
  124. package/templates/desktop/.cursorrules.template +102 -102
  125. package/templates/desktop/README.template.md +170 -170
  126. package/templates/desktop/ai-instructions.template.md +366 -366
  127. package/templates/desktop/copilot-instructions.template.md +140 -140
  128. package/templates/desktop/docs/docs/api.template.md +320 -320
  129. package/templates/desktop/docs/docs/architecture.template.md +724 -724
  130. package/templates/desktop/docs/docs/business-flows.template.md +102 -102
  131. package/templates/desktop/docs/docs/code-standards.template.md +792 -792
  132. package/templates/desktop/docs/docs/contributing.template.md +149 -149
  133. package/templates/desktop/docs/docs/data-model.template.md +520 -520
  134. package/templates/desktop/docs/docs/operations.template.md +720 -720
  135. package/templates/desktop/docs/docs/testing.template.md +722 -722
  136. package/templates/desktop/project-brief.template.md +150 -150
  137. package/templates/desktop/specs/specs/configuration.template.md +121 -121
  138. package/templates/desktop/specs/specs/security.template.md +392 -392
  139. package/templates/frontend/README.template.md +2 -2
  140. package/templates/frontend/ai-instructions.template.md +2 -2
  141. package/templates/frontend/docs/api-integration.template.md +362 -362
  142. package/templates/frontend/docs/components.template.md +2 -2
  143. package/templates/frontend/docs/error-handling.template.md +360 -360
  144. package/templates/frontend/docs/operations.template.md +107 -107
  145. package/templates/frontend/docs/performance.template.md +124 -124
  146. package/templates/frontend/docs/pwa.template.md +119 -119
  147. package/templates/frontend/docs/state-management.template.md +2 -2
  148. package/templates/frontend/docs/styling.template.md +2 -2
  149. package/templates/frontend/docs/testing.template.md +2 -2
  150. package/templates/frontend/project-brief.template.md +2 -2
  151. package/templates/frontend/specs/accessibility.template.md +95 -95
  152. package/templates/frontend/specs/configuration.template.md +2 -2
  153. package/templates/frontend/specs/security.template.md +175 -175
  154. package/templates/fullstack/README.template.md +252 -252
  155. package/templates/fullstack/ai-instructions.template.md +444 -444
  156. package/templates/fullstack/project-brief.template.md +157 -157
  157. package/templates/fullstack/specs/configuration.template.md +340 -340
  158. package/templates/mobile/README.template.md +167 -167
  159. package/templates/mobile/ai-instructions.template.md +196 -196
  160. package/templates/mobile/docs/app-store.template.md +135 -135
  161. package/templates/mobile/docs/architecture.template.md +63 -63
  162. package/templates/mobile/docs/native-features.template.md +94 -94
  163. package/templates/mobile/docs/navigation.template.md +59 -59
  164. package/templates/mobile/docs/offline-strategy.template.md +65 -65
  165. package/templates/mobile/docs/permissions.template.md +56 -56
  166. package/templates/mobile/docs/state-management.template.md +85 -85
  167. package/templates/mobile/docs/testing.template.md +109 -109
  168. package/templates/mobile/project-brief.template.md +69 -69
  169. package/templates/mobile/specs/build-configuration.template.md +91 -91
  170. package/templates/mobile/specs/deployment.template.md +92 -92
  171. package/templates/work.template.md +47 -47
@@ -1,720 +1,720 @@
1
- # Operations Guide
2
-
3
- > Deployment, monitoring, and operational procedures for {{PROJECT_NAME}}
4
-
5
- ---
6
-
7
- ## 🚀 Deployment
8
-
9
- ### Platform
10
-
11
- **Environment:** {{DEPLOYMENT_PLATFORM}}
12
-
13
- **Regions:** {{DEPLOYMENT_REGIONS}}
14
-
15
- **Container:** {{#IF_DOCKER}}Yes - Docker{{ELSE}}No{{/IF_DOCKER}}
16
-
17
- ### Deployment Strategy
18
-
19
- **Strategy:** {{DEPLOYMENT_STRATEGY}}
20
-
21
- {{#IF BLUE_GREEN}}
22
- **Blue-Green Deployment:**
23
-
24
- - Active environment: {{ACTIVE_ENVIRONMENT}}
25
- - Standby environment: {{STANDBY_ENVIRONMENT}}
26
- - Switch mechanism: {{SWITCH_MECHANISM}}
27
- - Rollback time: < {{ROLLBACK_TIME}} seconds
28
- {{/IF}}
29
-
30
- {{#IF CANARY}}
31
- **Canary Deployment:**
32
-
33
- - Initial canary percentage: {{CANARY_INITIAL_PERCENTAGE}}%
34
- - Rollout increments: {{CANARY_INCREMENTS}}
35
- - Success criteria: {{CANARY_SUCCESS_CRITERIA}}
36
- - Automatic rollback: {{CANARY_AUTO_ROLLBACK}}
37
- {{/IF}}
38
-
39
- {{#IF ROLLING}}
40
- **Rolling Deployment:**
41
-
42
- - Max unavailable: {{ROLLING_MAX_UNAVAILABLE}}
43
- - Max surge: {{ROLLING_MAX_SURGE}}
44
- - Health check: {{ROLLING_HEALTH_CHECK}}
45
- {{/IF}}
46
-
47
- ### Rollback Plan
48
-
49
- **Trigger:** {{ROLLBACK_TRIGGER}}
50
-
51
- **Process:**
52
- {{#EACH ROLLBACK_STEP}}
53
- {{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
54
- {{/EACH}}
55
-
56
- ## **Rollback Time:** < {{ROLLBACK_TARGET_TIME}} minutes
57
-
58
- ## 🌍 Environments
59
-
60
- {{#EACH ENVIRONMENT}}
61
-
62
- ### {{ENV_NAME}}
63
-
64
- **Purpose:** {{ENV_PURPOSE}}
65
-
66
- **URL:** {{ENV_URL}}
67
-
68
- **Database:** {{ENV_DATABASE}}
69
-
70
- **Auto-deploy:** {{ENV_AUTO_DEPLOY}}
71
-
72
- **Configuration:**
73
-
74
- ```bash
75
- {{ENV_CONFIG}}
76
- ```
77
-
78
- ## {{/EACH}}
79
-
80
- ## 📦 Build & Deploy
81
-
82
- ### Build Process
83
-
84
- ```bash
85
- {{BUILD_COMMAND}}
86
- ```
87
-
88
- **Build Output:** `{{BUILD_OUTPUT_DIR}}`
89
-
90
- ### Deployment Steps
91
-
92
- {{#EACH DEPLOYMENT_STEP}}
93
- {{STEP_NUMBER}}. **{{STEP_TITLE}}**
94
-
95
- ```bash
96
- {{STEP_COMMAND}}
97
- ```
98
-
99
- {{STEP_DESCRIPTION}}
100
-
101
- {{/EACH}}
102
-
103
- {{#IF_DOCKER}}
104
-
105
- ### Docker
106
-
107
- **Dockerfile:** `{{DOCKERFILE_PATH}}`
108
-
109
- ```dockerfile
110
- {{DOCKERFILE_EXAMPLE}}
111
- ```
112
-
113
- **Build Image:**
114
-
115
- ```bash
116
- {{DOCKER_BUILD_COMMAND}}
117
- ```
118
-
119
- **Run Container:**
120
-
121
- ```bash
122
- {{DOCKER_RUN_COMMAND}}
123
- ```
124
-
125
- **Docker Compose:**
126
-
127
- ```yaml
128
- { { DOCKER_COMPOSE_EXAMPLE } }
129
- ```
130
-
131
- ## {{/IF_DOCKER}}
132
-
133
- ## 🔄 CI/CD Pipeline
134
-
135
- **Platform:** {{CICD_PLATFORM}}
136
-
137
- **Configuration:** `{{CICD_CONFIG_FILE}}`
138
-
139
- ### Pipeline Stages
140
-
141
- {{#EACH PIPELINE_STAGE}}
142
- {{STAGE_NUMBER}}. **{{STAGE_NAME}}**
143
-
144
- - {{STAGE_DESCRIPTION}}
145
- - Duration: ~{{STAGE_DURATION}}
146
- - Fails if: {{STAGE_FAILURE_CONDITION}}
147
-
148
- {{/EACH}}
149
-
150
- ### Pipeline Configuration
151
-
152
- ```yaml
153
- { { CICD_CONFIG_EXAMPLE } }
154
- ```
155
-
156
- ---
157
-
158
- ## 📊 Monitoring
159
-
160
- ### APM (Application Performance Monitoring)
161
-
162
- **Tool:** {{APM_TOOL}}
163
-
164
- **Metrics Tracked:**
165
- {{#EACH METRIC}}
166
-
167
- - **{{METRIC_NAME}}**: {{METRIC_DESCRIPTION}} (threshold: {{METRIC_THRESHOLD}})
168
- {{/EACH}}
169
-
170
- **Dashboard:** {{APM_DASHBOARD_URL}}
171
-
172
- ### Logging
173
-
174
- **Tool:** {{LOGGING_TOOL}}
175
-
176
- **Log Format:** {{LOG_FORMAT}}
177
-
178
- **Log Levels:**
179
- {{#EACH LOG_LEVEL}}
180
-
181
- - **{{LEVEL_NAME}}**: {{LEVEL_USAGE}}
182
- {{/EACH}}
183
-
184
- **Example Log Entry:**
185
-
186
- ```json
187
- {{LOG_ENTRY_EXAMPLE}}
188
- ```
189
-
190
- **Viewing Logs:**
191
-
192
- ```bash
193
- {{VIEW_LOGS_COMMAND}}
194
- ```
195
-
196
- ### Metrics
197
-
198
- {{#EACH TRACKED_METRIC}}
199
-
200
- #### {{METRIC_NAME}}
201
-
202
- **Description:** {{METRIC_DESCRIPTION}}
203
-
204
- **Threshold:** {{METRIC_THRESHOLD}}
205
-
206
- **Alert:** {{METRIC_ALERT_CONDITION}}
207
-
208
- ## {{/EACH}}
209
-
210
- ## 🚨 Alerting
211
-
212
- ### Alert Channels
213
-
214
- {{#EACH ALERT_CHANNEL}}
215
-
216
- - **{{CHANNEL_NAME}}**: {{CHANNEL_PURPOSE}}
217
- {{/EACH}}
218
-
219
- ### Alert Rules
220
-
221
- {{#EACH ALERT_RULE}}
222
-
223
- #### {{ALERT_NAME}}
224
-
225
- **Condition:** {{ALERT_CONDITION}}
226
-
227
- **Severity:** {{ALERT_SEVERITY}}
228
-
229
- **Notify:** {{ALERT_RECIPIENTS}}
230
-
231
- **Action:** {{ALERT_ACTION}}
232
-
233
- ## {{/EACH}}
234
-
235
- ## 🔧 Configuration
236
-
237
- ### Environment Variables
238
-
239
- **Required:**
240
- {{#EACH REQUIRED_ENV_VAR}}
241
-
242
- - `{{VAR_NAME}}` - {{VAR_DESCRIPTION}}
243
- {{/EACH}}
244
-
245
- **Optional:**
246
- {{#EACH OPTIONAL_ENV_VAR}}
247
-
248
- - `{{VAR_NAME}}` - {{VAR_DESCRIPTION}} (default: {{VAR_DEFAULT}})
249
- {{/EACH}}
250
-
251
- **Per Environment:**
252
-
253
- ```bash
254
- # Development
255
- {{DEV_ENV_VARS}}
256
-
257
- # Staging
258
- {{STAGING_ENV_VARS}}
259
-
260
- # Production
261
- {{PROD_ENV_VARS}}
262
- ```
263
-
264
- ---
265
-
266
- ## 💾 Database Operations
267
-
268
- ### Migrations
269
-
270
- ```bash
271
- # Run migrations
272
- {{MIGRATION_RUN_COMMAND}}
273
-
274
- # Rollback
275
- {{MIGRATION_ROLLBACK_COMMAND}}
276
-
277
- # Status
278
- {{MIGRATION_STATUS_COMMAND}}
279
- ```
280
-
281
- ### Database Migrations in Production
282
-
283
- **Strategy:** {{PRODUCTION_MIGRATION_STRATEGY}}
284
-
285
- {{#IF ZERO_DOWNTIME_MIGRATIONS}}
286
- **Zero-Downtime Migrations:** Enabled
287
-
288
- **Approach:**
289
- {{#EACH ZERO_DOWNTIME_STEP}}
290
- {{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
291
- {{/EACH}}
292
-
293
- **Rollback Plan:**
294
- {{#EACH ROLLBACK_STEP}}
295
- {{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
296
- {{/EACH}}
297
- {{ELSE}}
298
- **Zero-Downtime Migrations:** Not implemented (requires maintenance window)
299
- {{/IF}}
300
-
301
- **Migration Windows:**
302
-
303
- - Preferred time: {{MIGRATION_WINDOW_TIME}}
304
- - Duration: {{MIGRATION_WINDOW_DURATION}}
305
- - Notification: {{MIGRATION_NOTIFICATION}}
306
-
307
- ### Database Connection Pooling
308
-
309
- **Pool Configuration:**
310
-
311
- **Tool:** {{CONNECTION_POOL_TOOL}}
312
-
313
- **Settings:**
314
-
315
- - Min connections: {{POOL_MIN_CONNECTIONS}}
316
- - Max connections: {{POOL_MAX_CONNECTIONS}}
317
- - Connection timeout: {{POOL_CONNECTION_TIMEOUT}}ms
318
- - Idle timeout: {{POOL_IDLE_TIMEOUT}}ms
319
- - Max lifetime: {{POOL_MAX_LIFETIME}}ms
320
-
321
- **Configuration:**
322
-
323
- ```{{LANGUAGE}}
324
- {{CONNECTION_POOL_CONFIG_EXAMPLE}}
325
- ```
326
-
327
- **Monitoring:**
328
-
329
- - Active connections: {{POOL_MONITORING_ACTIVE}}
330
- - Idle connections: {{POOL_MONITORING_IDLE}}
331
- - Wait time: {{POOL_MONITORING_WAIT}}
332
- - Connection errors: {{POOL_MONITORING_ERRORS}}
333
-
334
- ### Backups
335
-
336
- **Frequency:** {{BACKUP_FREQUENCY}}
337
-
338
- **Retention:** {{BACKUP_RETENTION}}
339
-
340
- **Location:** {{BACKUP_LOCATION}}
341
-
342
- **Backup Command:**
343
-
344
- ```bash
345
- {{BACKUP_COMMAND}}
346
- ```
347
-
348
- **Restore Command:**
349
-
350
- ```bash
351
- {{RESTORE_COMMAND}}
352
- ```
353
-
354
- ### Disaster Recovery
355
-
356
- **RTO (Recovery Time Objective):** {{RTO}}
357
-
358
- **RPO (Recovery Point Objective):** {{RPO}}
359
-
360
- **Recovery Steps:**
361
- {{#EACH RECOVERY_STEP}}
362
- {{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
363
- {{/EACH}}
364
-
365
- ---
366
-
367
- ## ⚡ Scaling
368
-
369
- ### Horizontal Scaling
370
-
371
- {{HORIZONTAL_SCALING_DESCRIPTION}}
372
-
373
- **Auto-scaling:**
374
- {{#IF AUTO_SCALING}}
375
-
376
- - Enabled: Yes
377
- - Min instances: {{SCALING_MIN}}
378
- - Max instances: {{SCALING_MAX}}
379
- - Target CPU: {{SCALING_TARGET_CPU}}%
380
- - Target Memory: {{SCALING_TARGET_MEMORY}}%
381
- {{ELSE}}
382
- - Enabled: No - Manual scaling
383
- {{/IF}}
384
-
385
- ### Vertical Scaling
386
-
387
- {{VERTICAL_SCALING_DESCRIPTION}}
388
-
389
- **Current Resources:**
390
-
391
- - CPU: {{CURRENT_CPU}}
392
- - Memory: {{CURRENT_MEMORY}}
393
- - Disk: {{CURRENT_DISK}}
394
-
395
- ---
396
-
397
- ## 🏥 Health Checks
398
-
399
- ### Endpoints
400
-
401
- ```
402
- GET /health - Basic health check
403
- GET /health/ready - Readiness check
404
- GET /health/live - Liveness check
405
- ```
406
-
407
- ### Response Format
408
-
409
- ```json
410
- {{HEALTH_CHECK_RESPONSE_EXAMPLE}}
411
- ```
412
-
413
- ### Health Check Configuration
414
-
415
- ```{{LANGUAGE}}
416
- {{HEALTH_CHECK_CODE_EXAMPLE}}
417
- ```
418
-
419
- ---
420
-
421
- ## 🔐 Security Operations
422
-
423
- ### SSL/TLS
424
-
425
- **Certificate:** {{SSL_CERTIFICATE_PROVIDER}}
426
-
427
- **Renewal:** {{SSL_RENEWAL_PROCESS}}
428
-
429
- **Expiry Monitoring:** {{SSL_MONITORING}}
430
-
431
- ### Secrets Management
432
-
433
- **Tool:** {{SECRETS_MANAGER}}
434
-
435
- **Rotation:** {{SECRETS_ROTATION_POLICY}}
436
-
437
- ## **Access:** {{SECRETS_ACCESS_POLICY}}
438
-
439
- ## 📝 Runbooks
440
-
441
- {{#EACH RUNBOOK}}
442
-
443
- ### {{RUNBOOK_TITLE}}
444
-
445
- **Trigger:** {{RUNBOOK_TRIGGER}}
446
-
447
- **Steps:**
448
- {{#EACH RUNBOOK_STEP}}
449
- {{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
450
-
451
- ```bash
452
- {{STEP_COMMAND}}
453
- ```
454
-
455
- {{/EACH}}
456
-
457
- ## {{/EACH}}
458
-
459
- ## 🐛 Troubleshooting
460
-
461
- {{#EACH TROUBLESHOOTING_GUIDE}}
462
-
463
- ### {{ISSUE_TITLE}}
464
-
465
- **Symptoms:**
466
- {{#EACH SYMPTOM}}
467
-
468
- - {{SYMPTOM_DESCRIPTION}}
469
- {{/EACH}}
470
-
471
- **Diagnosis:**
472
-
473
- ```bash
474
- {{DIAGNOSIS_COMMAND}}
475
- ```
476
-
477
- **Resolution:**
478
- {{#EACH RESOLUTION_STEP}}
479
- {{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
480
- {{/EACH}}
481
-
482
- ## {{/EACH}}
483
-
484
- ## 📈 Performance Optimization
485
-
486
- {{#EACH OPTIMIZATION}}
487
-
488
- ### {{OPTIMIZATION_NAME}}
489
-
490
- **Current:** {{CURRENT_STATE}}
491
-
492
- **Target:** {{TARGET_STATE}}
493
-
494
- **Implementation:** {{OPTIMIZATION_IMPLEMENTATION}}
495
-
496
- ## {{/EACH}}
497
-
498
- ## 🔄 Rollback Procedures
499
-
500
- ### When to Rollback
501
-
502
- {{#EACH ROLLBACK_TRIGGER}}
503
-
504
- - {{TRIGGER_DESCRIPTION}}
505
- {{/EACH}}
506
-
507
- ### Rollback Steps
508
-
509
- ```bash
510
- {{ROLLBACK_COMMAND}}
511
- ```
512
-
513
- **Manual Rollback:**
514
- {{#EACH ROLLBACK_STEP}}
515
- {{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
516
- {{/EACH}}
517
-
518
- ---
519
-
520
- ## 🎯 Deployment Strategies
521
-
522
- ### Blue-Green Deployment
523
-
524
- {{#IF BLUE_GREEN_DEPLOYMENT}}
525
- **Enabled:** Yes
526
-
527
- **Strategy:**
528
- {{#EACH BLUE_GREEN_STEP}}
529
- {{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
530
- {{/EACH}}
531
-
532
- **Rollback:** {{BLUE_GREEN_ROLLBACK}}
533
-
534
- **Benefits:**
535
-
536
- - Zero-downtime deployments
537
- - Instant rollback capability
538
- - Easy A/B testing
539
-
540
- {{ELSE}}
541
- **Enabled:** No - Using standard deployment
542
- {{/IF}}
543
-
544
- ### Canary Deployment
545
-
546
- {{#IF CANARY_DEPLOYMENT}}
547
- **Enabled:** Yes
548
-
549
- **Strategy:**
550
-
551
- - Initial traffic: {{CANARY_INITIAL_TRAFFIC}}%
552
- - Gradual increase: {{CANARY_GRADUAL_INCREASE}}% per {{CANARY_INCREASE_INTERVAL}}
553
- - Success criteria: {{CANARY_SUCCESS_CRITERIA}}
554
- - Rollback trigger: {{CANARY_ROLLBACK_TRIGGER}}
555
-
556
- {{ELSE}}
557
- **Enabled:** No
558
- {{/IF}}
559
-
560
- ---
561
-
562
- ## 🛡️ Resilience Patterns
563
-
564
- ### Graceful Shutdown
565
-
566
- **Enabled:** {{#IF GRACEFUL_SHUTDOWN}}Yes{{ELSE}}No{{/IF}}
567
-
568
- {{#IF GRACEFUL_SHUTDOWN}}
569
- **Shutdown Sequence:**
570
- {{#EACH SHUTDOWN_STEP}}
571
- {{STEP_NUMBER}}. {{STEP_DESCRIPTION}} (timeout: {{STEP_TIMEOUT}}s)
572
- {{/EACH}}
573
-
574
- **Implementation:**
575
-
576
- ```{{LANGUAGE}}
577
- {{GRACEFUL_SHUTDOWN_EXAMPLE}}
578
- ```
579
-
580
- **Configuration:**
581
-
582
- - Shutdown timeout: {{SHUTDOWN_TIMEOUT}}s
583
- - Health check grace period: {{HEALTH_CHECK_GRACE_PERIOD}}s
584
- - Connection drain timeout: {{CONNECTION_DRAIN_TIMEOUT}}s
585
- {{/IF}}
586
-
587
- ### Circuit Breakers
588
-
589
- {{#IF CIRCUIT_BREAKERS}}
590
- **Enabled:** Yes
591
-
592
- **Tool:** {{CIRCUIT_BREAKER_TOOL}}
593
-
594
- **Configuration:**
595
- {{#EACH CIRCUIT_BREAKER}}
596
-
597
- #### {{SERVICE_NAME}}
598
-
599
- - Failure threshold: {{FAILURE_THRESHOLD}}%
600
- - Success threshold: {{SUCCESS_THRESHOLD}}%
601
- - Timeout: {{TIMEOUT}}ms
602
- - Half-open retries: {{HALF_OPEN_RETRIES}}
603
- - Reset timeout: {{RESET_TIMEOUT}}s
604
-
605
- **Fallback Strategy:** {{FALLBACK_STRATEGY}}
606
-
607
- **Implementation:**
608
-
609
- ```{{LANGUAGE}}
610
- {{CIRCUIT_BREAKER_EXAMPLE}}
611
- ```
612
-
613
- {{/EACH}}
614
-
615
- {{ELSE}}
616
- **Enabled:** No - Direct service calls without circuit breaking
617
- {{/IF}}
618
-
619
- ### Retry Policies
620
-
621
- {{#IF RETRY_POLICIES}}
622
- **Retry Strategy:** {{RETRY_STRATEGY}}
623
-
624
- {{#EACH RETRY_POLICY}}
625
-
626
- #### {{SERVICE_NAME}}
627
-
628
- - Max attempts: {{MAX_ATTEMPTS}}
629
- - Backoff strategy: {{BACKOFF_STRATEGY}}
630
- - Initial delay: {{INITIAL_DELAY}}ms
631
- - Max delay: {{MAX_DELAY}}ms
632
- - Retryable errors: {{RETRYABLE_ERRORS}}
633
-
634
- {{/EACH}}
635
-
636
- {{ELSE}}
637
-
638
- - Retry policies to be configured per service.
639
- {{/IF}}
640
-
641
- ### Timeout & Retry Matrix
642
-
643
- | Service/Dependency | Timeout | Retries | Backoff | Notes |
644
- | ------------------ | ------- | ------- | ------- | ----- |
645
-
646
- {{#EACH TIMEOUT_POLICY}}
647
- | {{SERVICE_NAME}} | {{TIMEOUT}}ms | {{RETRIES}} | {{BACKOFF}} | {{NOTES}} |
648
- {{/EACH}}
649
-
650
- **Global Defaults:**
651
-
652
- - Default HTTP timeout: {{DEFAULT_HTTP_TIMEOUT}}ms
653
- - Default retries: {{DEFAULT_RETRIES}}
654
- - Default backoff: {{DEFAULT_BACKOFF}}
655
-
656
- **Non-Retryable Errors:**
657
- {{#EACH NON_RETRYABLE_ERROR}}
658
-
659
- - `{{ERROR_CODE}}`: {{REASON}}
660
- {{/EACH}}
661
-
662
- ---
663
-
664
- ## 📋 Request/Response Logging
665
-
666
- ### Log Strategy by Environment
667
-
668
- | Environment | Level | Body Logging | Performance Logging |
669
- | ----------- | ----- | ------------ | ------------------- |
670
-
671
- {{#EACH LOGGING_STRATEGY}}
672
- | {{ENVIRONMENT}} | {{LEVEL}} | {{BODY_LOGGING}} | {{PERFORMANCE_LOGGING}} |
673
- {{/EACH}}
674
-
675
- ### Request Logging
676
-
677
- **Fields Logged:**
678
- {{#EACH REQUEST_LOG_FIELD}}
679
-
680
- - {{#IF ENABLED}}✅{{ELSE}}❌{{/IF}} `{{FIELD_NAME}}` - {{DESCRIPTION}}
681
- {{/EACH}}
682
-
683
- ### Response Logging
684
-
685
- **Fields Logged:**
686
- {{#EACH RESPONSE_LOG_FIELD}}
687
-
688
- - {{#IF ENABLED}}✅{{ELSE}}❌{{/IF}} `{{FIELD_NAME}}` - {{DESCRIPTION}}
689
- {{/EACH}}
690
-
691
- ### Sensitive Data Masking
692
-
693
- | Field Pattern | Masking Strategy |
694
- | ------------- | ---------------- |
695
-
696
- {{#EACH MASKING_RULE}}
697
- | `{{PATTERN}}` | {{STRATEGY}} |
698
- {{/EACH}}
699
-
700
- **Implementation Example:**
701
-
702
- ```{{LANGUAGE}}
703
- {{MASKING_EXAMPLE}}
704
- ```
705
-
706
- ---
707
-
708
- ## 📅 Maintenance Windows
709
-
710
- **Frequency:** {{MAINTENANCE_FREQUENCY}}
711
-
712
- **Duration:** {{MAINTENANCE_DURATION}}
713
-
714
- ## **Notification:** {{MAINTENANCE_NOTIFICATION}}
715
-
716
- **Document Version:** 1.0
717
-
718
- **Last Updated:** {{GENERATION_DATE}}
719
-
720
- **Generated by:** AI Flow v1.0.0
1
+ # Operations Guide
2
+
3
+ > Deployment, monitoring, and operational procedures for {{PROJECT_NAME}}
4
+
5
+ ---
6
+
7
+ ## 🚀 Deployment
8
+
9
+ ### Platform
10
+
11
+ **Environment:** {{DEPLOYMENT_PLATFORM}}
12
+
13
+ **Regions:** {{DEPLOYMENT_REGIONS}}
14
+
15
+ **Container:** {{#IF_DOCKER}}Yes - Docker{{ELSE}}No{{/IF_DOCKER}}
16
+
17
+ ### Deployment Strategy
18
+
19
+ **Strategy:** {{DEPLOYMENT_STRATEGY}}
20
+
21
+ {{#IF BLUE_GREEN}}
22
+ **Blue-Green Deployment:**
23
+
24
+ - Active environment: {{ACTIVE_ENVIRONMENT}}
25
+ - Standby environment: {{STANDBY_ENVIRONMENT}}
26
+ - Switch mechanism: {{SWITCH_MECHANISM}}
27
+ - Rollback time: < {{ROLLBACK_TIME}} seconds
28
+ {{/IF}}
29
+
30
+ {{#IF CANARY}}
31
+ **Canary Deployment:**
32
+
33
+ - Initial canary percentage: {{CANARY_INITIAL_PERCENTAGE}}%
34
+ - Rollout increments: {{CANARY_INCREMENTS}}
35
+ - Success criteria: {{CANARY_SUCCESS_CRITERIA}}
36
+ - Automatic rollback: {{CANARY_AUTO_ROLLBACK}}
37
+ {{/IF}}
38
+
39
+ {{#IF ROLLING}}
40
+ **Rolling Deployment:**
41
+
42
+ - Max unavailable: {{ROLLING_MAX_UNAVAILABLE}}
43
+ - Max surge: {{ROLLING_MAX_SURGE}}
44
+ - Health check: {{ROLLING_HEALTH_CHECK}}
45
+ {{/IF}}
46
+
47
+ ### Rollback Plan
48
+
49
+ **Trigger:** {{ROLLBACK_TRIGGER}}
50
+
51
+ **Process:**
52
+ {{#EACH ROLLBACK_STEP}}
53
+ {{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
54
+ {{/EACH}}
55
+
56
+ ## **Rollback Time:** < {{ROLLBACK_TARGET_TIME}} minutes
57
+
58
+ ## 🌍 Environments
59
+
60
+ {{#EACH ENVIRONMENT}}
61
+
62
+ ### {{ENV_NAME}}
63
+
64
+ **Purpose:** {{ENV_PURPOSE}}
65
+
66
+ **URL:** {{ENV_URL}}
67
+
68
+ **Database:** {{ENV_DATABASE}}
69
+
70
+ **Auto-deploy:** {{ENV_AUTO_DEPLOY}}
71
+
72
+ **Configuration:**
73
+
74
+ ```bash
75
+ {{ENV_CONFIG}}
76
+ ```
77
+
78
+ ## {{/EACH}}
79
+
80
+ ## 📦 Build & Deploy
81
+
82
+ ### Build Process
83
+
84
+ ```bash
85
+ {{BUILD_COMMAND}}
86
+ ```
87
+
88
+ **Build Output:** `{{BUILD_OUTPUT_DIR}}`
89
+
90
+ ### Deployment Steps
91
+
92
+ {{#EACH DEPLOYMENT_STEP}}
93
+ {{STEP_NUMBER}}. **{{STEP_TITLE}}**
94
+
95
+ ```bash
96
+ {{STEP_COMMAND}}
97
+ ```
98
+
99
+ {{STEP_DESCRIPTION}}
100
+
101
+ {{/EACH}}
102
+
103
+ {{#IF_DOCKER}}
104
+
105
+ ### Docker
106
+
107
+ **Dockerfile:** `{{DOCKERFILE_PATH}}`
108
+
109
+ ```dockerfile
110
+ {{DOCKERFILE_EXAMPLE}}
111
+ ```
112
+
113
+ **Build Image:**
114
+
115
+ ```bash
116
+ {{DOCKER_BUILD_COMMAND}}
117
+ ```
118
+
119
+ **Run Container:**
120
+
121
+ ```bash
122
+ {{DOCKER_RUN_COMMAND}}
123
+ ```
124
+
125
+ **Docker Compose:**
126
+
127
+ ```yaml
128
+ { { DOCKER_COMPOSE_EXAMPLE } }
129
+ ```
130
+
131
+ ## {{/IF_DOCKER}}
132
+
133
+ ## 🔄 CI/CD Pipeline
134
+
135
+ **Platform:** {{CICD_PLATFORM}}
136
+
137
+ **Configuration:** `{{CICD_CONFIG_FILE}}`
138
+
139
+ ### Pipeline Stages
140
+
141
+ {{#EACH PIPELINE_STAGE}}
142
+ {{STAGE_NUMBER}}. **{{STAGE_NAME}}**
143
+
144
+ - {{STAGE_DESCRIPTION}}
145
+ - Duration: ~{{STAGE_DURATION}}
146
+ - Fails if: {{STAGE_FAILURE_CONDITION}}
147
+
148
+ {{/EACH}}
149
+
150
+ ### Pipeline Configuration
151
+
152
+ ```yaml
153
+ { { CICD_CONFIG_EXAMPLE } }
154
+ ```
155
+
156
+ ---
157
+
158
+ ## 📊 Monitoring
159
+
160
+ ### APM (Application Performance Monitoring)
161
+
162
+ **Tool:** {{APM_TOOL}}
163
+
164
+ **Metrics Tracked:**
165
+ {{#EACH METRIC}}
166
+
167
+ - **{{METRIC_NAME}}**: {{METRIC_DESCRIPTION}} (threshold: {{METRIC_THRESHOLD}})
168
+ {{/EACH}}
169
+
170
+ **Dashboard:** {{APM_DASHBOARD_URL}}
171
+
172
+ ### Logging
173
+
174
+ **Tool:** {{LOGGING_TOOL}}
175
+
176
+ **Log Format:** {{LOG_FORMAT}}
177
+
178
+ **Log Levels:**
179
+ {{#EACH LOG_LEVEL}}
180
+
181
+ - **{{LEVEL_NAME}}**: {{LEVEL_USAGE}}
182
+ {{/EACH}}
183
+
184
+ **Example Log Entry:**
185
+
186
+ ```json
187
+ {{LOG_ENTRY_EXAMPLE}}
188
+ ```
189
+
190
+ **Viewing Logs:**
191
+
192
+ ```bash
193
+ {{VIEW_LOGS_COMMAND}}
194
+ ```
195
+
196
+ ### Metrics
197
+
198
+ {{#EACH TRACKED_METRIC}}
199
+
200
+ #### {{METRIC_NAME}}
201
+
202
+ **Description:** {{METRIC_DESCRIPTION}}
203
+
204
+ **Threshold:** {{METRIC_THRESHOLD}}
205
+
206
+ **Alert:** {{METRIC_ALERT_CONDITION}}
207
+
208
+ ## {{/EACH}}
209
+
210
+ ## 🚨 Alerting
211
+
212
+ ### Alert Channels
213
+
214
+ {{#EACH ALERT_CHANNEL}}
215
+
216
+ - **{{CHANNEL_NAME}}**: {{CHANNEL_PURPOSE}}
217
+ {{/EACH}}
218
+
219
+ ### Alert Rules
220
+
221
+ {{#EACH ALERT_RULE}}
222
+
223
+ #### {{ALERT_NAME}}
224
+
225
+ **Condition:** {{ALERT_CONDITION}}
226
+
227
+ **Severity:** {{ALERT_SEVERITY}}
228
+
229
+ **Notify:** {{ALERT_RECIPIENTS}}
230
+
231
+ **Action:** {{ALERT_ACTION}}
232
+
233
+ ## {{/EACH}}
234
+
235
+ ## 🔧 Configuration
236
+
237
+ ### Environment Variables
238
+
239
+ **Required:**
240
+ {{#EACH REQUIRED_ENV_VAR}}
241
+
242
+ - `{{VAR_NAME}}` - {{VAR_DESCRIPTION}}
243
+ {{/EACH}}
244
+
245
+ **Optional:**
246
+ {{#EACH OPTIONAL_ENV_VAR}}
247
+
248
+ - `{{VAR_NAME}}` - {{VAR_DESCRIPTION}} (default: {{VAR_DEFAULT}})
249
+ {{/EACH}}
250
+
251
+ **Per Environment:**
252
+
253
+ ```bash
254
+ # Development
255
+ {{DEV_ENV_VARS}}
256
+
257
+ # Staging
258
+ {{STAGING_ENV_VARS}}
259
+
260
+ # Production
261
+ {{PROD_ENV_VARS}}
262
+ ```
263
+
264
+ ---
265
+
266
+ ## 💾 Database Operations
267
+
268
+ ### Migrations
269
+
270
+ ```bash
271
+ # Run migrations
272
+ {{MIGRATION_RUN_COMMAND}}
273
+
274
+ # Rollback
275
+ {{MIGRATION_ROLLBACK_COMMAND}}
276
+
277
+ # Status
278
+ {{MIGRATION_STATUS_COMMAND}}
279
+ ```
280
+
281
+ ### Database Migrations in Production
282
+
283
+ **Strategy:** {{PRODUCTION_MIGRATION_STRATEGY}}
284
+
285
+ {{#IF ZERO_DOWNTIME_MIGRATIONS}}
286
+ **Zero-Downtime Migrations:** Enabled
287
+
288
+ **Approach:**
289
+ {{#EACH ZERO_DOWNTIME_STEP}}
290
+ {{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
291
+ {{/EACH}}
292
+
293
+ **Rollback Plan:**
294
+ {{#EACH ROLLBACK_STEP}}
295
+ {{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
296
+ {{/EACH}}
297
+ {{ELSE}}
298
+ **Zero-Downtime Migrations:** Not implemented (requires maintenance window)
299
+ {{/IF}}
300
+
301
+ **Migration Windows:**
302
+
303
+ - Preferred time: {{MIGRATION_WINDOW_TIME}}
304
+ - Duration: {{MIGRATION_WINDOW_DURATION}}
305
+ - Notification: {{MIGRATION_NOTIFICATION}}
306
+
307
+ ### Database Connection Pooling
308
+
309
+ **Pool Configuration:**
310
+
311
+ **Tool:** {{CONNECTION_POOL_TOOL}}
312
+
313
+ **Settings:**
314
+
315
+ - Min connections: {{POOL_MIN_CONNECTIONS}}
316
+ - Max connections: {{POOL_MAX_CONNECTIONS}}
317
+ - Connection timeout: {{POOL_CONNECTION_TIMEOUT}}ms
318
+ - Idle timeout: {{POOL_IDLE_TIMEOUT}}ms
319
+ - Max lifetime: {{POOL_MAX_LIFETIME}}ms
320
+
321
+ **Configuration:**
322
+
323
+ ```{{LANGUAGE}}
324
+ {{CONNECTION_POOL_CONFIG_EXAMPLE}}
325
+ ```
326
+
327
+ **Monitoring:**
328
+
329
+ - Active connections: {{POOL_MONITORING_ACTIVE}}
330
+ - Idle connections: {{POOL_MONITORING_IDLE}}
331
+ - Wait time: {{POOL_MONITORING_WAIT}}
332
+ - Connection errors: {{POOL_MONITORING_ERRORS}}
333
+
334
+ ### Backups
335
+
336
+ **Frequency:** {{BACKUP_FREQUENCY}}
337
+
338
+ **Retention:** {{BACKUP_RETENTION}}
339
+
340
+ **Location:** {{BACKUP_LOCATION}}
341
+
342
+ **Backup Command:**
343
+
344
+ ```bash
345
+ {{BACKUP_COMMAND}}
346
+ ```
347
+
348
+ **Restore Command:**
349
+
350
+ ```bash
351
+ {{RESTORE_COMMAND}}
352
+ ```
353
+
354
+ ### Disaster Recovery
355
+
356
+ **RTO (Recovery Time Objective):** {{RTO}}
357
+
358
+ **RPO (Recovery Point Objective):** {{RPO}}
359
+
360
+ **Recovery Steps:**
361
+ {{#EACH RECOVERY_STEP}}
362
+ {{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
363
+ {{/EACH}}
364
+
365
+ ---
366
+
367
+ ## ⚡ Scaling
368
+
369
+ ### Horizontal Scaling
370
+
371
+ {{HORIZONTAL_SCALING_DESCRIPTION}}
372
+
373
+ **Auto-scaling:**
374
+ {{#IF AUTO_SCALING}}
375
+
376
+ - Enabled: Yes
377
+ - Min instances: {{SCALING_MIN}}
378
+ - Max instances: {{SCALING_MAX}}
379
+ - Target CPU: {{SCALING_TARGET_CPU}}%
380
+ - Target Memory: {{SCALING_TARGET_MEMORY}}%
381
+ {{ELSE}}
382
+ - Enabled: No - Manual scaling
383
+ {{/IF}}
384
+
385
+ ### Vertical Scaling
386
+
387
+ {{VERTICAL_SCALING_DESCRIPTION}}
388
+
389
+ **Current Resources:**
390
+
391
+ - CPU: {{CURRENT_CPU}}
392
+ - Memory: {{CURRENT_MEMORY}}
393
+ - Disk: {{CURRENT_DISK}}
394
+
395
+ ---
396
+
397
+ ## 🏥 Health Checks
398
+
399
+ ### Endpoints
400
+
401
+ ```
402
+ GET /health - Basic health check
403
+ GET /health/ready - Readiness check
404
+ GET /health/live - Liveness check
405
+ ```
406
+
407
+ ### Response Format
408
+
409
+ ```json
410
+ {{HEALTH_CHECK_RESPONSE_EXAMPLE}}
411
+ ```
412
+
413
+ ### Health Check Configuration
414
+
415
+ ```{{LANGUAGE}}
416
+ {{HEALTH_CHECK_CODE_EXAMPLE}}
417
+ ```
418
+
419
+ ---
420
+
421
+ ## 🔐 Security Operations
422
+
423
+ ### SSL/TLS
424
+
425
+ **Certificate:** {{SSL_CERTIFICATE_PROVIDER}}
426
+
427
+ **Renewal:** {{SSL_RENEWAL_PROCESS}}
428
+
429
+ **Expiry Monitoring:** {{SSL_MONITORING}}
430
+
431
+ ### Secrets Management
432
+
433
+ **Tool:** {{SECRETS_MANAGER}}
434
+
435
+ **Rotation:** {{SECRETS_ROTATION_POLICY}}
436
+
437
+ ## **Access:** {{SECRETS_ACCESS_POLICY}}
438
+
439
+ ## 📝 Runbooks
440
+
441
+ {{#EACH RUNBOOK}}
442
+
443
+ ### {{RUNBOOK_TITLE}}
444
+
445
+ **Trigger:** {{RUNBOOK_TRIGGER}}
446
+
447
+ **Steps:**
448
+ {{#EACH RUNBOOK_STEP}}
449
+ {{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
450
+
451
+ ```bash
452
+ {{STEP_COMMAND}}
453
+ ```
454
+
455
+ {{/EACH}}
456
+
457
+ ## {{/EACH}}
458
+
459
+ ## 🐛 Troubleshooting
460
+
461
+ {{#EACH TROUBLESHOOTING_GUIDE}}
462
+
463
+ ### {{ISSUE_TITLE}}
464
+
465
+ **Symptoms:**
466
+ {{#EACH SYMPTOM}}
467
+
468
+ - {{SYMPTOM_DESCRIPTION}}
469
+ {{/EACH}}
470
+
471
+ **Diagnosis:**
472
+
473
+ ```bash
474
+ {{DIAGNOSIS_COMMAND}}
475
+ ```
476
+
477
+ **Resolution:**
478
+ {{#EACH RESOLUTION_STEP}}
479
+ {{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
480
+ {{/EACH}}
481
+
482
+ ## {{/EACH}}
483
+
484
+ ## 📈 Performance Optimization
485
+
486
+ {{#EACH OPTIMIZATION}}
487
+
488
+ ### {{OPTIMIZATION_NAME}}
489
+
490
+ **Current:** {{CURRENT_STATE}}
491
+
492
+ **Target:** {{TARGET_STATE}}
493
+
494
+ **Implementation:** {{OPTIMIZATION_IMPLEMENTATION}}
495
+
496
+ ## {{/EACH}}
497
+
498
+ ## 🔄 Rollback Procedures
499
+
500
+ ### When to Rollback
501
+
502
+ {{#EACH ROLLBACK_TRIGGER}}
503
+
504
+ - {{TRIGGER_DESCRIPTION}}
505
+ {{/EACH}}
506
+
507
+ ### Rollback Steps
508
+
509
+ ```bash
510
+ {{ROLLBACK_COMMAND}}
511
+ ```
512
+
513
+ **Manual Rollback:**
514
+ {{#EACH ROLLBACK_STEP}}
515
+ {{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
516
+ {{/EACH}}
517
+
518
+ ---
519
+
520
+ ## 🎯 Deployment Strategies
521
+
522
+ ### Blue-Green Deployment
523
+
524
+ {{#IF BLUE_GREEN_DEPLOYMENT}}
525
+ **Enabled:** Yes
526
+
527
+ **Strategy:**
528
+ {{#EACH BLUE_GREEN_STEP}}
529
+ {{STEP_NUMBER}}. {{STEP_DESCRIPTION}}
530
+ {{/EACH}}
531
+
532
+ **Rollback:** {{BLUE_GREEN_ROLLBACK}}
533
+
534
+ **Benefits:**
535
+
536
+ - Zero-downtime deployments
537
+ - Instant rollback capability
538
+ - Easy A/B testing
539
+
540
+ {{ELSE}}
541
+ **Enabled:** No - Using standard deployment
542
+ {{/IF}}
543
+
544
+ ### Canary Deployment
545
+
546
+ {{#IF CANARY_DEPLOYMENT}}
547
+ **Enabled:** Yes
548
+
549
+ **Strategy:**
550
+
551
+ - Initial traffic: {{CANARY_INITIAL_TRAFFIC}}%
552
+ - Gradual increase: {{CANARY_GRADUAL_INCREASE}}% per {{CANARY_INCREASE_INTERVAL}}
553
+ - Success criteria: {{CANARY_SUCCESS_CRITERIA}}
554
+ - Rollback trigger: {{CANARY_ROLLBACK_TRIGGER}}
555
+
556
+ {{ELSE}}
557
+ **Enabled:** No
558
+ {{/IF}}
559
+
560
+ ---
561
+
562
+ ## 🛡️ Resilience Patterns
563
+
564
+ ### Graceful Shutdown
565
+
566
+ **Enabled:** {{#IF GRACEFUL_SHUTDOWN}}Yes{{ELSE}}No{{/IF}}
567
+
568
+ {{#IF GRACEFUL_SHUTDOWN}}
569
+ **Shutdown Sequence:**
570
+ {{#EACH SHUTDOWN_STEP}}
571
+ {{STEP_NUMBER}}. {{STEP_DESCRIPTION}} (timeout: {{STEP_TIMEOUT}}s)
572
+ {{/EACH}}
573
+
574
+ **Implementation:**
575
+
576
+ ```{{LANGUAGE}}
577
+ {{GRACEFUL_SHUTDOWN_EXAMPLE}}
578
+ ```
579
+
580
+ **Configuration:**
581
+
582
+ - Shutdown timeout: {{SHUTDOWN_TIMEOUT}}s
583
+ - Health check grace period: {{HEALTH_CHECK_GRACE_PERIOD}}s
584
+ - Connection drain timeout: {{CONNECTION_DRAIN_TIMEOUT}}s
585
+ {{/IF}}
586
+
587
+ ### Circuit Breakers
588
+
589
+ {{#IF CIRCUIT_BREAKERS}}
590
+ **Enabled:** Yes
591
+
592
+ **Tool:** {{CIRCUIT_BREAKER_TOOL}}
593
+
594
+ **Configuration:**
595
+ {{#EACH CIRCUIT_BREAKER}}
596
+
597
+ #### {{SERVICE_NAME}}
598
+
599
+ - Failure threshold: {{FAILURE_THRESHOLD}}%
600
+ - Success threshold: {{SUCCESS_THRESHOLD}}%
601
+ - Timeout: {{TIMEOUT}}ms
602
+ - Half-open retries: {{HALF_OPEN_RETRIES}}
603
+ - Reset timeout: {{RESET_TIMEOUT}}s
604
+
605
+ **Fallback Strategy:** {{FALLBACK_STRATEGY}}
606
+
607
+ **Implementation:**
608
+
609
+ ```{{LANGUAGE}}
610
+ {{CIRCUIT_BREAKER_EXAMPLE}}
611
+ ```
612
+
613
+ {{/EACH}}
614
+
615
+ {{ELSE}}
616
+ **Enabled:** No - Direct service calls without circuit breaking
617
+ {{/IF}}
618
+
619
+ ### Retry Policies
620
+
621
+ {{#IF RETRY_POLICIES}}
622
+ **Retry Strategy:** {{RETRY_STRATEGY}}
623
+
624
+ {{#EACH RETRY_POLICY}}
625
+
626
+ #### {{SERVICE_NAME}}
627
+
628
+ - Max attempts: {{MAX_ATTEMPTS}}
629
+ - Backoff strategy: {{BACKOFF_STRATEGY}}
630
+ - Initial delay: {{INITIAL_DELAY}}ms
631
+ - Max delay: {{MAX_DELAY}}ms
632
+ - Retryable errors: {{RETRYABLE_ERRORS}}
633
+
634
+ {{/EACH}}
635
+
636
+ {{ELSE}}
637
+
638
+ - Retry policies to be configured per service.
639
+ {{/IF}}
640
+
641
+ ### Timeout & Retry Matrix
642
+
643
+ | Service/Dependency | Timeout | Retries | Backoff | Notes |
644
+ | ------------------ | ------- | ------- | ------- | ----- |
645
+
646
+ {{#EACH TIMEOUT_POLICY}}
647
+ | {{SERVICE_NAME}} | {{TIMEOUT}}ms | {{RETRIES}} | {{BACKOFF}} | {{NOTES}} |
648
+ {{/EACH}}
649
+
650
+ **Global Defaults:**
651
+
652
+ - Default HTTP timeout: {{DEFAULT_HTTP_TIMEOUT}}ms
653
+ - Default retries: {{DEFAULT_RETRIES}}
654
+ - Default backoff: {{DEFAULT_BACKOFF}}
655
+
656
+ **Non-Retryable Errors:**
657
+ {{#EACH NON_RETRYABLE_ERROR}}
658
+
659
+ - `{{ERROR_CODE}}`: {{REASON}}
660
+ {{/EACH}}
661
+
662
+ ---
663
+
664
+ ## 📋 Request/Response Logging
665
+
666
+ ### Log Strategy by Environment
667
+
668
+ | Environment | Level | Body Logging | Performance Logging |
669
+ | ----------- | ----- | ------------ | ------------------- |
670
+
671
+ {{#EACH LOGGING_STRATEGY}}
672
+ | {{ENVIRONMENT}} | {{LEVEL}} | {{BODY_LOGGING}} | {{PERFORMANCE_LOGGING}} |
673
+ {{/EACH}}
674
+
675
+ ### Request Logging
676
+
677
+ **Fields Logged:**
678
+ {{#EACH REQUEST_LOG_FIELD}}
679
+
680
+ - {{#IF ENABLED}}✅{{ELSE}}❌{{/IF}} `{{FIELD_NAME}}` - {{DESCRIPTION}}
681
+ {{/EACH}}
682
+
683
+ ### Response Logging
684
+
685
+ **Fields Logged:**
686
+ {{#EACH RESPONSE_LOG_FIELD}}
687
+
688
+ - {{#IF ENABLED}}✅{{ELSE}}❌{{/IF}} `{{FIELD_NAME}}` - {{DESCRIPTION}}
689
+ {{/EACH}}
690
+
691
+ ### Sensitive Data Masking
692
+
693
+ | Field Pattern | Masking Strategy |
694
+ | ------------- | ---------------- |
695
+
696
+ {{#EACH MASKING_RULE}}
697
+ | `{{PATTERN}}` | {{STRATEGY}} |
698
+ {{/EACH}}
699
+
700
+ **Implementation Example:**
701
+
702
+ ```{{LANGUAGE}}
703
+ {{MASKING_EXAMPLE}}
704
+ ```
705
+
706
+ ---
707
+
708
+ ## 📅 Maintenance Windows
709
+
710
+ **Frequency:** {{MAINTENANCE_FREQUENCY}}
711
+
712
+ **Duration:** {{MAINTENANCE_DURATION}}
713
+
714
+ ## **Notification:** {{MAINTENANCE_NOTIFICATION}}
715
+
716
+ **Document Version:** 1.0
717
+
718
+ **Last Updated:** {{GENERATION_DATE}}
719
+
720
+ **Generated by:** AI Flow v1.0.0