aigroup-workflow 2.2.1 → 2.2.3

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 (653) hide show
  1. package/.claude/commands/fix-build.md +10 -5
  2. package/.claude/commands/init-project.md +13 -8
  3. package/.claude/commands/plan.md +15 -8
  4. package/.claude/commands/review.md +12 -6
  5. package/.claude/commands/tdd.md +11 -5
  6. package/.claude/commands/workflow-start.md +20 -11
  7. package/.claude/settings.json +28 -0
  8. package/.codex/agents/architect.toml +207 -0
  9. package/.codex/agents/build-error-resolver.toml +110 -0
  10. package/.codex/agents/code-reviewer.toml +233 -0
  11. package/.codex/agents/doc-updater.toml +103 -0
  12. package/.codex/agents/e2e-runner.toml +103 -0
  13. package/.codex/agents/get-current-datetime.toml +23 -0
  14. package/.codex/agents/init-architect.toml +181 -0
  15. package/.codex/agents/planner.toml +208 -0
  16. package/.codex/agents/refactor-cleaner.toml +81 -0
  17. package/.codex/agents/rust-reviewer.toml +90 -0
  18. package/.codex/agents/security-reviewer.toml +104 -0
  19. package/.codex/agents/tdd-guide.toml +87 -0
  20. package/.codex/config.toml +22 -39
  21. package/AGENTS.md +2 -2
  22. package/CLAUDE.md +23 -1
  23. package/LICENSE +20 -20
  24. package/README.md +333 -333
  25. package/agents/a11y-architect.md +141 -141
  26. package/agents/architect.md +211 -211
  27. package/agents/build-error-resolver.md +114 -114
  28. package/agents/chief-of-staff.md +151 -151
  29. package/agents/code-architect.md +71 -71
  30. package/agents/code-explorer.md +69 -69
  31. package/agents/code-reviewer.md +237 -237
  32. package/agents/code-simplifier.md +47 -47
  33. package/agents/comment-analyzer.md +45 -45
  34. package/agents/conversation-analyzer.md +52 -52
  35. package/agents/cpp-build-resolver.md +90 -90
  36. package/agents/cpp-reviewer.md +72 -72
  37. package/agents/csharp-reviewer.md +101 -101
  38. package/agents/dart-build-resolver.md +201 -201
  39. package/agents/database-reviewer.md +91 -91
  40. package/agents/doc-updater.md +107 -107
  41. package/agents/docs-lookup.md +68 -68
  42. package/agents/e2e-runner.md +107 -107
  43. package/agents/flutter-reviewer.md +243 -243
  44. package/agents/gan-evaluator.md +209 -209
  45. package/agents/gan-generator.md +131 -131
  46. package/agents/gan-planner.md +99 -99
  47. package/agents/get-current-datetime.md +26 -26
  48. package/agents/go-build-resolver.md +94 -94
  49. package/agents/go-reviewer.md +76 -76
  50. package/agents/harness-optimizer.md +35 -35
  51. package/agents/healthcare-reviewer.md +83 -83
  52. package/agents/java-build-resolver.md +153 -153
  53. package/agents/java-reviewer.md +92 -92
  54. package/agents/kotlin-build-resolver.md +118 -118
  55. package/agents/kotlin-reviewer.md +159 -159
  56. package/agents/loop-operator.md +36 -36
  57. package/agents/opensource-forker.md +198 -198
  58. package/agents/opensource-packager.md +249 -249
  59. package/agents/opensource-sanitizer.md +188 -188
  60. package/agents/performance-optimizer.md +446 -446
  61. package/agents/planner.md +212 -212
  62. package/agents/pr-test-analyzer.md +45 -45
  63. package/agents/python-reviewer.md +98 -98
  64. package/agents/pytorch-build-resolver.md +120 -120
  65. package/agents/refactor-cleaner.md +85 -85
  66. package/agents/rust-build-resolver.md +148 -148
  67. package/agents/rust-reviewer.md +94 -94
  68. package/agents/security-reviewer.md +108 -108
  69. package/agents/seo-specialist.md +59 -59
  70. package/agents/silent-failure-hunter.md +50 -50
  71. package/agents/tdd-guide.md +91 -91
  72. package/agents/type-design-analyzer.md +41 -41
  73. package/agents/typescript-reviewer.md +112 -112
  74. package/cli/commands/update.mjs +1 -1
  75. package/cli/utils/scaffold.mjs +53 -0
  76. package/docs/rules/agents.md +166 -50
  77. package/docs/rules/cpp/coding-style.md +44 -44
  78. package/docs/rules/cpp/hooks.md +39 -39
  79. package/docs/rules/cpp/patterns.md +51 -51
  80. package/docs/rules/cpp/security.md +51 -51
  81. package/docs/rules/cpp/testing.md +44 -44
  82. package/docs/rules/csharp/coding-style.md +72 -72
  83. package/docs/rules/csharp/hooks.md +25 -25
  84. package/docs/rules/csharp/patterns.md +50 -50
  85. package/docs/rules/csharp/security.md +58 -58
  86. package/docs/rules/csharp/testing.md +46 -46
  87. package/docs/rules/dart/coding-style.md +159 -159
  88. package/docs/rules/dart/hooks.md +66 -66
  89. package/docs/rules/dart/patterns.md +261 -261
  90. package/docs/rules/dart/security.md +135 -135
  91. package/docs/rules/dart/testing.md +215 -215
  92. package/docs/rules/golang/coding-style.md +32 -32
  93. package/docs/rules/golang/hooks.md +17 -17
  94. package/docs/rules/golang/patterns.md +45 -45
  95. package/docs/rules/golang/security.md +34 -34
  96. package/docs/rules/golang/testing.md +31 -31
  97. package/docs/rules/java/coding-style.md +114 -114
  98. package/docs/rules/java/hooks.md +18 -18
  99. package/docs/rules/java/patterns.md +146 -146
  100. package/docs/rules/java/security.md +100 -100
  101. package/docs/rules/java/testing.md +131 -131
  102. package/docs/rules/java_zn/coding-style.md +169 -0
  103. package/docs/rules/java_zn/mybatis.md +102 -0
  104. package/docs/rules/kotlin/coding-style.md +86 -86
  105. package/docs/rules/kotlin/hooks.md +17 -17
  106. package/docs/rules/kotlin/patterns.md +146 -146
  107. package/docs/rules/kotlin/security.md +82 -82
  108. package/docs/rules/kotlin/testing.md +128 -128
  109. package/docs/rules/perl/coding-style.md +46 -46
  110. package/docs/rules/perl/hooks.md +22 -22
  111. package/docs/rules/perl/patterns.md +76 -76
  112. package/docs/rules/perl/security.md +69 -69
  113. package/docs/rules/perl/testing.md +54 -54
  114. package/docs/rules/php/coding-style.md +40 -40
  115. package/docs/rules/php/hooks.md +24 -24
  116. package/docs/rules/php/patterns.md +33 -33
  117. package/docs/rules/php/security.md +37 -37
  118. package/docs/rules/php/testing.md +39 -39
  119. package/docs/rules/python/coding-style.md +42 -42
  120. package/docs/rules/python/hooks.md +19 -19
  121. package/docs/rules/python/patterns.md +39 -39
  122. package/docs/rules/python/security.md +30 -30
  123. package/docs/rules/python/testing.md +38 -38
  124. package/docs/rules/rust/coding-style.md +151 -151
  125. package/docs/rules/rust/hooks.md +16 -16
  126. package/docs/rules/rust/patterns.md +168 -168
  127. package/docs/rules/rust/security.md +141 -141
  128. package/docs/rules/rust/testing.md +154 -154
  129. package/docs/rules/swift/coding-style.md +47 -47
  130. package/docs/rules/swift/hooks.md +20 -20
  131. package/docs/rules/swift/patterns.md +66 -66
  132. package/docs/rules/swift/security.md +33 -33
  133. package/docs/rules/swift/testing.md +45 -45
  134. package/docs/rules/typescript/coding-style.md +199 -199
  135. package/docs/rules/typescript/hooks.md +22 -22
  136. package/docs/rules/typescript/patterns.md +52 -52
  137. package/docs/rules/typescript/security.md +28 -28
  138. package/docs/rules/typescript/testing.md +18 -18
  139. package/docs/rules/web/coding-style.md +96 -96
  140. package/docs/rules/web/design-quality.md +62 -62
  141. package/docs/rules/web/hooks.md +120 -120
  142. package/docs/rules/web/patterns.md +79 -79
  143. package/docs/rules/web/performance.md +64 -64
  144. package/docs/rules/web/security.md +57 -57
  145. package/docs/rules/web/testing.md +55 -55
  146. package/docs/templates/README.md +36 -36
  147. package/docs/templates/ai-project-final.md +124 -124
  148. package/docs/templates/ai-project.md +105 -105
  149. package/docs/templates/api.md +157 -157
  150. package/docs/templates/bug.md +62 -62
  151. package/docs/templates/code-review.md +87 -87
  152. package/docs/templates/generic.md +116 -116
  153. package/docs/templates/implementation-plan.md +1 -1
  154. package/docs/templates/meeting.md +68 -68
  155. package/docs/templates/prd.md +98 -98
  156. package/docs/templates/ui.md +134 -134
  157. package/docs/workflow-pipeline.md +5 -5
  158. package/package.json +40 -39
  159. package/skills/SUPERPOWERS-LICENSE +21 -21
  160. package/skills/ai-ml/fine-tuning-expert/SKILL.md +162 -162
  161. package/skills/ai-ml/fine-tuning-expert/references/dataset-preparation.md +540 -540
  162. package/skills/ai-ml/fine-tuning-expert/references/deployment-optimization.md +673 -673
  163. package/skills/ai-ml/fine-tuning-expert/references/evaluation-metrics.md +597 -597
  164. package/skills/ai-ml/fine-tuning-expert/references/hyperparameter-tuning.md +565 -565
  165. package/skills/ai-ml/fine-tuning-expert/references/lora-peft.md +347 -347
  166. package/skills/ai-ml/ml-pipeline/SKILL.md +159 -159
  167. package/skills/ai-ml/ml-pipeline/references/experiment-tracking.md +833 -833
  168. package/skills/ai-ml/ml-pipeline/references/feature-engineering.md +631 -631
  169. package/skills/ai-ml/ml-pipeline/references/model-validation.md +978 -978
  170. package/skills/ai-ml/ml-pipeline/references/pipeline-orchestration.md +907 -907
  171. package/skills/ai-ml/ml-pipeline/references/training-pipelines.md +782 -782
  172. package/skills/ai-ml/rag-architect/SKILL.md +194 -194
  173. package/skills/ai-ml/rag-architect/references/chunking-strategies.md +878 -878
  174. package/skills/ai-ml/rag-architect/references/embedding-models.md +561 -561
  175. package/skills/ai-ml/rag-architect/references/rag-evaluation.md +833 -833
  176. package/skills/ai-ml/rag-architect/references/retrieval-optimization.md +795 -795
  177. package/skills/ai-ml/rag-architect/references/vector-databases.md +589 -589
  178. package/skills/ai-ml/spark-engineer/SKILL.md +148 -148
  179. package/skills/ai-ml/spark-engineer/references/partitioning-caching.md +543 -543
  180. package/skills/ai-ml/spark-engineer/references/performance-tuning.md +544 -544
  181. package/skills/ai-ml/spark-engineer/references/rdd-operations.md +599 -599
  182. package/skills/ai-ml/spark-engineer/references/spark-sql-dataframes.md +474 -474
  183. package/skills/ai-ml/spark-engineer/references/streaming-patterns.md +786 -786
  184. package/skills/backend/api-designer/SKILL.md +217 -217
  185. package/skills/backend/api-designer/references/error-handling.md +541 -541
  186. package/skills/backend/api-designer/references/openapi.md +824 -824
  187. package/skills/backend/api-designer/references/pagination.md +494 -494
  188. package/skills/backend/api-designer/references/rest-patterns.md +335 -335
  189. package/skills/backend/api-designer/references/versioning.md +391 -391
  190. package/skills/backend/architecture-designer/SKILL.md +117 -117
  191. package/skills/backend/architecture-designer/references/adr-template.md +116 -116
  192. package/skills/backend/architecture-designer/references/architecture-patterns.md +111 -111
  193. package/skills/backend/architecture-designer/references/database-selection.md +102 -102
  194. package/skills/backend/architecture-designer/references/nfr-checklist.md +112 -112
  195. package/skills/backend/architecture-designer/references/system-design.md +100 -100
  196. package/skills/backend/code-documenter/SKILL.md +147 -147
  197. package/skills/backend/code-documenter/references/api-docs-fastapi-django.md +166 -166
  198. package/skills/backend/code-documenter/references/api-docs-nestjs-express.md +220 -220
  199. package/skills/backend/code-documenter/references/coverage-reports.md +125 -125
  200. package/skills/backend/code-documenter/references/documentation-systems.md +333 -333
  201. package/skills/backend/code-documenter/references/interactive-api-docs.md +531 -531
  202. package/skills/backend/code-documenter/references/python-docstrings.md +121 -121
  203. package/skills/backend/code-documenter/references/typescript-jsdoc.md +145 -145
  204. package/skills/backend/code-documenter/references/user-guides-tutorials.md +530 -530
  205. package/skills/backend/debugging-wizard/SKILL.md +105 -105
  206. package/skills/backend/debugging-wizard/references/common-patterns.md +132 -132
  207. package/skills/backend/debugging-wizard/references/debugging-tools.md +140 -140
  208. package/skills/backend/debugging-wizard/references/quick-fixes.md +177 -177
  209. package/skills/backend/debugging-wizard/references/strategies.md +142 -142
  210. package/skills/backend/debugging-wizard/references/systematic-debugging.md +367 -367
  211. package/skills/backend/feature-forge/SKILL.md +98 -98
  212. package/skills/backend/feature-forge/references/acceptance-criteria.md +104 -104
  213. package/skills/backend/feature-forge/references/ears-syntax.md +99 -99
  214. package/skills/backend/feature-forge/references/interview-questions.md +150 -150
  215. package/skills/backend/feature-forge/references/pre-discovery-subagents.md +54 -54
  216. package/skills/backend/feature-forge/references/specification-template.md +103 -103
  217. package/skills/backend/fullstack-guardian/SKILL.md +105 -105
  218. package/skills/backend/fullstack-guardian/references/api-design-standards.md +307 -307
  219. package/skills/backend/fullstack-guardian/references/architecture-decisions.md +350 -350
  220. package/skills/backend/fullstack-guardian/references/backend-patterns.md +237 -237
  221. package/skills/backend/fullstack-guardian/references/common-patterns.md +134 -134
  222. package/skills/backend/fullstack-guardian/references/deliverables-checklist.md +354 -354
  223. package/skills/backend/fullstack-guardian/references/design-template.md +91 -91
  224. package/skills/backend/fullstack-guardian/references/error-handling.md +135 -135
  225. package/skills/backend/fullstack-guardian/references/frontend-patterns.md +340 -340
  226. package/skills/backend/fullstack-guardian/references/integration-patterns.md +333 -333
  227. package/skills/backend/fullstack-guardian/references/security-checklist.md +106 -106
  228. package/skills/backend/graphql-architect/SKILL.md +146 -146
  229. package/skills/backend/graphql-architect/references/federation.md +418 -418
  230. package/skills/backend/graphql-architect/references/migration-from-rest.md +1141 -1141
  231. package/skills/backend/graphql-architect/references/resolvers.md +425 -425
  232. package/skills/backend/graphql-architect/references/schema-design.md +393 -393
  233. package/skills/backend/graphql-architect/references/security.md +569 -569
  234. package/skills/backend/graphql-architect/references/subscriptions.md +510 -510
  235. package/skills/backend/legacy-modernizer/SKILL.md +137 -137
  236. package/skills/backend/legacy-modernizer/references/legacy-testing.md +381 -381
  237. package/skills/backend/legacy-modernizer/references/migration-strategies.md +423 -423
  238. package/skills/backend/legacy-modernizer/references/refactoring-patterns.md +395 -395
  239. package/skills/backend/legacy-modernizer/references/strangler-fig-pattern.md +281 -281
  240. package/skills/backend/legacy-modernizer/references/system-assessment.md +487 -487
  241. package/skills/backend/microservices-architect/SKILL.md +164 -164
  242. package/skills/backend/microservices-architect/references/communication.md +499 -499
  243. package/skills/backend/microservices-architect/references/data.md +721 -721
  244. package/skills/backend/microservices-architect/references/decomposition.md +344 -344
  245. package/skills/backend/microservices-architect/references/observability.md +805 -805
  246. package/skills/backend/microservices-architect/references/patterns.md +603 -603
  247. package/skills/database/database-optimizer/SKILL.md +147 -147
  248. package/skills/database/database-optimizer/references/index-strategies.md +331 -331
  249. package/skills/database/database-optimizer/references/monitoring-analysis.md +501 -501
  250. package/skills/database/database-optimizer/references/mysql-tuning.md +452 -452
  251. package/skills/database/database-optimizer/references/postgresql-tuning.md +413 -413
  252. package/skills/database/database-optimizer/references/query-optimization.md +251 -251
  253. package/skills/database/postgres-pro/SKILL.md +152 -152
  254. package/skills/database/postgres-pro/references/extensions.md +404 -404
  255. package/skills/database/postgres-pro/references/jsonb.md +321 -321
  256. package/skills/database/postgres-pro/references/maintenance.md +481 -481
  257. package/skills/database/postgres-pro/references/performance.md +265 -265
  258. package/skills/database/postgres-pro/references/replication.md +446 -446
  259. package/skills/database/sql-pro/SKILL.md +129 -129
  260. package/skills/database/sql-pro/references/database-design.md +402 -402
  261. package/skills/database/sql-pro/references/dialect-differences.md +419 -419
  262. package/skills/database/sql-pro/references/optimization.md +384 -384
  263. package/skills/database/sql-pro/references/query-patterns.md +285 -285
  264. package/skills/database/sql-pro/references/window-functions.md +328 -328
  265. package/skills/dotnet/csharp-developer/SKILL.md +125 -125
  266. package/skills/dotnet/csharp-developer/references/aspnet-core.md +394 -394
  267. package/skills/dotnet/csharp-developer/references/blazor.md +553 -553
  268. package/skills/dotnet/csharp-developer/references/entity-framework.md +409 -409
  269. package/skills/dotnet/csharp-developer/references/modern-csharp.md +248 -248
  270. package/skills/dotnet/csharp-developer/references/performance.md +498 -498
  271. package/skills/dotnet/dotnet-core-expert/SKILL.md +138 -138
  272. package/skills/dotnet/dotnet-core-expert/references/authentication.md +546 -546
  273. package/skills/dotnet/dotnet-core-expert/references/clean-architecture.md +455 -455
  274. package/skills/dotnet/dotnet-core-expert/references/cloud-native.md +548 -548
  275. package/skills/dotnet/dotnet-core-expert/references/entity-framework.md +440 -440
  276. package/skills/dotnet/dotnet-core-expert/references/minimal-apis.md +319 -319
  277. package/skills/frontend/angular-architect/SKILL.md +152 -152
  278. package/skills/frontend/angular-architect/references/components.md +297 -297
  279. package/skills/frontend/angular-architect/references/ngrx.md +401 -401
  280. package/skills/frontend/angular-architect/references/routing.md +361 -361
  281. package/skills/frontend/angular-architect/references/rxjs.md +319 -319
  282. package/skills/frontend/angular-architect/references/testing.md +405 -405
  283. package/skills/frontend/design-commands/design.md +91 -91
  284. package/skills/frontend/design-commands/handoff.md +97 -97
  285. package/skills/frontend/design-commands/prototype.md +120 -120
  286. package/skills/frontend/design-commands/spec.md +160 -160
  287. package/skills/frontend/design-commands/style.md +78 -78
  288. package/skills/frontend/flutter-expert/SKILL.md +138 -138
  289. package/skills/frontend/flutter-expert/references/bloc-state.md +259 -259
  290. package/skills/frontend/flutter-expert/references/gorouter-navigation.md +119 -119
  291. package/skills/frontend/flutter-expert/references/performance.md +99 -99
  292. package/skills/frontend/flutter-expert/references/project-structure.md +118 -118
  293. package/skills/frontend/flutter-expert/references/riverpod-state.md +130 -130
  294. package/skills/frontend/flutter-expert/references/widget-patterns.md +123 -123
  295. package/skills/frontend/nextjs-developer/SKILL.md +143 -143
  296. package/skills/frontend/nextjs-developer/references/app-router.md +311 -311
  297. package/skills/frontend/nextjs-developer/references/data-fetching.md +482 -482
  298. package/skills/frontend/nextjs-developer/references/deployment.md +545 -545
  299. package/skills/frontend/nextjs-developer/references/server-actions.md +462 -462
  300. package/skills/frontend/nextjs-developer/references/server-components.md +384 -384
  301. package/skills/frontend/react-expert/SKILL.md +149 -149
  302. package/skills/frontend/react-expert/references/hooks-patterns.md +162 -162
  303. package/skills/frontend/react-expert/references/migration-class-to-modern.md +1119 -1119
  304. package/skills/frontend/react-expert/references/performance.md +168 -168
  305. package/skills/frontend/react-expert/references/react-19-features.md +174 -174
  306. package/skills/frontend/react-expert/references/server-components.md +143 -143
  307. package/skills/frontend/react-expert/references/state-management.md +171 -171
  308. package/skills/frontend/react-expert/references/testing-react.md +174 -174
  309. package/skills/frontend/react-native-expert/SKILL.md +185 -185
  310. package/skills/frontend/react-native-expert/references/expo-router.md +187 -187
  311. package/skills/frontend/react-native-expert/references/list-optimization.md +204 -204
  312. package/skills/frontend/react-native-expert/references/platform-handling.md +188 -188
  313. package/skills/frontend/react-native-expert/references/project-structure.md +171 -171
  314. package/skills/frontend/react-native-expert/references/storage-hooks.md +173 -173
  315. package/skills/frontend/senior-frontend/SKILL.md +477 -477
  316. package/skills/frontend/senior-frontend/references/frontend_best_practices.md +806 -806
  317. package/skills/frontend/senior-frontend/references/nextjs_optimization_guide.md +724 -724
  318. package/skills/frontend/senior-frontend/references/react_patterns.md +746 -746
  319. package/skills/frontend/senior-frontend/scripts/bundle_analyzer.py +407 -407
  320. package/skills/frontend/senior-frontend/scripts/component_generator.py +329 -329
  321. package/skills/frontend/senior-frontend/scripts/frontend_scaffolder.py +1005 -1005
  322. package/skills/frontend/ui-ux-pro-max/SKILL.md +386 -386
  323. package/skills/frontend/ui-ux-pro-max/data/charts.csv +26 -26
  324. package/skills/frontend/ui-ux-pro-max/data/colors.csv +97 -97
  325. package/skills/frontend/ui-ux-pro-max/data/icons.csv +101 -101
  326. package/skills/frontend/ui-ux-pro-max/data/landing.csv +31 -31
  327. package/skills/frontend/ui-ux-pro-max/data/products.csv +96 -96
  328. package/skills/frontend/ui-ux-pro-max/data/react-performance.csv +45 -45
  329. package/skills/frontend/ui-ux-pro-max/data/stacks/astro.csv +54 -54
  330. package/skills/frontend/ui-ux-pro-max/data/stacks/flutter.csv +53 -53
  331. package/skills/frontend/ui-ux-pro-max/data/stacks/html-tailwind.csv +56 -56
  332. package/skills/frontend/ui-ux-pro-max/data/stacks/jetpack-compose.csv +53 -53
  333. package/skills/frontend/ui-ux-pro-max/data/stacks/nextjs.csv +53 -53
  334. package/skills/frontend/ui-ux-pro-max/data/stacks/nuxt-ui.csv +51 -51
  335. package/skills/frontend/ui-ux-pro-max/data/stacks/nuxtjs.csv +59 -59
  336. package/skills/frontend/ui-ux-pro-max/data/stacks/react-native.csv +52 -52
  337. package/skills/frontend/ui-ux-pro-max/data/stacks/react.csv +54 -54
  338. package/skills/frontend/ui-ux-pro-max/data/stacks/shadcn.csv +61 -61
  339. package/skills/frontend/ui-ux-pro-max/data/stacks/svelte.csv +54 -54
  340. package/skills/frontend/ui-ux-pro-max/data/stacks/swiftui.csv +51 -51
  341. package/skills/frontend/ui-ux-pro-max/data/stacks/vue.csv +50 -50
  342. package/skills/frontend/ui-ux-pro-max/data/styles.csv +68 -68
  343. package/skills/frontend/ui-ux-pro-max/data/typography.csv +57 -57
  344. package/skills/frontend/ui-ux-pro-max/data/ui-reasoning.csv +101 -101
  345. package/skills/frontend/ui-ux-pro-max/data/ux-guidelines.csv +99 -99
  346. package/skills/frontend/ui-ux-pro-max/data/web-interface.csv +31 -31
  347. package/skills/frontend/ui-ux-pro-max/scripts/core.py +253 -253
  348. package/skills/frontend/ui-ux-pro-max/scripts/design_system.py +1067 -1067
  349. package/skills/frontend/ui-ux-pro-max/scripts/search.py +114 -114
  350. package/skills/frontend/vue-expert/SKILL.md +98 -98
  351. package/skills/frontend/vue-expert/references/build-tooling.md +480 -480
  352. package/skills/frontend/vue-expert/references/components.md +448 -448
  353. package/skills/frontend/vue-expert/references/composition-api.md +299 -299
  354. package/skills/frontend/vue-expert/references/mobile-hybrid.md +636 -636
  355. package/skills/frontend/vue-expert/references/nuxt.md +669 -669
  356. package/skills/frontend/vue-expert/references/state-management.md +449 -449
  357. package/skills/frontend/vue-expert/references/typescript.md +584 -584
  358. package/skills/frontend/vue-expert-js/SKILL.md +167 -167
  359. package/skills/frontend/vue-expert-js/references/component-architecture.md +219 -219
  360. package/skills/frontend/vue-expert-js/references/composables-patterns.md +183 -183
  361. package/skills/frontend/vue-expert-js/references/jsdoc-typing.md +535 -535
  362. package/skills/frontend/vue-expert-js/references/state-management.md +249 -249
  363. package/skills/frontend/vue-expert-js/references/testing-patterns.md +237 -237
  364. package/skills/go-rust-cpp/cpp-pro/SKILL.md +115 -115
  365. package/skills/go-rust-cpp/cpp-pro/references/build-tooling.md +440 -440
  366. package/skills/go-rust-cpp/cpp-pro/references/concurrency.md +437 -437
  367. package/skills/go-rust-cpp/cpp-pro/references/memory-performance.md +397 -397
  368. package/skills/go-rust-cpp/cpp-pro/references/modern-cpp.md +304 -304
  369. package/skills/go-rust-cpp/cpp-pro/references/templates.md +357 -357
  370. package/skills/go-rust-cpp/golang-pro/SKILL.md +122 -122
  371. package/skills/go-rust-cpp/golang-pro/references/concurrency.md +329 -329
  372. package/skills/go-rust-cpp/golang-pro/references/generics.md +442 -442
  373. package/skills/go-rust-cpp/golang-pro/references/interfaces.md +432 -432
  374. package/skills/go-rust-cpp/golang-pro/references/project-structure.md +477 -477
  375. package/skills/go-rust-cpp/golang-pro/references/testing.md +451 -451
  376. package/skills/go-rust-cpp/rust-engineer/SKILL.md +167 -167
  377. package/skills/go-rust-cpp/rust-engineer/references/async.md +458 -458
  378. package/skills/go-rust-cpp/rust-engineer/references/error-handling.md +334 -334
  379. package/skills/go-rust-cpp/rust-engineer/references/ownership.md +278 -278
  380. package/skills/go-rust-cpp/rust-engineer/references/testing.md +470 -470
  381. package/skills/go-rust-cpp/rust-engineer/references/traits.md +413 -413
  382. package/skills/infra/cli-developer/SKILL.md +113 -113
  383. package/skills/infra/cli-developer/references/design-patterns.md +221 -221
  384. package/skills/infra/cli-developer/references/go-cli.md +540 -540
  385. package/skills/infra/cli-developer/references/node-cli.md +383 -383
  386. package/skills/infra/cli-developer/references/python-cli.md +422 -422
  387. package/skills/infra/cli-developer/references/ux-patterns.md +448 -448
  388. package/skills/infra/cloud-architect/SKILL.md +216 -216
  389. package/skills/infra/cloud-architect/references/aws.md +394 -394
  390. package/skills/infra/cloud-architect/references/azure.md +562 -562
  391. package/skills/infra/cloud-architect/references/cost.md +582 -582
  392. package/skills/infra/cloud-architect/references/gcp.md +633 -633
  393. package/skills/infra/cloud-architect/references/multi-cloud.md +483 -483
  394. package/skills/infra/devops-engineer/SKILL.md +144 -144
  395. package/skills/infra/devops-engineer/references/deployment-strategies.md +241 -241
  396. package/skills/infra/devops-engineer/references/docker-patterns.md +113 -113
  397. package/skills/infra/devops-engineer/references/github-actions.md +139 -139
  398. package/skills/infra/devops-engineer/references/incident-response.md +331 -331
  399. package/skills/infra/devops-engineer/references/kubernetes.md +154 -154
  400. package/skills/infra/devops-engineer/references/platform-engineering.md +417 -417
  401. package/skills/infra/devops-engineer/references/release-automation.md +527 -527
  402. package/skills/infra/devops-engineer/references/terraform-iac.md +141 -141
  403. package/skills/infra/kubernetes-specialist/SKILL.md +241 -241
  404. package/skills/infra/kubernetes-specialist/references/configuration.md +452 -452
  405. package/skills/infra/kubernetes-specialist/references/cost-optimization.md +458 -458
  406. package/skills/infra/kubernetes-specialist/references/custom-operators.md +563 -563
  407. package/skills/infra/kubernetes-specialist/references/gitops.md +530 -530
  408. package/skills/infra/kubernetes-specialist/references/helm-charts.md +912 -912
  409. package/skills/infra/kubernetes-specialist/references/multi-cluster.md +507 -507
  410. package/skills/infra/kubernetes-specialist/references/networking.md +447 -447
  411. package/skills/infra/kubernetes-specialist/references/service-mesh.md +459 -459
  412. package/skills/infra/kubernetes-specialist/references/storage.md +535 -535
  413. package/skills/infra/kubernetes-specialist/references/troubleshooting.md +414 -414
  414. package/skills/infra/kubernetes-specialist/references/workloads.md +377 -377
  415. package/skills/infra/mcp-developer/SKILL.md +143 -143
  416. package/skills/infra/mcp-developer/references/protocol.md +244 -244
  417. package/skills/infra/mcp-developer/references/python-sdk.md +367 -367
  418. package/skills/infra/mcp-developer/references/resources.md +554 -554
  419. package/skills/infra/mcp-developer/references/tools.md +480 -480
  420. package/skills/infra/mcp-developer/references/typescript-sdk.md +350 -350
  421. package/skills/infra/monitoring-expert/SKILL.md +176 -176
  422. package/skills/infra/monitoring-expert/references/alerting-rules.md +141 -141
  423. package/skills/infra/monitoring-expert/references/application-profiling.md +331 -331
  424. package/skills/infra/monitoring-expert/references/capacity-planning.md +344 -344
  425. package/skills/infra/monitoring-expert/references/dashboards.md +126 -126
  426. package/skills/infra/monitoring-expert/references/opentelemetry.md +123 -123
  427. package/skills/infra/monitoring-expert/references/performance-testing.md +269 -269
  428. package/skills/infra/monitoring-expert/references/prometheus-metrics.md +136 -136
  429. package/skills/infra/monitoring-expert/references/structured-logging.md +142 -142
  430. package/skills/infra/sre-engineer/SKILL.md +181 -181
  431. package/skills/infra/sre-engineer/references/automation-toil.md +492 -492
  432. package/skills/infra/sre-engineer/references/error-budget-policy.md +334 -334
  433. package/skills/infra/sre-engineer/references/incident-chaos.md +576 -576
  434. package/skills/infra/sre-engineer/references/monitoring-alerting.md +424 -424
  435. package/skills/infra/sre-engineer/references/slo-sli-management.md +238 -238
  436. package/skills/infra/terraform-engineer/SKILL.md +143 -143
  437. package/skills/infra/terraform-engineer/references/best-practices.md +583 -583
  438. package/skills/infra/terraform-engineer/references/module-patterns.md +297 -297
  439. package/skills/infra/terraform-engineer/references/providers.md +452 -452
  440. package/skills/infra/terraform-engineer/references/state-management.md +371 -371
  441. package/skills/infra/terraform-engineer/references/testing.md +486 -486
  442. package/skills/infra/websocket-engineer/SKILL.md +168 -168
  443. package/skills/infra/websocket-engineer/references/alternatives.md +391 -391
  444. package/skills/infra/websocket-engineer/references/patterns.md +400 -400
  445. package/skills/infra/websocket-engineer/references/protocol.md +195 -195
  446. package/skills/infra/websocket-engineer/references/scaling.md +333 -333
  447. package/skills/infra/websocket-engineer/references/security.md +474 -474
  448. package/skills/java/java-architect/SKILL.md +132 -132
  449. package/skills/java/java-architect/references/jpa-optimization.md +393 -393
  450. package/skills/java/java-architect/references/reactive-webflux.md +356 -356
  451. package/skills/java/java-architect/references/spring-boot-setup.md +269 -269
  452. package/skills/java/java-architect/references/spring-security.md +445 -445
  453. package/skills/java/java-architect/references/testing-patterns.md +500 -500
  454. package/skills/java/kotlin-specialist/SKILL.md +147 -147
  455. package/skills/java/kotlin-specialist/references/android-compose.md +419 -419
  456. package/skills/java/kotlin-specialist/references/coroutines-flow.md +276 -276
  457. package/skills/java/kotlin-specialist/references/dsl-idioms.md +421 -421
  458. package/skills/java/kotlin-specialist/references/ktor-server.md +426 -426
  459. package/skills/java/kotlin-specialist/references/multiplatform-kmp.md +380 -380
  460. package/skills/java/spring-boot-engineer/SKILL.md +196 -195
  461. package/skills/java/spring-boot-engineer/references/cloud.md +498 -498
  462. package/skills/java/spring-boot-engineer/references/data.md +381 -381
  463. package/skills/java/spring-boot-engineer/references/mybatis-plus.md +592 -0
  464. package/skills/java/spring-boot-engineer/references/security.md +459 -459
  465. package/skills/java/spring-boot-engineer/references/testing.md +545 -545
  466. package/skills/java/spring-boot-engineer/references/web.md +295 -295
  467. package/skills/java/spring-boot-engineer_zn/SKILL.md +129 -0
  468. package/skills/java/spring-boot-engineer_zn/references/architecture.md +23 -0
  469. package/skills/java/spring-boot-engineer_zn/references/concurrency.md +9 -0
  470. package/skills/java/spring-boot-engineer_zn/references/exception-logging.md +31 -0
  471. package/skills/java/spring-boot-engineer_zn/references/persistence.md +13 -0
  472. package/skills/java/spring-boot-engineer_zn/references/pojo-lombok.md +48 -0
  473. package/skills/java/spring-boot-engineer_zn/references/security.md +9 -0
  474. package/skills/java/spring-boot-engineer_zn/references/testing.md +7 -0
  475. package/skills/java/spring-boot-engineer_zn/references/validation.md +80 -0
  476. package/skills/javascript/javascript-pro/SKILL.md +132 -132
  477. package/skills/javascript/javascript-pro/references/async-patterns.md +334 -334
  478. package/skills/javascript/javascript-pro/references/browser-apis.md +398 -398
  479. package/skills/javascript/javascript-pro/references/modern-syntax.md +272 -272
  480. package/skills/javascript/javascript-pro/references/modules.md +357 -357
  481. package/skills/javascript/javascript-pro/references/node-essentials.md +471 -471
  482. package/skills/javascript/nestjs-expert/SKILL.md +206 -206
  483. package/skills/javascript/nestjs-expert/references/authentication.md +166 -166
  484. package/skills/javascript/nestjs-expert/references/controllers-routing.md +111 -111
  485. package/skills/javascript/nestjs-expert/references/dtos-validation.md +153 -153
  486. package/skills/javascript/nestjs-expert/references/migration-from-express.md +1237 -1237
  487. package/skills/javascript/nestjs-expert/references/services-di.md +140 -140
  488. package/skills/javascript/nestjs-expert/references/testing-patterns.md +186 -186
  489. package/skills/javascript/typescript-pro/SKILL.md +145 -145
  490. package/skills/javascript/typescript-pro/references/advanced-types.md +259 -259
  491. package/skills/javascript/typescript-pro/references/configuration.md +445 -445
  492. package/skills/javascript/typescript-pro/references/patterns.md +484 -484
  493. package/skills/javascript/typescript-pro/references/type-guards.md +352 -352
  494. package/skills/javascript/typescript-pro/references/utility-types.md +329 -329
  495. package/skills/php/laravel-specialist/SKILL.md +262 -262
  496. package/skills/php/laravel-specialist/references/eloquent.md +351 -351
  497. package/skills/php/laravel-specialist/references/livewire.md +512 -512
  498. package/skills/php/laravel-specialist/references/queues.md +423 -423
  499. package/skills/php/laravel-specialist/references/routing.md +362 -362
  500. package/skills/php/laravel-specialist/references/testing.md +522 -522
  501. package/skills/php/php-pro/SKILL.md +206 -206
  502. package/skills/php/php-pro/references/async-patterns.md +412 -412
  503. package/skills/php/php-pro/references/laravel-patterns.md +377 -377
  504. package/skills/php/php-pro/references/modern-php-features.md +323 -323
  505. package/skills/php/php-pro/references/symfony-patterns.md +466 -466
  506. package/skills/php/php-pro/references/testing-quality.md +466 -466
  507. package/skills/product/competitive-analysis/SKILL.md +257 -257
  508. package/skills/product/meeting-notes/SKILL.md +266 -266
  509. package/skills/product/prd-template/SKILL.md +150 -150
  510. package/skills/product/stakeholder-update/SKILL.md +225 -225
  511. package/skills/product/user-research-synthesis/SKILL.md +235 -235
  512. package/skills/python/django-expert/SKILL.md +162 -162
  513. package/skills/python/django-expert/references/authentication.md +145 -145
  514. package/skills/python/django-expert/references/drf-serializers.md +148 -148
  515. package/skills/python/django-expert/references/models-orm.md +151 -151
  516. package/skills/python/django-expert/references/testing-django.md +204 -204
  517. package/skills/python/django-expert/references/viewsets-views.md +153 -153
  518. package/skills/python/fastapi-expert/SKILL.md +185 -185
  519. package/skills/python/fastapi-expert/references/async-sqlalchemy.md +146 -146
  520. package/skills/python/fastapi-expert/references/authentication.md +159 -159
  521. package/skills/python/fastapi-expert/references/endpoints-routing.md +142 -142
  522. package/skills/python/fastapi-expert/references/migration-from-django.md +996 -996
  523. package/skills/python/fastapi-expert/references/pydantic-v2.md +135 -135
  524. package/skills/python/fastapi-expert/references/testing-async.md +159 -159
  525. package/skills/python/pandas-pro/SKILL.md +178 -178
  526. package/skills/python/pandas-pro/references/aggregation-groupby.md +545 -545
  527. package/skills/python/pandas-pro/references/data-cleaning.md +500 -500
  528. package/skills/python/pandas-pro/references/dataframe-operations.md +420 -420
  529. package/skills/python/pandas-pro/references/merging-joining.md +596 -596
  530. package/skills/python/pandas-pro/references/performance-optimization.md +597 -597
  531. package/skills/python/python-pro/SKILL.md +177 -177
  532. package/skills/python/python-pro/references/async-patterns.md +356 -356
  533. package/skills/python/python-pro/references/packaging.md +460 -460
  534. package/skills/python/python-pro/references/standard-library.md +378 -378
  535. package/skills/python/python-pro/references/testing.md +404 -404
  536. package/skills/python/python-pro/references/type-system.md +290 -290
  537. package/skills/quality/chaos-engineer/SKILL.md +182 -182
  538. package/skills/quality/chaos-engineer/references/chaos-tools.md +511 -511
  539. package/skills/quality/chaos-engineer/references/experiment-design.md +229 -229
  540. package/skills/quality/chaos-engineer/references/game-days.md +434 -434
  541. package/skills/quality/chaos-engineer/references/infrastructure-chaos.md +348 -348
  542. package/skills/quality/chaos-engineer/references/kubernetes-chaos.md +432 -432
  543. package/skills/quality/code-reviewer/SKILL.md +119 -119
  544. package/skills/quality/code-reviewer/references/common-issues.md +142 -142
  545. package/skills/quality/code-reviewer/references/feedback-examples.md +144 -144
  546. package/skills/quality/code-reviewer/references/receiving-feedback.md +238 -238
  547. package/skills/quality/code-reviewer/references/report-template.md +109 -109
  548. package/skills/quality/code-reviewer/references/review-checklist.md +88 -88
  549. package/skills/quality/code-reviewer/references/spec-compliance-review.md +258 -258
  550. package/skills/quality/playwright-expert/SKILL.md +169 -169
  551. package/skills/quality/playwright-expert/references/api-mocking.md +140 -140
  552. package/skills/quality/playwright-expert/references/configuration.md +155 -155
  553. package/skills/quality/playwright-expert/references/debugging-flaky.md +150 -150
  554. package/skills/quality/playwright-expert/references/page-object-model.md +152 -152
  555. package/skills/quality/playwright-expert/references/selectors-locators.md +119 -119
  556. package/skills/quality/secure-code-guardian/SKILL.md +191 -191
  557. package/skills/quality/secure-code-guardian/references/authentication.md +136 -136
  558. package/skills/quality/secure-code-guardian/references/input-validation.md +146 -146
  559. package/skills/quality/secure-code-guardian/references/owasp-prevention.md +135 -135
  560. package/skills/quality/secure-code-guardian/references/security-headers.md +133 -133
  561. package/skills/quality/secure-code-guardian/references/xss-csrf.md +157 -157
  562. package/skills/quality/security-reviewer/SKILL.md +103 -103
  563. package/skills/quality/security-reviewer/references/infrastructure-security.md +268 -268
  564. package/skills/quality/security-reviewer/references/penetration-testing.md +268 -268
  565. package/skills/quality/security-reviewer/references/report-template.md +170 -170
  566. package/skills/quality/security-reviewer/references/sast-tools.md +117 -117
  567. package/skills/quality/security-reviewer/references/secret-scanning.md +125 -125
  568. package/skills/quality/security-reviewer/references/vulnerability-patterns.md +152 -152
  569. package/skills/quality/senior-qa/README.md +196 -196
  570. package/skills/quality/senior-qa/SKILL.md +399 -399
  571. package/skills/quality/senior-qa/references/qa_best_practices.md +964 -964
  572. package/skills/quality/senior-qa/references/test_automation_patterns.md +1009 -1009
  573. package/skills/quality/senior-qa/references/testing_strategies.md +649 -649
  574. package/skills/quality/senior-qa/scripts/coverage_analyzer.py +836 -836
  575. package/skills/quality/senior-qa/scripts/e2e_test_scaffolder.py +820 -820
  576. package/skills/quality/senior-qa/scripts/test_suite_generator.py +605 -605
  577. package/skills/quality/tdd-guide/HOW_TO_USE.md +313 -313
  578. package/skills/quality/tdd-guide/README.md +680 -680
  579. package/skills/quality/tdd-guide/SKILL.md +122 -122
  580. package/skills/quality/tdd-guide/assets/expected_output.json +77 -77
  581. package/skills/quality/tdd-guide/assets/sample_input_python.json +39 -39
  582. package/skills/quality/tdd-guide/assets/sample_input_typescript.json +36 -36
  583. package/skills/quality/tdd-guide/references/ci-integration.md +195 -195
  584. package/skills/quality/tdd-guide/references/framework-guide.md +206 -206
  585. package/skills/quality/tdd-guide/references/tdd-best-practices.md +128 -128
  586. package/skills/quality/tdd-guide/scripts/coverage_analyzer.py +434 -434
  587. package/skills/quality/tdd-guide/scripts/fixture_generator.py +440 -440
  588. package/skills/quality/tdd-guide/scripts/format_detector.py +384 -384
  589. package/skills/quality/tdd-guide/scripts/framework_adapter.py +428 -428
  590. package/skills/quality/tdd-guide/scripts/metrics_calculator.py +456 -456
  591. package/skills/quality/tdd-guide/scripts/output_formatter.py +354 -354
  592. package/skills/quality/tdd-guide/scripts/tdd_workflow.py +474 -474
  593. package/skills/quality/tdd-guide/scripts/test_generator.py +438 -438
  594. package/skills/quality/test-master/SKILL.md +94 -94
  595. package/skills/quality/test-master/references/automation-frameworks.md +294 -294
  596. package/skills/quality/test-master/references/e2e-testing.md +128 -128
  597. package/skills/quality/test-master/references/integration-testing.md +120 -120
  598. package/skills/quality/test-master/references/performance-testing.md +118 -118
  599. package/skills/quality/test-master/references/qa-methodology.md +247 -247
  600. package/skills/quality/test-master/references/security-testing.md +127 -127
  601. package/skills/quality/test-master/references/tdd-iron-laws.md +174 -174
  602. package/skills/quality/test-master/references/test-reports.md +104 -104
  603. package/skills/quality/test-master/references/testing-anti-patterns.md +231 -231
  604. package/skills/quality/test-master/references/unit-testing.md +113 -113
  605. package/skills/ruby/rails-expert/SKILL.md +154 -154
  606. package/skills/ruby/rails-expert/references/active-record.md +244 -244
  607. package/skills/ruby/rails-expert/references/api-development.md +401 -401
  608. package/skills/ruby/rails-expert/references/background-jobs.md +272 -272
  609. package/skills/ruby/rails-expert/references/hotwire-turbo.md +228 -228
  610. package/skills/ruby/rails-expert/references/rspec-testing.md +367 -367
  611. package/skills/swift/swift-expert/SKILL.md +163 -163
  612. package/skills/swift/swift-expert/references/async-concurrency.md +360 -360
  613. package/skills/swift/swift-expert/references/memory-performance.md +377 -377
  614. package/skills/swift/swift-expert/references/protocol-oriented.md +354 -354
  615. package/skills/swift/swift-expert/references/swiftui-patterns.md +291 -291
  616. package/skills/swift/swift-expert/references/testing-patterns.md +399 -399
  617. package/skills/workflow/brainstorming/SKILL.md +164 -164
  618. package/skills/workflow/brainstorming/scripts/frame-template.html +214 -214
  619. package/skills/workflow/brainstorming/scripts/helper.js +88 -88
  620. package/skills/workflow/brainstorming/scripts/server.cjs +354 -354
  621. package/skills/workflow/brainstorming/scripts/start-server.sh +148 -148
  622. package/skills/workflow/brainstorming/scripts/stop-server.sh +56 -56
  623. package/skills/workflow/brainstorming/spec-document-reviewer-prompt.md +49 -49
  624. package/skills/workflow/brainstorming/visual-companion.md +287 -287
  625. package/skills/workflow/documentation/SKILL.md +45 -45
  626. package/skills/workflow/entropy-management/SKILL.md +115 -115
  627. package/skills/workflow/executing-plans/SKILL.md +70 -70
  628. package/skills/workflow/finishing-a-development-branch/SKILL.md +200 -200
  629. package/skills/workflow/receiving-code-review/SKILL.md +213 -213
  630. package/skills/workflow/requesting-code-review/SKILL.md +105 -105
  631. package/skills/workflow/requesting-code-review/code-reviewer.md +146 -146
  632. package/skills/workflow/requirement-engineering/SKILL.md +111 -111
  633. package/skills/workflow/systematic-debugging/CREATION-LOG.md +119 -119
  634. package/skills/workflow/systematic-debugging/SKILL.md +296 -296
  635. package/skills/workflow/systematic-debugging/condition-based-waiting-example.ts +158 -158
  636. package/skills/workflow/systematic-debugging/condition-based-waiting.md +115 -115
  637. package/skills/workflow/systematic-debugging/defense-in-depth.md +122 -122
  638. package/skills/workflow/systematic-debugging/find-polluter.sh +63 -63
  639. package/skills/workflow/systematic-debugging/root-cause-tracing.md +169 -169
  640. package/skills/workflow/systematic-debugging/test-academic.md +14 -14
  641. package/skills/workflow/systematic-debugging/test-pressure-1.md +58 -58
  642. package/skills/workflow/systematic-debugging/test-pressure-2.md +68 -68
  643. package/skills/workflow/systematic-debugging/test-pressure-3.md +69 -69
  644. package/skills/workflow/using-git-worktrees/SKILL.md +218 -218
  645. package/skills/workflow/verification-before-completion/SKILL.md +139 -139
  646. package/skills/workflow/writing-plans/SKILL.md +151 -151
  647. package/skills/workflow/writing-plans/plan-document-reviewer-prompt.md +49 -49
  648. package/skills/workflow/writing-skills/SKILL.md +655 -655
  649. package/skills/workflow/writing-skills/anthropic-best-practices.md +1150 -1150
  650. package/skills/workflow/writing-skills/examples/CLAUDE_MD_TESTING.md +189 -189
  651. package/skills/workflow/writing-skills/persuasion-principles.md +187 -187
  652. package/skills/workflow/writing-skills/render-graphs.js +168 -168
  653. package/skills/workflow/writing-skills/testing-skills-with-subagents.md +384 -384
@@ -1,563 +1,563 @@
1
- # Custom Operators
2
-
3
- ---
4
-
5
- ## CustomResourceDefinition (CRD)
6
-
7
- ```yaml
8
- apiVersion: apiextensions.k8s.io/v1
9
- kind: CustomResourceDefinition
10
- metadata:
11
- name: databases.mycompany.io
12
- spec:
13
- group: mycompany.io
14
- names:
15
- kind: Database
16
- listKind: DatabaseList
17
- plural: databases
18
- singular: database
19
- shortNames:
20
- - db
21
- scope: Namespaced
22
- versions:
23
- - name: v1
24
- served: true
25
- storage: true
26
- schema:
27
- openAPIV3Schema:
28
- type: object
29
- required:
30
- - spec
31
- properties:
32
- spec:
33
- type: object
34
- required:
35
- - engine
36
- - version
37
- - storage
38
- properties:
39
- engine:
40
- type: string
41
- enum: [postgres, mysql, mongodb]
42
- version:
43
- type: string
44
- storage:
45
- type: string
46
- pattern: '^[0-9]+Gi$'
47
- replicas:
48
- type: integer
49
- minimum: 1
50
- maximum: 5
51
- default: 1
52
- status:
53
- type: object
54
- properties:
55
- phase:
56
- type: string
57
- enum: [Pending, Creating, Running, Failed, Terminating]
58
- ready:
59
- type: boolean
60
- message:
61
- type: string
62
- endpoint:
63
- type: string
64
- subresources:
65
- status: {}
66
- scale:
67
- specReplicasPath: .spec.replicas
68
- statusReplicasPath: .status.replicas
69
- additionalPrinterColumns:
70
- - name: Engine
71
- type: string
72
- jsonPath: .spec.engine
73
- - name: Version
74
- type: string
75
- jsonPath: .spec.version
76
- - name: Status
77
- type: string
78
- jsonPath: .status.phase
79
- - name: Age
80
- type: date
81
- jsonPath: .metadata.creationTimestamp
82
- ```
83
-
84
- ## Custom Resource Instance
85
-
86
- ```yaml
87
- apiVersion: mycompany.io/v1
88
- kind: Database
89
- metadata:
90
- name: orders-db
91
- namespace: production
92
- spec:
93
- engine: postgres
94
- version: "15.4"
95
- storage: 100Gi
96
- replicas: 3
97
- ```
98
-
99
- ## Operator SDK Project Structure
100
-
101
- ```
102
- my-operator/
103
- ├── Dockerfile
104
- ├── Makefile
105
- ├── PROJECT # Kubebuilder project config
106
- ├── config/
107
- │ ├── crd/ # CRD manifests
108
- │ │ └── bases/
109
- │ │ └── mycompany.io_databases.yaml
110
- │ ├── manager/ # Operator deployment
111
- │ │ └── manager.yaml
112
- │ ├── rbac/ # RBAC configuration
113
- │ │ ├── role.yaml
114
- │ │ ├── role_binding.yaml
115
- │ │ └── service_account.yaml
116
- │ └── samples/ # Example CRs
117
- │ └── mycompany_v1_database.yaml
118
- ├── api/
119
- │ └── v1/
120
- │ ├── database_types.go # API type definitions
121
- │ ├── groupversion_info.go
122
- │ └── zz_generated.deepcopy.go
123
- ├── controllers/
124
- │ └── database_controller.go # Reconciliation logic
125
- ├── main.go # Entry point
126
- └── go.mod
127
- ```
128
-
129
- ## API Type Definition (Go)
130
-
131
- ```go
132
- // api/v1/database_types.go
133
- package v1
134
-
135
- import (
136
- metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
137
- )
138
-
139
- // DatabaseSpec defines the desired state of Database
140
- type DatabaseSpec struct {
141
- // Engine is the database engine type
142
- // +kubebuilder:validation:Enum=postgres;mysql;mongodb
143
- Engine string `json:"engine"`
144
-
145
- // Version is the database version
146
- Version string `json:"version"`
147
-
148
- // Storage is the size of persistent storage
149
- // +kubebuilder:validation:Pattern=`^[0-9]+Gi$`
150
- Storage string `json:"storage"`
151
-
152
- // Replicas is the number of database instances
153
- // +kubebuilder:validation:Minimum=1
154
- // +kubebuilder:validation:Maximum=5
155
- // +kubebuilder:default=1
156
- // +optional
157
- Replicas int32 `json:"replicas,omitempty"`
158
- }
159
-
160
- // DatabaseStatus defines the observed state of Database
161
- type DatabaseStatus struct {
162
- // Phase represents the current lifecycle phase
163
- Phase string `json:"phase,omitempty"`
164
-
165
- // Ready indicates if the database is ready to accept connections
166
- Ready bool `json:"ready,omitempty"`
167
-
168
- // Message provides additional status information
169
- Message string `json:"message,omitempty"`
170
-
171
- // Endpoint is the connection endpoint
172
- Endpoint string `json:"endpoint,omitempty"`
173
-
174
- // Replicas is the current number of running replicas
175
- Replicas int32 `json:"replicas,omitempty"`
176
- }
177
-
178
- // +kubebuilder:object:root=true
179
- // +kubebuilder:subresource:status
180
- // +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas
181
- // +kubebuilder:printcolumn:name="Engine",type=string,JSONPath=`.spec.engine`
182
- // +kubebuilder:printcolumn:name="Version",type=string,JSONPath=`.spec.version`
183
- // +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status.phase`
184
- // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
185
-
186
- // Database is the Schema for the databases API
187
- type Database struct {
188
- metav1.TypeMeta `json:",inline"`
189
- metav1.ObjectMeta `json:"metadata,omitempty"`
190
-
191
- Spec DatabaseSpec `json:"spec,omitempty"`
192
- Status DatabaseStatus `json:"status,omitempty"`
193
- }
194
-
195
- // +kubebuilder:object:root=true
196
-
197
- // DatabaseList contains a list of Database
198
- type DatabaseList struct {
199
- metav1.TypeMeta `json:",inline"`
200
- metav1.ListMeta `json:"metadata,omitempty"`
201
- Items []Database `json:"items"`
202
- }
203
-
204
- func init() {
205
- SchemeBuilder.Register(&Database{}, &DatabaseList{})
206
- }
207
- ```
208
-
209
- ## Controller Implementation
210
-
211
- ```go
212
- // controllers/database_controller.go
213
- package controllers
214
-
215
- import (
216
- "context"
217
- "fmt"
218
- "time"
219
-
220
- appsv1 "k8s.io/api/apps/v1"
221
- corev1 "k8s.io/api/core/v1"
222
- "k8s.io/apimachinery/pkg/api/errors"
223
- "k8s.io/apimachinery/pkg/api/resource"
224
- metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
225
- "k8s.io/apimachinery/pkg/runtime"
226
- "k8s.io/apimachinery/pkg/types"
227
- ctrl "sigs.k8s.io/controller-runtime"
228
- "sigs.k8s.io/controller-runtime/pkg/client"
229
- "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
230
- "sigs.k8s.io/controller-runtime/pkg/log"
231
-
232
- mycompanyv1 "github.com/mycompany/database-operator/api/v1"
233
- )
234
-
235
- const databaseFinalizer = "databases.mycompany.io/finalizer"
236
-
237
- type DatabaseReconciler struct {
238
- client.Client
239
- Scheme *runtime.Scheme
240
- }
241
-
242
- // +kubebuilder:rbac:groups=mycompany.io,resources=databases,verbs=get;list;watch;create;update;patch;delete
243
- // +kubebuilder:rbac:groups=mycompany.io,resources=databases/status,verbs=get;update;patch
244
- // +kubebuilder:rbac:groups=mycompany.io,resources=databases/finalizers,verbs=update
245
- // +kubebuilder:rbac:groups=apps,resources=statefulsets,verbs=get;list;watch;create;update;patch;delete
246
- // +kubebuilder:rbac:groups=core,resources=services,verbs=get;list;watch;create;update;patch;delete
247
- // +kubebuilder:rbac:groups=core,resources=persistentvolumeclaims,verbs=get;list;watch
248
-
249
- func (r *DatabaseReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
250
- logger := log.FromContext(ctx)
251
-
252
- // Fetch the Database instance
253
- database := &mycompanyv1.Database{}
254
- if err := r.Get(ctx, req.NamespacedName, database); err != nil {
255
- if errors.IsNotFound(err) {
256
- return ctrl.Result{}, nil
257
- }
258
- return ctrl.Result{}, err
259
- }
260
-
261
- // Handle deletion with finalizer
262
- if !database.DeletionTimestamp.IsZero() {
263
- if controllerutil.ContainsFinalizer(database, databaseFinalizer) {
264
- if err := r.cleanupResources(ctx, database); err != nil {
265
- return ctrl.Result{}, err
266
- }
267
- controllerutil.RemoveFinalizer(database, databaseFinalizer)
268
- if err := r.Update(ctx, database); err != nil {
269
- return ctrl.Result{}, err
270
- }
271
- }
272
- return ctrl.Result{}, nil
273
- }
274
-
275
- // Add finalizer if not present
276
- if !controllerutil.ContainsFinalizer(database, databaseFinalizer) {
277
- controllerutil.AddFinalizer(database, databaseFinalizer)
278
- if err := r.Update(ctx, database); err != nil {
279
- return ctrl.Result{}, err
280
- }
281
- }
282
-
283
- // Reconcile StatefulSet
284
- statefulSet := r.buildStatefulSet(database)
285
- if err := controllerutil.SetControllerReference(database, statefulSet, r.Scheme); err != nil {
286
- return ctrl.Result{}, err
287
- }
288
-
289
- found := &appsv1.StatefulSet{}
290
- err := r.Get(ctx, types.NamespacedName{Name: statefulSet.Name, Namespace: statefulSet.Namespace}, found)
291
- if err != nil && errors.IsNotFound(err) {
292
- logger.Info("Creating StatefulSet", "name", statefulSet.Name)
293
- if err := r.Create(ctx, statefulSet); err != nil {
294
- return ctrl.Result{}, err
295
- }
296
- return r.updateStatus(ctx, database, "Creating", false, "StatefulSet created")
297
- } else if err != nil {
298
- return ctrl.Result{}, err
299
- }
300
-
301
- // Reconcile Service
302
- service := r.buildService(database)
303
- if err := controllerutil.SetControllerReference(database, service, r.Scheme); err != nil {
304
- return ctrl.Result{}, err
305
- }
306
-
307
- foundSvc := &corev1.Service{}
308
- err = r.Get(ctx, types.NamespacedName{Name: service.Name, Namespace: service.Namespace}, foundSvc)
309
- if err != nil && errors.IsNotFound(err) {
310
- if err := r.Create(ctx, service); err != nil {
311
- return ctrl.Result{}, err
312
- }
313
- }
314
-
315
- // Update status based on StatefulSet state
316
- if found.Status.ReadyReplicas == *found.Spec.Replicas {
317
- return r.updateStatus(ctx, database, "Running", true,
318
- fmt.Sprintf("%d/%d replicas ready", found.Status.ReadyReplicas, *found.Spec.Replicas))
319
- }
320
-
321
- // Requeue to check status
322
- return ctrl.Result{RequeueAfter: 10 * time.Second}, nil
323
- }
324
-
325
- func (r *DatabaseReconciler) buildStatefulSet(db *mycompanyv1.Database) *appsv1.StatefulSet {
326
- replicas := db.Spec.Replicas
327
- labels := map[string]string{
328
- "app": db.Name,
329
- "controller": db.Name,
330
- }
331
-
332
- return &appsv1.StatefulSet{
333
- ObjectMeta: metav1.ObjectMeta{
334
- Name: db.Name,
335
- Namespace: db.Namespace,
336
- },
337
- Spec: appsv1.StatefulSetSpec{
338
- Replicas: &replicas,
339
- Selector: &metav1.LabelSelector{
340
- MatchLabels: labels,
341
- },
342
- ServiceName: db.Name,
343
- Template: corev1.PodTemplateSpec{
344
- ObjectMeta: metav1.ObjectMeta{
345
- Labels: labels,
346
- },
347
- Spec: corev1.PodSpec{
348
- Containers: []corev1.Container{{
349
- Name: "database",
350
- Image: fmt.Sprintf("%s:%s", db.Spec.Engine, db.Spec.Version),
351
- Ports: []corev1.ContainerPort{{
352
- ContainerPort: 5432,
353
- Name: "db",
354
- }},
355
- }},
356
- },
357
- },
358
- VolumeClaimTemplates: []corev1.PersistentVolumeClaim{{
359
- ObjectMeta: metav1.ObjectMeta{
360
- Name: "data",
361
- },
362
- Spec: corev1.PersistentVolumeClaimSpec{
363
- AccessModes: []corev1.PersistentVolumeAccessMode{
364
- corev1.ReadWriteOnce,
365
- },
366
- Resources: corev1.VolumeResourceRequirements{
367
- Requests: corev1.ResourceList{
368
- corev1.ResourceStorage: resource.MustParse(db.Spec.Storage),
369
- },
370
- },
371
- },
372
- }},
373
- },
374
- }
375
- }
376
-
377
- func (r *DatabaseReconciler) buildService(db *mycompanyv1.Database) *corev1.Service {
378
- return &corev1.Service{
379
- ObjectMeta: metav1.ObjectMeta{
380
- Name: db.Name,
381
- Namespace: db.Namespace,
382
- },
383
- Spec: corev1.ServiceSpec{
384
- Selector: map[string]string{"app": db.Name},
385
- Ports: []corev1.ServicePort{{
386
- Port: 5432,
387
- Name: "db",
388
- }},
389
- ClusterIP: "None", // Headless service for StatefulSet
390
- },
391
- }
392
- }
393
-
394
- func (r *DatabaseReconciler) updateStatus(ctx context.Context, db *mycompanyv1.Database,
395
- phase string, ready bool, message string) (ctrl.Result, error) {
396
- db.Status.Phase = phase
397
- db.Status.Ready = ready
398
- db.Status.Message = message
399
- db.Status.Endpoint = fmt.Sprintf("%s.%s.svc.cluster.local:5432", db.Name, db.Namespace)
400
- return ctrl.Result{}, r.Status().Update(ctx, db)
401
- }
402
-
403
- func (r *DatabaseReconciler) cleanupResources(ctx context.Context, db *mycompanyv1.Database) error {
404
- // Custom cleanup logic (e.g., backup before deletion)
405
- return nil
406
- }
407
-
408
- func (r *DatabaseReconciler) SetupWithManager(mgr ctrl.Manager) error {
409
- return ctrl.NewControllerManagedBy(mgr).
410
- For(&mycompanyv1.Database{}).
411
- Owns(&appsv1.StatefulSet{}).
412
- Owns(&corev1.Service{}).
413
- Complete(r)
414
- }
415
- ```
416
-
417
- ## Operator RBAC
418
-
419
- ```yaml
420
- apiVersion: v1
421
- kind: ServiceAccount
422
- metadata:
423
- name: database-operator
424
- namespace: operators
425
- ---
426
- apiVersion: rbac.authorization.k8s.io/v1
427
- kind: ClusterRole
428
- metadata:
429
- name: database-operator-role
430
- rules:
431
- - apiGroups: ["mycompany.io"]
432
- resources: ["databases"]
433
- verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
434
- - apiGroups: ["mycompany.io"]
435
- resources: ["databases/status"]
436
- verbs: ["get", "update", "patch"]
437
- - apiGroups: ["mycompany.io"]
438
- resources: ["databases/finalizers"]
439
- verbs: ["update"]
440
- - apiGroups: ["apps"]
441
- resources: ["statefulsets"]
442
- verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
443
- - apiGroups: [""]
444
- resources: ["services", "configmaps", "secrets"]
445
- verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
446
- - apiGroups: [""]
447
- resources: ["persistentvolumeclaims"]
448
- verbs: ["get", "list", "watch"]
449
- - apiGroups: [""]
450
- resources: ["events"]
451
- verbs: ["create", "patch"]
452
- ---
453
- apiVersion: rbac.authorization.k8s.io/v1
454
- kind: ClusterRoleBinding
455
- metadata:
456
- name: database-operator-rolebinding
457
- roleRef:
458
- apiGroup: rbac.authorization.k8s.io
459
- kind: ClusterRole
460
- name: database-operator-role
461
- subjects:
462
- - kind: ServiceAccount
463
- name: database-operator
464
- namespace: operators
465
- ```
466
-
467
- ## Operator Deployment
468
-
469
- ```yaml
470
- apiVersion: apps/v1
471
- kind: Deployment
472
- metadata:
473
- name: database-operator
474
- namespace: operators
475
- labels:
476
- app: database-operator
477
- spec:
478
- replicas: 1
479
- selector:
480
- matchLabels:
481
- app: database-operator
482
- template:
483
- metadata:
484
- labels:
485
- app: database-operator
486
- spec:
487
- serviceAccountName: database-operator
488
- securityContext:
489
- runAsNonRoot: true
490
- seccompProfile:
491
- type: RuntimeDefault
492
- containers:
493
- - name: manager
494
- image: myregistry.io/database-operator:v1.0.0
495
- args:
496
- - --leader-elect
497
- - --health-probe-bind-address=:8081
498
- securityContext:
499
- allowPrivilegeEscalation: false
500
- capabilities:
501
- drop: ["ALL"]
502
- readOnlyRootFilesystem: true
503
- ports:
504
- - containerPort: 8080
505
- name: metrics
506
- livenessProbe:
507
- httpGet:
508
- path: /healthz
509
- port: 8081
510
- initialDelaySeconds: 15
511
- periodSeconds: 20
512
- readinessProbe:
513
- httpGet:
514
- path: /readyz
515
- port: 8081
516
- initialDelaySeconds: 5
517
- periodSeconds: 10
518
- resources:
519
- limits:
520
- cpu: 500m
521
- memory: 128Mi
522
- requests:
523
- cpu: 10m
524
- memory: 64Mi
525
- ```
526
-
527
- ## Operator SDK Commands
528
-
529
- ```bash
530
- # Initialize new operator project
531
- operator-sdk init --domain mycompany.io --repo github.com/mycompany/database-operator
532
-
533
- # Create new API (CRD + controller)
534
- operator-sdk create api --group mycompany --version v1 --kind Database --resource --controller
535
-
536
- # Generate manifests (CRD, RBAC)
537
- make manifests
538
-
539
- # Generate deep copy methods
540
- make generate
541
-
542
- # Build operator image
543
- make docker-build docker-push IMG=myregistry.io/database-operator:v1.0.0
544
-
545
- # Deploy to cluster
546
- make deploy IMG=myregistry.io/database-operator:v1.0.0
547
-
548
- # Undeploy
549
- make undeploy
550
- ```
551
-
552
- ## Best Practices
553
-
554
- 1. **Use finalizers** for cleanup of external resources before CR deletion
555
- 2. **Set owner references** so owned resources are garbage collected with the CR
556
- 3. **Implement idempotent reconciliation** - same input should produce same output
557
- 4. **Use status subresource** to separate desired state (spec) from observed state (status)
558
- 5. **Add validation** via OpenAPI schema or webhooks
559
- 6. **Emit events** for significant state changes
560
- 7. **Use leader election** for high availability
561
- 8. **Set resource limits** on the operator deployment
562
- 9. **Follow least privilege** RBAC principles
563
- 10. **Test with envtest** for unit testing controllers
1
+ # Custom Operators
2
+
3
+ ---
4
+
5
+ ## CustomResourceDefinition (CRD)
6
+
7
+ ```yaml
8
+ apiVersion: apiextensions.k8s.io/v1
9
+ kind: CustomResourceDefinition
10
+ metadata:
11
+ name: databases.mycompany.io
12
+ spec:
13
+ group: mycompany.io
14
+ names:
15
+ kind: Database
16
+ listKind: DatabaseList
17
+ plural: databases
18
+ singular: database
19
+ shortNames:
20
+ - db
21
+ scope: Namespaced
22
+ versions:
23
+ - name: v1
24
+ served: true
25
+ storage: true
26
+ schema:
27
+ openAPIV3Schema:
28
+ type: object
29
+ required:
30
+ - spec
31
+ properties:
32
+ spec:
33
+ type: object
34
+ required:
35
+ - engine
36
+ - version
37
+ - storage
38
+ properties:
39
+ engine:
40
+ type: string
41
+ enum: [postgres, mysql, mongodb]
42
+ version:
43
+ type: string
44
+ storage:
45
+ type: string
46
+ pattern: '^[0-9]+Gi$'
47
+ replicas:
48
+ type: integer
49
+ minimum: 1
50
+ maximum: 5
51
+ default: 1
52
+ status:
53
+ type: object
54
+ properties:
55
+ phase:
56
+ type: string
57
+ enum: [Pending, Creating, Running, Failed, Terminating]
58
+ ready:
59
+ type: boolean
60
+ message:
61
+ type: string
62
+ endpoint:
63
+ type: string
64
+ subresources:
65
+ status: {}
66
+ scale:
67
+ specReplicasPath: .spec.replicas
68
+ statusReplicasPath: .status.replicas
69
+ additionalPrinterColumns:
70
+ - name: Engine
71
+ type: string
72
+ jsonPath: .spec.engine
73
+ - name: Version
74
+ type: string
75
+ jsonPath: .spec.version
76
+ - name: Status
77
+ type: string
78
+ jsonPath: .status.phase
79
+ - name: Age
80
+ type: date
81
+ jsonPath: .metadata.creationTimestamp
82
+ ```
83
+
84
+ ## Custom Resource Instance
85
+
86
+ ```yaml
87
+ apiVersion: mycompany.io/v1
88
+ kind: Database
89
+ metadata:
90
+ name: orders-db
91
+ namespace: production
92
+ spec:
93
+ engine: postgres
94
+ version: "15.4"
95
+ storage: 100Gi
96
+ replicas: 3
97
+ ```
98
+
99
+ ## Operator SDK Project Structure
100
+
101
+ ```
102
+ my-operator/
103
+ ├── Dockerfile
104
+ ├── Makefile
105
+ ├── PROJECT # Kubebuilder project config
106
+ ├── config/
107
+ │ ├── crd/ # CRD manifests
108
+ │ │ └── bases/
109
+ │ │ └── mycompany.io_databases.yaml
110
+ │ ├── manager/ # Operator deployment
111
+ │ │ └── manager.yaml
112
+ │ ├── rbac/ # RBAC configuration
113
+ │ │ ├── role.yaml
114
+ │ │ ├── role_binding.yaml
115
+ │ │ └── service_account.yaml
116
+ │ └── samples/ # Example CRs
117
+ │ └── mycompany_v1_database.yaml
118
+ ├── api/
119
+ │ └── v1/
120
+ │ ├── database_types.go # API type definitions
121
+ │ ├── groupversion_info.go
122
+ │ └── zz_generated.deepcopy.go
123
+ ├── controllers/
124
+ │ └── database_controller.go # Reconciliation logic
125
+ ├── main.go # Entry point
126
+ └── go.mod
127
+ ```
128
+
129
+ ## API Type Definition (Go)
130
+
131
+ ```go
132
+ // api/v1/database_types.go
133
+ package v1
134
+
135
+ import (
136
+ metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
137
+ )
138
+
139
+ // DatabaseSpec defines the desired state of Database
140
+ type DatabaseSpec struct {
141
+ // Engine is the database engine type
142
+ // +kubebuilder:validation:Enum=postgres;mysql;mongodb
143
+ Engine string `json:"engine"`
144
+
145
+ // Version is the database version
146
+ Version string `json:"version"`
147
+
148
+ // Storage is the size of persistent storage
149
+ // +kubebuilder:validation:Pattern=`^[0-9]+Gi$`
150
+ Storage string `json:"storage"`
151
+
152
+ // Replicas is the number of database instances
153
+ // +kubebuilder:validation:Minimum=1
154
+ // +kubebuilder:validation:Maximum=5
155
+ // +kubebuilder:default=1
156
+ // +optional
157
+ Replicas int32 `json:"replicas,omitempty"`
158
+ }
159
+
160
+ // DatabaseStatus defines the observed state of Database
161
+ type DatabaseStatus struct {
162
+ // Phase represents the current lifecycle phase
163
+ Phase string `json:"phase,omitempty"`
164
+
165
+ // Ready indicates if the database is ready to accept connections
166
+ Ready bool `json:"ready,omitempty"`
167
+
168
+ // Message provides additional status information
169
+ Message string `json:"message,omitempty"`
170
+
171
+ // Endpoint is the connection endpoint
172
+ Endpoint string `json:"endpoint,omitempty"`
173
+
174
+ // Replicas is the current number of running replicas
175
+ Replicas int32 `json:"replicas,omitempty"`
176
+ }
177
+
178
+ // +kubebuilder:object:root=true
179
+ // +kubebuilder:subresource:status
180
+ // +kubebuilder:subresource:scale:specpath=.spec.replicas,statuspath=.status.replicas
181
+ // +kubebuilder:printcolumn:name="Engine",type=string,JSONPath=`.spec.engine`
182
+ // +kubebuilder:printcolumn:name="Version",type=string,JSONPath=`.spec.version`
183
+ // +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status.phase`
184
+ // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
185
+
186
+ // Database is the Schema for the databases API
187
+ type Database struct {
188
+ metav1.TypeMeta `json:",inline"`
189
+ metav1.ObjectMeta `json:"metadata,omitempty"`
190
+
191
+ Spec DatabaseSpec `json:"spec,omitempty"`
192
+ Status DatabaseStatus `json:"status,omitempty"`
193
+ }
194
+
195
+ // +kubebuilder:object:root=true
196
+
197
+ // DatabaseList contains a list of Database
198
+ type DatabaseList struct {
199
+ metav1.TypeMeta `json:",inline"`
200
+ metav1.ListMeta `json:"metadata,omitempty"`
201
+ Items []Database `json:"items"`
202
+ }
203
+
204
+ func init() {
205
+ SchemeBuilder.Register(&Database{}, &DatabaseList{})
206
+ }
207
+ ```
208
+
209
+ ## Controller Implementation
210
+
211
+ ```go
212
+ // controllers/database_controller.go
213
+ package controllers
214
+
215
+ import (
216
+ "context"
217
+ "fmt"
218
+ "time"
219
+
220
+ appsv1 "k8s.io/api/apps/v1"
221
+ corev1 "k8s.io/api/core/v1"
222
+ "k8s.io/apimachinery/pkg/api/errors"
223
+ "k8s.io/apimachinery/pkg/api/resource"
224
+ metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
225
+ "k8s.io/apimachinery/pkg/runtime"
226
+ "k8s.io/apimachinery/pkg/types"
227
+ ctrl "sigs.k8s.io/controller-runtime"
228
+ "sigs.k8s.io/controller-runtime/pkg/client"
229
+ "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
230
+ "sigs.k8s.io/controller-runtime/pkg/log"
231
+
232
+ mycompanyv1 "github.com/mycompany/database-operator/api/v1"
233
+ )
234
+
235
+ const databaseFinalizer = "databases.mycompany.io/finalizer"
236
+
237
+ type DatabaseReconciler struct {
238
+ client.Client
239
+ Scheme *runtime.Scheme
240
+ }
241
+
242
+ // +kubebuilder:rbac:groups=mycompany.io,resources=databases,verbs=get;list;watch;create;update;patch;delete
243
+ // +kubebuilder:rbac:groups=mycompany.io,resources=databases/status,verbs=get;update;patch
244
+ // +kubebuilder:rbac:groups=mycompany.io,resources=databases/finalizers,verbs=update
245
+ // +kubebuilder:rbac:groups=apps,resources=statefulsets,verbs=get;list;watch;create;update;patch;delete
246
+ // +kubebuilder:rbac:groups=core,resources=services,verbs=get;list;watch;create;update;patch;delete
247
+ // +kubebuilder:rbac:groups=core,resources=persistentvolumeclaims,verbs=get;list;watch
248
+
249
+ func (r *DatabaseReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
250
+ logger := log.FromContext(ctx)
251
+
252
+ // Fetch the Database instance
253
+ database := &mycompanyv1.Database{}
254
+ if err := r.Get(ctx, req.NamespacedName, database); err != nil {
255
+ if errors.IsNotFound(err) {
256
+ return ctrl.Result{}, nil
257
+ }
258
+ return ctrl.Result{}, err
259
+ }
260
+
261
+ // Handle deletion with finalizer
262
+ if !database.DeletionTimestamp.IsZero() {
263
+ if controllerutil.ContainsFinalizer(database, databaseFinalizer) {
264
+ if err := r.cleanupResources(ctx, database); err != nil {
265
+ return ctrl.Result{}, err
266
+ }
267
+ controllerutil.RemoveFinalizer(database, databaseFinalizer)
268
+ if err := r.Update(ctx, database); err != nil {
269
+ return ctrl.Result{}, err
270
+ }
271
+ }
272
+ return ctrl.Result{}, nil
273
+ }
274
+
275
+ // Add finalizer if not present
276
+ if !controllerutil.ContainsFinalizer(database, databaseFinalizer) {
277
+ controllerutil.AddFinalizer(database, databaseFinalizer)
278
+ if err := r.Update(ctx, database); err != nil {
279
+ return ctrl.Result{}, err
280
+ }
281
+ }
282
+
283
+ // Reconcile StatefulSet
284
+ statefulSet := r.buildStatefulSet(database)
285
+ if err := controllerutil.SetControllerReference(database, statefulSet, r.Scheme); err != nil {
286
+ return ctrl.Result{}, err
287
+ }
288
+
289
+ found := &appsv1.StatefulSet{}
290
+ err := r.Get(ctx, types.NamespacedName{Name: statefulSet.Name, Namespace: statefulSet.Namespace}, found)
291
+ if err != nil && errors.IsNotFound(err) {
292
+ logger.Info("Creating StatefulSet", "name", statefulSet.Name)
293
+ if err := r.Create(ctx, statefulSet); err != nil {
294
+ return ctrl.Result{}, err
295
+ }
296
+ return r.updateStatus(ctx, database, "Creating", false, "StatefulSet created")
297
+ } else if err != nil {
298
+ return ctrl.Result{}, err
299
+ }
300
+
301
+ // Reconcile Service
302
+ service := r.buildService(database)
303
+ if err := controllerutil.SetControllerReference(database, service, r.Scheme); err != nil {
304
+ return ctrl.Result{}, err
305
+ }
306
+
307
+ foundSvc := &corev1.Service{}
308
+ err = r.Get(ctx, types.NamespacedName{Name: service.Name, Namespace: service.Namespace}, foundSvc)
309
+ if err != nil && errors.IsNotFound(err) {
310
+ if err := r.Create(ctx, service); err != nil {
311
+ return ctrl.Result{}, err
312
+ }
313
+ }
314
+
315
+ // Update status based on StatefulSet state
316
+ if found.Status.ReadyReplicas == *found.Spec.Replicas {
317
+ return r.updateStatus(ctx, database, "Running", true,
318
+ fmt.Sprintf("%d/%d replicas ready", found.Status.ReadyReplicas, *found.Spec.Replicas))
319
+ }
320
+
321
+ // Requeue to check status
322
+ return ctrl.Result{RequeueAfter: 10 * time.Second}, nil
323
+ }
324
+
325
+ func (r *DatabaseReconciler) buildStatefulSet(db *mycompanyv1.Database) *appsv1.StatefulSet {
326
+ replicas := db.Spec.Replicas
327
+ labels := map[string]string{
328
+ "app": db.Name,
329
+ "controller": db.Name,
330
+ }
331
+
332
+ return &appsv1.StatefulSet{
333
+ ObjectMeta: metav1.ObjectMeta{
334
+ Name: db.Name,
335
+ Namespace: db.Namespace,
336
+ },
337
+ Spec: appsv1.StatefulSetSpec{
338
+ Replicas: &replicas,
339
+ Selector: &metav1.LabelSelector{
340
+ MatchLabels: labels,
341
+ },
342
+ ServiceName: db.Name,
343
+ Template: corev1.PodTemplateSpec{
344
+ ObjectMeta: metav1.ObjectMeta{
345
+ Labels: labels,
346
+ },
347
+ Spec: corev1.PodSpec{
348
+ Containers: []corev1.Container{{
349
+ Name: "database",
350
+ Image: fmt.Sprintf("%s:%s", db.Spec.Engine, db.Spec.Version),
351
+ Ports: []corev1.ContainerPort{{
352
+ ContainerPort: 5432,
353
+ Name: "db",
354
+ }},
355
+ }},
356
+ },
357
+ },
358
+ VolumeClaimTemplates: []corev1.PersistentVolumeClaim{{
359
+ ObjectMeta: metav1.ObjectMeta{
360
+ Name: "data",
361
+ },
362
+ Spec: corev1.PersistentVolumeClaimSpec{
363
+ AccessModes: []corev1.PersistentVolumeAccessMode{
364
+ corev1.ReadWriteOnce,
365
+ },
366
+ Resources: corev1.VolumeResourceRequirements{
367
+ Requests: corev1.ResourceList{
368
+ corev1.ResourceStorage: resource.MustParse(db.Spec.Storage),
369
+ },
370
+ },
371
+ },
372
+ }},
373
+ },
374
+ }
375
+ }
376
+
377
+ func (r *DatabaseReconciler) buildService(db *mycompanyv1.Database) *corev1.Service {
378
+ return &corev1.Service{
379
+ ObjectMeta: metav1.ObjectMeta{
380
+ Name: db.Name,
381
+ Namespace: db.Namespace,
382
+ },
383
+ Spec: corev1.ServiceSpec{
384
+ Selector: map[string]string{"app": db.Name},
385
+ Ports: []corev1.ServicePort{{
386
+ Port: 5432,
387
+ Name: "db",
388
+ }},
389
+ ClusterIP: "None", // Headless service for StatefulSet
390
+ },
391
+ }
392
+ }
393
+
394
+ func (r *DatabaseReconciler) updateStatus(ctx context.Context, db *mycompanyv1.Database,
395
+ phase string, ready bool, message string) (ctrl.Result, error) {
396
+ db.Status.Phase = phase
397
+ db.Status.Ready = ready
398
+ db.Status.Message = message
399
+ db.Status.Endpoint = fmt.Sprintf("%s.%s.svc.cluster.local:5432", db.Name, db.Namespace)
400
+ return ctrl.Result{}, r.Status().Update(ctx, db)
401
+ }
402
+
403
+ func (r *DatabaseReconciler) cleanupResources(ctx context.Context, db *mycompanyv1.Database) error {
404
+ // Custom cleanup logic (e.g., backup before deletion)
405
+ return nil
406
+ }
407
+
408
+ func (r *DatabaseReconciler) SetupWithManager(mgr ctrl.Manager) error {
409
+ return ctrl.NewControllerManagedBy(mgr).
410
+ For(&mycompanyv1.Database{}).
411
+ Owns(&appsv1.StatefulSet{}).
412
+ Owns(&corev1.Service{}).
413
+ Complete(r)
414
+ }
415
+ ```
416
+
417
+ ## Operator RBAC
418
+
419
+ ```yaml
420
+ apiVersion: v1
421
+ kind: ServiceAccount
422
+ metadata:
423
+ name: database-operator
424
+ namespace: operators
425
+ ---
426
+ apiVersion: rbac.authorization.k8s.io/v1
427
+ kind: ClusterRole
428
+ metadata:
429
+ name: database-operator-role
430
+ rules:
431
+ - apiGroups: ["mycompany.io"]
432
+ resources: ["databases"]
433
+ verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
434
+ - apiGroups: ["mycompany.io"]
435
+ resources: ["databases/status"]
436
+ verbs: ["get", "update", "patch"]
437
+ - apiGroups: ["mycompany.io"]
438
+ resources: ["databases/finalizers"]
439
+ verbs: ["update"]
440
+ - apiGroups: ["apps"]
441
+ resources: ["statefulsets"]
442
+ verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
443
+ - apiGroups: [""]
444
+ resources: ["services", "configmaps", "secrets"]
445
+ verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
446
+ - apiGroups: [""]
447
+ resources: ["persistentvolumeclaims"]
448
+ verbs: ["get", "list", "watch"]
449
+ - apiGroups: [""]
450
+ resources: ["events"]
451
+ verbs: ["create", "patch"]
452
+ ---
453
+ apiVersion: rbac.authorization.k8s.io/v1
454
+ kind: ClusterRoleBinding
455
+ metadata:
456
+ name: database-operator-rolebinding
457
+ roleRef:
458
+ apiGroup: rbac.authorization.k8s.io
459
+ kind: ClusterRole
460
+ name: database-operator-role
461
+ subjects:
462
+ - kind: ServiceAccount
463
+ name: database-operator
464
+ namespace: operators
465
+ ```
466
+
467
+ ## Operator Deployment
468
+
469
+ ```yaml
470
+ apiVersion: apps/v1
471
+ kind: Deployment
472
+ metadata:
473
+ name: database-operator
474
+ namespace: operators
475
+ labels:
476
+ app: database-operator
477
+ spec:
478
+ replicas: 1
479
+ selector:
480
+ matchLabels:
481
+ app: database-operator
482
+ template:
483
+ metadata:
484
+ labels:
485
+ app: database-operator
486
+ spec:
487
+ serviceAccountName: database-operator
488
+ securityContext:
489
+ runAsNonRoot: true
490
+ seccompProfile:
491
+ type: RuntimeDefault
492
+ containers:
493
+ - name: manager
494
+ image: myregistry.io/database-operator:v1.0.0
495
+ args:
496
+ - --leader-elect
497
+ - --health-probe-bind-address=:8081
498
+ securityContext:
499
+ allowPrivilegeEscalation: false
500
+ capabilities:
501
+ drop: ["ALL"]
502
+ readOnlyRootFilesystem: true
503
+ ports:
504
+ - containerPort: 8080
505
+ name: metrics
506
+ livenessProbe:
507
+ httpGet:
508
+ path: /healthz
509
+ port: 8081
510
+ initialDelaySeconds: 15
511
+ periodSeconds: 20
512
+ readinessProbe:
513
+ httpGet:
514
+ path: /readyz
515
+ port: 8081
516
+ initialDelaySeconds: 5
517
+ periodSeconds: 10
518
+ resources:
519
+ limits:
520
+ cpu: 500m
521
+ memory: 128Mi
522
+ requests:
523
+ cpu: 10m
524
+ memory: 64Mi
525
+ ```
526
+
527
+ ## Operator SDK Commands
528
+
529
+ ```bash
530
+ # Initialize new operator project
531
+ operator-sdk init --domain mycompany.io --repo github.com/mycompany/database-operator
532
+
533
+ # Create new API (CRD + controller)
534
+ operator-sdk create api --group mycompany --version v1 --kind Database --resource --controller
535
+
536
+ # Generate manifests (CRD, RBAC)
537
+ make manifests
538
+
539
+ # Generate deep copy methods
540
+ make generate
541
+
542
+ # Build operator image
543
+ make docker-build docker-push IMG=myregistry.io/database-operator:v1.0.0
544
+
545
+ # Deploy to cluster
546
+ make deploy IMG=myregistry.io/database-operator:v1.0.0
547
+
548
+ # Undeploy
549
+ make undeploy
550
+ ```
551
+
552
+ ## Best Practices
553
+
554
+ 1. **Use finalizers** for cleanup of external resources before CR deletion
555
+ 2. **Set owner references** so owned resources are garbage collected with the CR
556
+ 3. **Implement idempotent reconciliation** - same input should produce same output
557
+ 4. **Use status subresource** to separate desired state (spec) from observed state (status)
558
+ 5. **Add validation** via OpenAPI schema or webhooks
559
+ 6. **Emit events** for significant state changes
560
+ 7. **Use leader election** for high availability
561
+ 8. **Set resource limits** on the operator deployment
562
+ 9. **Follow least privilege** RBAC principles
563
+ 10. **Test with envtest** for unit testing controllers