@umacloud/knowledge 1.0.1

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 (418) hide show
  1. package/00-governance/governance-capabilities.md +557 -0
  2. package/00-governance/knowledge-map.md +39 -0
  3. package/00-governance/maintenance-policy.md +76 -0
  4. package/00-governance/review-checklist.md +81 -0
  5. package/README.md +13 -0
  6. package/ai/01-standards/agent-development-complete.md +691 -0
  7. package/ai/01-standards/llm-application-complete.md +488 -0
  8. package/ai/01-standards/mlops-complete.md +798 -0
  9. package/ai/01-standards/prompt-engineering-complete.md +646 -0
  10. package/ai/01-standards/rag-architecture-complete.md +649 -0
  11. package/ai/02-playbooks/llm-evaluation-playbook.md +847 -0
  12. package/ai/03-checklists/ai-project-checklist.md +215 -0
  13. package/ai/04-antipatterns/ai-antipatterns.md +661 -0
  14. package/ai/05-cases/case-rag-production.md +147 -0
  15. package/ai/06-glossary/ai-glossary.md +162 -0
  16. package/ai/agent-evaluation-benchmark.md +53 -0
  17. package/ai/ai-agent-memory-context-management.md +41 -0
  18. package/ai/ai-cost-capacity-optimization-playbook.md +42 -0
  19. package/ai/ai-data-security-and-compliance-playbook.md +37 -0
  20. package/ai/ai-domain-index-and-checklist.md +40 -0
  21. package/ai/ai-governance-maturity-model.md +50 -0
  22. package/ai/ai-model-selection-and-routing-strategy.md +47 -0
  23. package/ai/ai-observability-and-oncall-runbook.md +52 -0
  24. package/ai/ai-rag-engineering-playbook.md +42 -0
  25. package/ai/ai-red-team-and-safety-evaluation.md +42 -0
  26. package/ai/ai-release-readiness-and-rollback-gate.md +42 -0
  27. package/ai/llm-agent-engineering-deep-dive.md +57 -0
  28. package/ai/prompt-and-tool-guardrails.md +52 -0
  29. package/api/01-standards/enterprise-api-standards.md +198 -0
  30. package/api/01-standards/rest-api-design-guide.md +63 -0
  31. package/api/02-playbooks/api-pagination-playbook.md +93 -0
  32. package/api/02-playbooks/graphql-production-playbook.md +176 -0
  33. package/api/03-checklists/api-review-checklist.md +55 -0
  34. package/api/04-antipatterns/api-antipatterns.md +112 -0
  35. package/architecture/01-standards/api-gateway-patterns.md +496 -0
  36. package/architecture/01-standards/cloud-native-patterns.md +644 -0
  37. package/architecture/01-standards/distributed-systems-patterns.md +591 -0
  38. package/architecture/01-standards/event-driven-architecture.md +595 -0
  39. package/architecture/01-standards/microservices-patterns-complete.md +968 -0
  40. package/architecture/01-standards/microservices-patterns.md +495 -0
  41. package/architecture/01-standards/system-design-interview.md +664 -0
  42. package/architecture/02-playbooks/microservices-patterns-playbook.md +137 -0
  43. package/architecture/02-playbooks/migration-playbook.md +780 -0
  44. package/architecture/02-playbooks/system-design-playbook.md +779 -0
  45. package/architecture/03-checklists/architecture-decision-checklist.md +297 -0
  46. package/architecture/04-antipatterns/architecture-antipatterns.md +417 -0
  47. package/architecture/05-cases/case-netflix-microservices.md +413 -0
  48. package/architecture/06-glossary/architecture-glossary.md +164 -0
  49. package/architecture/adr-template-and-examples.md +38 -0
  50. package/architecture/api-gateway-deep-dive.md +1291 -0
  51. package/architecture/configuration-management.md +1162 -0
  52. package/architecture/distributed-transactions.md +1220 -0
  53. package/architecture/microservices-complete.md +735 -0
  54. package/architecture/resilience-and-disaster-patterns.md +37 -0
  55. package/architecture/service-governance.md +1198 -0
  56. package/architecture/system-architecture-deep-dive.md +37 -0
  57. package/backend/01-standards/analytics-and-growth.md +65 -0
  58. package/backend/01-standards/api-and-error-conventions.md +120 -0
  59. package/backend/01-standards/application-layering-and-packaging.md +160 -0
  60. package/backend/01-standards/auth-implementation.md +104 -0
  61. package/backend/01-standards/backend-framework-idioms.md +74 -0
  62. package/backend/01-standards/background-jobs-and-async.md +66 -0
  63. package/backend/01-standards/caching-strategies-complete.md +390 -0
  64. package/backend/01-standards/config-and-observability.md +77 -0
  65. package/backend/01-standards/data-modeling-and-persistence.md +94 -0
  66. package/backend/01-standards/django-complete.md +1765 -0
  67. package/backend/01-standards/email-and-notifications.md +64 -0
  68. package/backend/01-standards/fastapi-complete.md +925 -0
  69. package/backend/01-standards/file-upload-and-storage.md +66 -0
  70. package/backend/01-standards/graphql-api-complete.md +416 -0
  71. package/backend/01-standards/llm-application-standard.md +78 -0
  72. package/backend/01-standards/message-queue-patterns.md +379 -0
  73. package/backend/01-standards/microservices-and-distributed.md +78 -0
  74. package/backend/01-standards/nestjs-complete.md +2167 -0
  75. package/backend/01-standards/payment-integration.md +80 -0
  76. package/backend/01-standards/rate-limiting-complete.md +451 -0
  77. package/backend/01-standards/realtime-and-websocket.md +65 -0
  78. package/backend/01-standards/search-and-filtering.md +64 -0
  79. package/backend/01-standards/spring-boot-complete.md +445 -0
  80. package/backend/02-playbooks/api-design-playbook.md +718 -0
  81. package/backend/02-playbooks/email-send-playbook.md +130 -0
  82. package/backend/02-playbooks/file-upload-s3-playbook.md +153 -0
  83. package/backend/02-playbooks/typescript-enterprise-playbook.md +133 -0
  84. package/backend/02-playbooks/websocket-realtime-playbook.md +154 -0
  85. package/backend/03-checklists/api-launch-checklist.md +189 -0
  86. package/backend/04-antipatterns/backend-antipatterns.md +1051 -0
  87. package/blockchain/01-standards/blockchain-basics.md +557 -0
  88. package/blockchain/01-standards/smart-contract-development.md +1315 -0
  89. package/cicd/01-standards/deployment-and-delivery-standard.md +96 -0
  90. package/cicd/01-standards/github-actions-complete.md +473 -0
  91. package/cicd/01-standards/release-and-store-submission.md +75 -0
  92. package/cicd/02-playbooks/cicd-pipeline-playbook.md +144 -0
  93. package/cicd/02-playbooks/release-management-playbook.md +605 -0
  94. package/cicd/03-checklists/pipeline-security-checklist.md +168 -0
  95. package/cicd/04-antipatterns/cicd-antipatterns.md +589 -0
  96. package/cicd/05-cases/case-deployment-automation.md +221 -0
  97. package/cicd/05-cases/case-gitops-transformation.md +212 -0
  98. package/cicd/06-glossary/cicd-glossary.md +114 -0
  99. package/cicd/cicd-blueprint-deep-dive.md +38 -0
  100. package/cicd/release-readiness-gate.md +37 -0
  101. package/cloud-native/01-standards/container-security.md +741 -0
  102. package/cloud-native/01-standards/kubernetes-complete.md +812 -0
  103. package/cloud-native/02-playbooks/api-gateway-playbook.md +155 -0
  104. package/cloud-native/02-playbooks/gitops-with-argocd.md +760 -0
  105. package/cloud-native/02-playbooks/k8s-troubleshooting-playbook.md +1942 -0
  106. package/cloud-native/02-playbooks/message-queue-playbook.md +129 -0
  107. package/cloud-native/02-playbooks/multicloud-governance.md +726 -0
  108. package/cloud-native/02-playbooks/serverless-patterns.md +788 -0
  109. package/cloud-native/02-playbooks/service-mesh-playbook.md +612 -0
  110. package/cloud-native/02-playbooks/terraform-iac-playbook.md +143 -0
  111. package/cloud-native/03-checklists/container-security-checklist.md +431 -0
  112. package/cloud-native/03-checklists/k8s-production-readiness-checklist.md +460 -0
  113. package/cloud-native/04-antipatterns/container-antipatterns.md +660 -0
  114. package/cloud-native/04-antipatterns/k8s-antipatterns.md +743 -0
  115. package/cloud-native/05-cases/case-k8s-migration.md +478 -0
  116. package/cloud-native/05-cases/case-k8s-scaling.md +642 -0
  117. package/cloud-native/05-cases/case-k8s-security-incident.md +397 -0
  118. package/cloud-native/06-glossary/cloud-native-glossary.md +337 -0
  119. package/cross-platform/01-standards/cross-platform-frameworks.md +83 -0
  120. package/cross-platform/01-standards/platform-selection-and-architecture.md +77 -0
  121. package/data/01-standards/elasticsearch-complete.md +2098 -0
  122. package/data/01-standards/postgresql-complete.md +1613 -0
  123. package/data/01-standards/redis-complete.md +1527 -0
  124. package/data/02-playbooks/database-optimization-playbook.md +403 -0
  125. package/data/02-playbooks/elasticsearch-production-playbook.md +132 -0
  126. package/data/03-checklists/database-launch-checklist.md +187 -0
  127. package/data/04-antipatterns/database-antipatterns.md +873 -0
  128. package/data/05-cases/case-database-migration.md +310 -0
  129. package/data/06-glossary/database-glossary.md +440 -0
  130. package/data/data-governance-and-modeling-deep-dive.md +39 -0
  131. package/data-engineering/01-standards/airflow-complete.md +523 -0
  132. package/data-engineering/01-standards/kafka-complete.md +1521 -0
  133. package/data-engineering/02-playbooks/spark-etl-playbook.md +496 -0
  134. package/data-engineering/03-checklists/pipeline-launch-checklist.md +194 -0
  135. package/data-engineering/04-antipatterns/data-pipeline-antipatterns.md +684 -0
  136. package/data-engineering/05-cases/case-real-time-pipeline.md +355 -0
  137. package/data-engineering/06-glossary/data-engineering-glossary.md +429 -0
  138. package/database/01-standards/database-schema-standards.md +147 -0
  139. package/database/02-playbooks/postgresql-optimization-quick.md +52 -0
  140. package/database/02-playbooks/postgresql-performance-optimization.md +58 -0
  141. package/database/02-playbooks/postgresql-production-playbook.md +146 -0
  142. package/database/02-playbooks/redis-caching-playbook.md +117 -0
  143. package/database/03-checklists/database-review-checklist.md +50 -0
  144. package/database/04-antipatterns/database-antipatterns.md +112 -0
  145. package/design/01-standards/ui-design-system-complete.md +423 -0
  146. package/design/02-playbooks/design-handoff-playbook.md +254 -0
  147. package/design/02-playbooks/design-review-playbook.md +388 -0
  148. package/design/03-checklists/design-review-checklist.md +246 -0
  149. package/design/04-antipatterns/design-antipatterns.md +378 -0
  150. package/design/05-cases/case-design-system-adoption.md +328 -0
  151. package/design/06-glossary/design-glossary.md +329 -0
  152. package/design/ui-full-lifecycle-cross-platform-playbook.md +571 -0
  153. package/design/ux-system-deep-dive.md +38 -0
  154. package/design-systems/00-craft-rules.md +71 -0
  155. package/design-systems/aesthetic-families.md +43 -0
  156. package/design-systems/anti-ai-slop.md +162 -0
  157. package/design-systems/bold-geometric.md +120 -0
  158. package/design-systems/brutalist-bold.md +103 -0
  159. package/design-systems/editorial-clean.md +109 -0
  160. package/design-systems/glass-aurora.md +108 -0
  161. package/design-systems/modern-minimal.md +145 -0
  162. package/design-systems/premium-luxury.md +106 -0
  163. package/design-systems/product-type-design-map.md +48 -0
  164. package/design-systems/soft-warm.md +123 -0
  165. package/design-systems/tech-utility.md +113 -0
  166. package/desktop/01-standards/desktop-app-standard.md +72 -0
  167. package/desktop/01-standards/desktop-design.md +71 -0
  168. package/development/00-governance/document-template.md +41 -0
  169. package/development/01-standards/api-versioning-strategies.md +432 -0
  170. package/development/01-standards/authentication-patterns-complete.md +479 -0
  171. package/development/01-standards/css-architecture-complete.md +550 -0
  172. package/development/01-standards/database-migration-strategies.md +484 -0
  173. package/development/01-standards/elasticsearch-complete.md +347 -0
  174. package/development/01-standards/git-complete.md +371 -0
  175. package/development/01-standards/golang-complete.md +1565 -0
  176. package/development/01-standards/graphql-complete.md +298 -0
  177. package/development/01-standards/javascript-bundlers-complete.md +469 -0
  178. package/development/01-standards/javascript-typescript-complete.md +528 -0
  179. package/development/01-standards/jest-complete.md +275 -0
  180. package/development/01-standards/linux-complete.md +234 -0
  181. package/development/01-standards/logging-observability-complete.md +526 -0
  182. package/development/01-standards/microservices-communication.md +502 -0
  183. package/development/01-standards/mongodb-complete.md +406 -0
  184. package/development/01-standards/oauth2-complete.md +285 -0
  185. package/development/01-standards/performance-optimization-complete.md +289 -0
  186. package/development/01-standards/playwright-complete.md +247 -0
  187. package/development/01-standards/postgresql-complete.md +456 -0
  188. package/development/01-standards/pytest-complete.md +340 -0
  189. package/development/01-standards/python-async-programming.md +902 -0
  190. package/development/01-standards/python-complete.md +956 -0
  191. package/development/01-standards/python-decorators-complete.md +799 -0
  192. package/development/01-standards/python-design-patterns.md +2854 -0
  193. package/development/01-standards/python-packaging-distribution.md +420 -0
  194. package/development/01-standards/python-testing-strategies.md +607 -0
  195. package/development/01-standards/python-web-frameworks-comparison.md +471 -0
  196. package/development/01-standards/redis-complete.md +317 -0
  197. package/development/01-standards/rest-api-complete.md +316 -0
  198. package/development/01-standards/rust-complete.md +578 -0
  199. package/development/01-standards/typescript-advanced-types.md +1513 -0
  200. package/development/01-standards/web-security-complete.md +292 -0
  201. package/development/02-playbooks/api-design-playbook.md +810 -0
  202. package/development/02-playbooks/database-migration-playbook.md +580 -0
  203. package/development/02-playbooks/debugging-playbook.md +692 -0
  204. package/development/02-playbooks/feature-delivery-playbook.md +430 -0
  205. package/development/02-playbooks/incident-hotfix-playbook.md +387 -0
  206. package/development/02-playbooks/performance-optimization-playbook.md +531 -0
  207. package/development/02-playbooks/performance-tuning-playbook.md +652 -0
  208. package/development/02-playbooks/refactor-playbook.md +403 -0
  209. package/development/02-playbooks/release-playbook.md +469 -0
  210. package/development/03-checklists/architecture-review-checklist.md +168 -0
  211. package/development/03-checklists/data-migration-checklist.md +157 -0
  212. package/development/03-checklists/oncall-handover-checklist.md +173 -0
  213. package/development/03-checklists/pr-checklist.md +158 -0
  214. package/development/03-checklists/production-readiness-checklist.md +190 -0
  215. package/development/03-checklists/release-readiness-checklist.md +154 -0
  216. package/development/03-checklists/security-review-checklist.md +182 -0
  217. package/development/04-antipatterns/api-antipatterns.md +657 -0
  218. package/development/04-antipatterns/architecture-antipatterns.md +686 -0
  219. package/development/04-antipatterns/backend-antipatterns.md +648 -0
  220. package/development/04-antipatterns/cicd-antipatterns.md +540 -0
  221. package/development/04-antipatterns/code-smell-antipatterns.md +571 -0
  222. package/development/04-antipatterns/data-antipatterns.md +658 -0
  223. package/development/04-antipatterns/database-antipatterns.md +578 -0
  224. package/development/04-antipatterns/frontend-antipatterns.md +635 -0
  225. package/development/04-antipatterns/reliability-antipatterns.md +700 -0
  226. package/development/04-antipatterns/security-antipatterns.md +747 -0
  227. package/development/05-cases/case-api-version-migration.md +428 -0
  228. package/development/05-cases/case-authorization-hardening.md +383 -0
  229. package/development/05-cases/case-bluegreen-rollback.md +466 -0
  230. package/development/05-cases/case-cache-snowball-protection.md +485 -0
  231. package/development/05-cases/case-ci-cd-pipeline.md +544 -0
  232. package/development/05-cases/case-database-scaling.md +500 -0
  233. package/development/05-cases/case-db-hotspot-optimization.md +487 -0
  234. package/development/05-cases/case-incident-mttr-reduction.md +563 -0
  235. package/development/05-cases/case-microservice-migration.md +375 -0
  236. package/development/05-cases/case-performance-optimization.md +406 -0
  237. package/development/05-cases/case-security-incident-response.md +345 -0
  238. package/development/06-glossary/full-stack-glossary.md +166 -0
  239. package/development/09-maturity/quarterly-audit-template.md +35 -0
  240. package/development/11-ui-excellence/ui-aesthetic-system.md +41 -0
  241. package/development/11-ui-excellence/ui-engineering-excellence.md +435 -0
  242. package/development/12-scenarios/development-scenarios-guide.md +565 -0
  243. package/development/13-implementation-assets/implementation-toolkit.md +282 -0
  244. package/development/13-implementation-assets/knowledge-gates-execution.md +43 -0
  245. package/development/14-full-lifecycle/software-lifecycle-gates.md +511 -0
  246. package/development/15-lifecycle-templates/project-templates-collection.md +791 -0
  247. package/development/api-contract-and-versioning-guide.md +36 -0
  248. package/development/api-governance-complete.md +43 -0
  249. package/development/backend-engineering-complete.md +43 -0
  250. package/development/code-review-quality-complete.md +43 -0
  251. package/development/concurrency-reliability-complete.md +43 -0
  252. package/development/database-engineering-complete.md +43 -0
  253. package/development/engineering-effectiveness-complete.md +43 -0
  254. package/development/engineering-standards-deep-dive.md +38 -0
  255. package/development/frontend-engineering-complete.md +43 -0
  256. package/development/performance-capacity-complete.md +43 -0
  257. package/development/refactor-migration-complete.md +42 -0
  258. package/development/refactoring-and-techdebt-playbook.md +37 -0
  259. package/development/security-in-development-complete.md +43 -0
  260. package/devops/01-standards/cicd-pipeline-complete.md +262 -0
  261. package/devops/01-standards/docker-complete.md +1490 -0
  262. package/devops/01-standards/github-actions-complete.md +337 -0
  263. package/devops/01-standards/kubernetes-complete.md +638 -0
  264. package/devops/01-standards/terraform-complete.md +2117 -0
  265. package/devops/02-playbooks/docker-compose-playbook.md +233 -0
  266. package/devops/02-playbooks/docker-k8s-production-playbook.md +186 -0
  267. package/devops/02-playbooks/docker-production-playbook.md +952 -0
  268. package/edge-iot/01-standards/edge-iot-complete.md +473 -0
  269. package/experts/architect/api-design.md +178 -0
  270. package/experts/architect/methodology.md +124 -0
  271. package/experts/architect/security.md +75 -0
  272. package/experts/backend-lead/methodology.md +216 -0
  273. package/experts/devops/methodology.md +160 -0
  274. package/experts/frontend-lead/methodology.md +178 -0
  275. package/experts/product-manager/industry/ecommerce.md +43 -0
  276. package/experts/product-manager/industry/saas.md +40 -0
  277. package/experts/product-manager/methodology.md +97 -0
  278. package/experts/qa-lead/methodology.md +123 -0
  279. package/experts/qa-lead/test-strategy.md +128 -0
  280. package/experts/uiux-designer/methodology.md +125 -0
  281. package/frontend/01-standards/accessibility-complete.md +532 -0
  282. package/frontend/01-standards/accessibility-standard.md +74 -0
  283. package/frontend/01-standards/admin-dashboard-and-crud.md +72 -0
  284. package/frontend/01-standards/design-tokens-complete.md +444 -0
  285. package/frontend/01-standards/forms-and-validation.md +77 -0
  286. package/frontend/01-standards/frontend-architecture-and-layering.md +119 -0
  287. package/frontend/01-standards/i18n-and-localization.md +65 -0
  288. package/frontend/01-standards/nextjs-complete.md +451 -0
  289. package/frontend/01-standards/react-complete.md +713 -0
  290. package/frontend/01-standards/react-hooks-complete-guide.md +1100 -0
  291. package/frontend/01-standards/react-hooks-complete.md +1171 -0
  292. package/frontend/01-standards/seo-and-web-vitals.md +77 -0
  293. package/frontend/01-standards/state-management-complete.md +444 -0
  294. package/frontend/01-standards/vue-complete.md +499 -0
  295. package/frontend/01-standards/vue3-complete.md +2002 -0
  296. package/frontend/01-standards/web-framework-best-practices.md +64 -0
  297. package/frontend/01-standards/web-performance-complete.md +495 -0
  298. package/frontend/02-playbooks/accessibility-a11y-playbook.md +161 -0
  299. package/frontend/02-playbooks/frontend-performance-playbook.md +707 -0
  300. package/frontend/02-playbooks/i18n-internationalization-playbook.md +120 -0
  301. package/frontend/02-playbooks/performance-optimization-playbook.md +163 -0
  302. package/frontend/02-playbooks/react-nextjs-production-playbook.md +167 -0
  303. package/frontend/02-playbooks/react-state-management-playbook.md +173 -0
  304. package/frontend/03-checklists/component-quality-checklist.md +166 -0
  305. package/frontend/03-checklists/frontend-launch-checklist.md +299 -0
  306. package/frontend/04-antipatterns/frontend-antipatterns.md +886 -0
  307. package/frontend/05-cases/case-performance-optimization.md +274 -0
  308. package/harmony/01-standards/harmonyos-arkts-standard.md +75 -0
  309. package/harmony/01-standards/harmonyos-design.md +65 -0
  310. package/high-quality-engineering-playbook.md +54 -0
  311. package/incident/01-standards/incident-response-complete.md +303 -0
  312. package/incident/02-playbooks/chaos-engineering-playbook.md +883 -0
  313. package/incident/02-playbooks/postmortem-playbook.md +398 -0
  314. package/incident/03-checklists/incident-readiness-checklist.md +181 -0
  315. package/incident/04-antipatterns/incident-antipatterns.md +490 -0
  316. package/incident/05-cases/case-cascade-failure.md +176 -0
  317. package/incident/06-glossary/incident-glossary.md +114 -0
  318. package/incident/postmortem-and-response-deep-dive.md +39 -0
  319. package/industries/ecommerce/ecommerce-complete.md +631 -0
  320. package/industries/education/education-complete.md +555 -0
  321. package/industries/fintech/fintech-complete.md +501 -0
  322. package/industries/gaming/gaming-complete.md +587 -0
  323. package/industries/healthcare/healthcare-complete.md +452 -0
  324. package/low-code/01-standards/low-code-complete.md +944 -0
  325. package/miniprogram/01-standards/ai-common-mistakes.md +61 -0
  326. package/miniprogram/01-standards/miniprogram-custom-navbar-capsule.md +77 -0
  327. package/miniprogram/01-standards/miniprogram-design.md +61 -0
  328. package/miniprogram/01-standards/miniprogram-standard.md +81 -0
  329. package/mobile/01-standards/android-material-design.md +70 -0
  330. package/mobile/01-standards/flutter-complete.md +384 -0
  331. package/mobile/01-standards/ios-design-hig.md +78 -0
  332. package/mobile/01-standards/mobile-app-standard.md +85 -0
  333. package/mobile/01-standards/react-native-complete.md +352 -0
  334. package/mobile/02-playbooks/mobile-cross-platform-playbook.md +175 -0
  335. package/mobile/02-playbooks/mobile-performance.md +473 -0
  336. package/mobile/03-checklists/mobile-release-checklist.md +234 -0
  337. package/mobile/04-antipatterns/mobile-antipatterns.md +798 -0
  338. package/mobile/05-cases/case-app-performance.md +500 -0
  339. package/mobile/05-cases/case-app-startup-optimization.md +218 -0
  340. package/mobile/06-glossary/mobile-glossary.md +484 -0
  341. package/observability/01-standards/observability-standards.md +103 -0
  342. package/observability/02-playbooks/prometheus-grafana-playbook.md +135 -0
  343. package/observability/02-playbooks/structured-logging-playbook.md +73 -0
  344. package/observability/03-checklists/observability-checklist.md +54 -0
  345. package/observability/04-antipatterns/observability-antipatterns.md +106 -0
  346. package/operations/01-standards/prometheus-monitoring-complete.md +1578 -0
  347. package/operations/02-playbooks/capacity-planning-playbook.md +620 -0
  348. package/operations/03-checklists/production-launch-checklist.md +365 -0
  349. package/operations/04-antipatterns/operations-antipatterns.md +664 -0
  350. package/operations/05-cases/case-sre-practices.md +581 -0
  351. package/operations/06-glossary/operations-glossary.md +120 -0
  352. package/operations/aiops-anomaly-detection.md +758 -0
  353. package/operations/capacity-planning.md +1061 -0
  354. package/operations/chaos-engineering.md +659 -0
  355. package/operations/incident-command-system.md +38 -0
  356. package/operations/observability-complete.md +442 -0
  357. package/operations/slo-sli-playbook.md +517 -0
  358. package/operations/sre-operations-deep-dive.md +39 -0
  359. package/package.json +8 -0
  360. package/performance/01-standards/performance-and-scalability.md +80 -0
  361. package/performance/01-standards/performance-standards.md +156 -0
  362. package/performance/02-playbooks/query-optimization-playbook.md +103 -0
  363. package/performance/03-checklists/performance-checklist.md +56 -0
  364. package/performance/04-antipatterns/performance-antipatterns.md +146 -0
  365. package/product/01-standards/product-management-complete.md +285 -0
  366. package/product/02-playbooks/feature-launch-playbook.md +207 -0
  367. package/product/02-playbooks/user-research-playbook.md +532 -0
  368. package/product/03-checklists/feature-launch-checklist.md +275 -0
  369. package/product/04-antipatterns/product-antipatterns.md +355 -0
  370. package/product/05-cases/case-mvp-to-scale.md +384 -0
  371. package/product/06-glossary/product-glossary.md +462 -0
  372. package/product/feature-prioritization-framework.md +40 -0
  373. package/product/kpi-and-metric-tree.md +37 -0
  374. package/product/product-discovery-and-prd-deep-dive.md +41 -0
  375. package/quantum/01-standards/quantum-complete.md +1186 -0
  376. package/security/01-standards/api-security-complete.md +511 -0
  377. package/security/01-standards/container-runtime-security.md +574 -0
  378. package/security/01-standards/data-protection-gdpr.md +543 -0
  379. package/security/01-standards/owasp-top10-complete.md +1890 -0
  380. package/security/01-standards/secure-coding-baseline.md +90 -0
  381. package/security/01-standards/supply-chain-security.md +441 -0
  382. package/security/01-standards/web-security-checklist.md +108 -0
  383. package/security/01-standards/zero-trust-architecture.md +521 -0
  384. package/security/02-playbooks/auth-sso-playbook.md +166 -0
  385. package/security/02-playbooks/incident-response-security-playbook.md +588 -0
  386. package/security/02-playbooks/owasp-api-security-playbook.md +129 -0
  387. package/security/02-playbooks/payment-integration-playbook.md +119 -0
  388. package/security/02-playbooks/penetration-testing-playbook.md +517 -0
  389. package/security/03-checklists/security-audit-checklist.md +356 -0
  390. package/security/04-antipatterns/security-coding-antipatterns.md +580 -0
  391. package/security/05-cases/case-log4shell-incident.md +537 -0
  392. package/security/05-cases/case-major-breaches.md +468 -0
  393. package/security/06-glossary/security-glossary.md +212 -0
  394. package/security/compliance-automation.md +993 -0
  395. package/security/container-security.md +680 -0
  396. package/security/devsecops-complete.md +426 -0
  397. package/security/sast-dast-sca.md +775 -0
  398. package/security/secrets-management.md +594 -0
  399. package/security/security-architecture-deep-dive.md +37 -0
  400. package/security/threat-modeling-stride-playbook.md +40 -0
  401. package/seed-templates/auth-system.md +59 -0
  402. package/seed-templates/blog-content.md +94 -0
  403. package/seed-templates/dashboard.md +89 -0
  404. package/seed-templates/docs-site.md +73 -0
  405. package/seed-templates/e-commerce.md +50 -0
  406. package/seed-templates/saas-landing.md +92 -0
  407. package/seed-templates/settings-page.md +51 -0
  408. package/testing/01-standards/test-strategy-and-layering.md +83 -0
  409. package/testing/01-standards/testing-strategy-complete.md +422 -0
  410. package/testing/01-standards/unit-testing-best-practices.md +118 -0
  411. package/testing/02-playbooks/e2e-testing-playbook.md +988 -0
  412. package/testing/02-playbooks/testing-strategy-playbook.md +126 -0
  413. package/testing/03-checklists/test-strategy-checklist.md +208 -0
  414. package/testing/04-antipatterns/testing-antipatterns.md +718 -0
  415. package/testing/05-cases/case-testing-transformation.md +300 -0
  416. package/testing/06-glossary/testing-glossary.md +110 -0
  417. package/testing/risk-based-test-matrix.md +36 -0
  418. package/testing/testing-strategy-deep-dive.md +37 -0
@@ -0,0 +1,523 @@
1
+ ---
2
+ id: airflow-complete
3
+ title: Apache Airflow完整指南
4
+ domain: data-engineering
5
+ category: 01-standards
6
+ difficulty: intermediate
7
+ tags: [airflow, complete, connections和hooks, dag最佳实践, data-engineering, sensor等待任务, 变量和配置, 执行器配置]
8
+ quality_score: 70
9
+ last_updated: 2026-06-15
10
+ ---
11
+ # Apache Airflow完整指南
12
+
13
+ ## 概述
14
+ Apache Airflow是一个开源的工作流编排平台,用于开发和调度数据管道。使用Python代码定义工作流,支持复杂的依赖关系和分布式执行。
15
+
16
+ ## 核心概念
17
+
18
+ ### 1. DAG (Directed Acyclic Graph)
19
+ DAG是有向无环图,定义了任务的依赖关系和执行顺序。
20
+
21
+ ```python
22
+ from airflow import DAG
23
+ from airflow.operators.python import PythonOperator
24
+ from datetime import datetime
25
+
26
+ # 定义DAG
27
+ with DAG(
28
+ dag_id='example_dag',
29
+ start_date=datetime(2024, 1, 1),
30
+ schedule_interval='@daily',
31
+ catchup=False
32
+ ) as dag:
33
+
34
+ task1 = PythonOperator(
35
+ task_id='task1',
36
+ python_callable=lambda: print("Task 1")
37
+ )
38
+
39
+ task2 = PythonOperator(
40
+ task_id='task2',
41
+ python_callable=lambda: print("Task 2")
42
+ )
43
+
44
+ task1 >> task2 # task1完成后执行task2
45
+ ```
46
+
47
+ ### 2. Task (任务)
48
+ Task是DAG中的基本执行单元。
49
+
50
+ **常用Operator**:
51
+ - **PythonOperator**: 执行Python函数
52
+ - **BashOperator**: 执行Bash命令
53
+ - **SQLOperator**: 执行SQL查询
54
+ - **DockerOperator**: 执行Docker容器
55
+ - **KubernetesPodOperator**: 执行K8s Pod
56
+
57
+ ```python
58
+ from airflow.operators.bash import BashOperator
59
+ from airflow.operators.python import PythonOperator
60
+
61
+ # Python任务
62
+ def my_function(**kwargs):
63
+ print(kwargs['ds'])
64
+
65
+ python_task = PythonOperator(
66
+ task_id='python_task',
67
+ python_callable=my_function,
68
+ provide_context=True
69
+ )
70
+
71
+ # Bash任务
72
+ bash_task = BashOperator(
73
+ task_id='bash_task',
74
+ bash_command='echo "Hello Airflow"'
75
+ )
76
+ ```
77
+
78
+ ### 3. XCom (跨任务通信)
79
+ XCom用于任务间共享数据。
80
+
81
+ ```python
82
+ def push_function(ti):
83
+ ti.xcom_push(key='my_key', value='my_value')
84
+
85
+ def pull_function(ti):
86
+ value = ti.xcom_pull(key='my_key', task_ids='push_task')
87
+ print(value)
88
+
89
+ push_task = PythonOperator(
90
+ task_id='push_task',
91
+ python_callable=push_function
92
+ )
93
+
94
+ pull_task = PythonOperator(
95
+ task_id='pull_task',
96
+ python_callable=pull_function
97
+ )
98
+ ```
99
+
100
+ ## DAG最佳实践
101
+
102
+ ### 1. 结构化DAG定义
103
+
104
+ ```python
105
+ from airflow import DAG
106
+ from airflow.operators.python import PythonOperator
107
+ from airflow.utils.dates import days_ago
108
+ import logging
109
+
110
+ default_args = {
111
+ 'owner': 'airflow',
112
+ 'depends_on_past': False,
113
+ 'email': ['airflow@example.com'],
114
+ 'email_on_failure': True,
115
+ 'email_on_retry': False,
116
+ 'retries': 3,
117
+ 'retry_delay': timedelta(minutes=5),
118
+ }
119
+
120
+ with DAG(
121
+ 'etl_pipeline',
122
+ default_args=default_args,
123
+ description='ETL pipeline for data warehouse',
124
+ schedule_interval='0 2 * * *', # 每天凌晨2点
125
+ start_date=days_ago(1),
126
+ catchup=False,
127
+ tags=['etl', 'warehouse'],
128
+ ) as dag:
129
+
130
+ def extract(**kwargs):
131
+ logging.info("Extracting data...")
132
+ return {'data': 'extracted'}
133
+
134
+ def transform(**kwargs):
135
+ ti = kwargs['ti']
136
+ extracted_data = ti.xcom_pull(task_ids='extract')
137
+ logging.info(f"Transforming {extracted_data}")
138
+ return {'data': 'transformed'}
139
+
140
+ def load(**kwargs):
141
+ ti = kwargs['ti']
142
+ transformed_data = ti.xcom_pull(task_ids='transform')
143
+ logging.info(f"Loading {transformed_data}")
144
+
145
+ extract_task = PythonOperator(
146
+ task_id='extract',
147
+ python_callable=extract,
148
+ provide_context=True
149
+ )
150
+
151
+ transform_task = PythonOperator(
152
+ task_id='transform',
153
+ python_callable=transform,
154
+ provide_context=True
155
+ )
156
+
157
+ load_task = PythonOperator(
158
+ task_id='load',
159
+ python_callable=load,
160
+ provide_context=True
161
+ )
162
+
163
+ extract_task >> transform_task >> load_task
164
+ ```
165
+
166
+ ### 2. 动态DAG生成
167
+
168
+ ```python
169
+ from airflow import DAG
170
+ from airflow.operators.python import PythonOperator
171
+ from datetime import datetime
172
+
173
+ def create_dag(dag_id, schedule, config):
174
+ with DAG(
175
+ dag_id=dag_id,
176
+ schedule_interval=schedule,
177
+ start_date=datetime(2024, 1, 1)
178
+ ) as dag:
179
+
180
+ task = PythonOperator(
181
+ task_id='task',
182
+ python_callable=lambda: print(f"Running {dag_id}")
183
+ )
184
+
185
+ return dag
186
+
187
+ # 动态创建多个DAG
188
+ for i in range(10):
189
+ dag_id = f'dynamic_dag_{i}'
190
+ schedule = '@daily'
191
+ config = {'id': i}
192
+ globals()[dag_id] = create_dag(dag_id, schedule, config)
193
+ ```
194
+
195
+ ## Sensor等待任务
196
+
197
+ ### 1. 时间Sensor
198
+
199
+ ```python
200
+ from airflow.sensors.time_sensor import TimeSensor
201
+ from airflow.sensors.time_delta_sensor import TimeDeltaSensor
202
+
203
+ # 等待特定时间
204
+ wait_for_time = TimeSensor(
205
+ task_id='wait_for_time',
206
+ target_time='10:00:00',
207
+ poke_interval=60
208
+ )
209
+
210
+ # 等待时间增量
211
+ wait_for_delta = TimeDeltaSensor(
212
+ task_id='wait_for_delta',
213
+ delta=timedelta(hours=2)
214
+ )
215
+ ```
216
+
217
+ ### 2. 外部Sensor
218
+
219
+ ```python
220
+ from airflow.sensors.external_task import ExternalTaskSensor
221
+
222
+ # 等待另一个DAG的任务完成
223
+ wait_for_other_dag = ExternalTaskSensor(
224
+ task_id='wait_for_other_dag',
225
+ external_dag_id='other_dag',
226
+ external_task_id='final_task',
227
+ mode='reschedule', # 节省资源
228
+ poke_interval=300
229
+ )
230
+ ```
231
+
232
+ ### 3. 文件Sensor
233
+
234
+ ```python
235
+ from airflow.sensors.filesystem import FileSensor
236
+
237
+ # 等待文件出现
238
+ wait_for_file = FileSensor(
239
+ task_id='wait_for_file',
240
+ filepath='/path/to/file.csv',
241
+ poke_interval=30
242
+ )
243
+ ```
244
+
245
+ ## Connections和Hooks
246
+
247
+ ### 1. Connection配置
248
+
249
+ **Web UI配置**:
250
+ 1. Admin -> Connections
251
+ 2. 添加Connection:
252
+ - Connection Id: `postgres_default`
253
+ - Connection Type: `Postgres`
254
+ - Host: `localhost`
255
+ - Port: `5432`
256
+ - Database: `airflow`
257
+ - Username: `airflow`
258
+ - Password: `airflow`
259
+
260
+ ### 2. 使用Hook
261
+
262
+ ```python
263
+ from airflow.providers.postgres.hooks.postgres import PostgresHook
264
+
265
+ def query_database():
266
+ hook = PostgresHook(postgres_conn_id='postgres_default')
267
+ df = hook.get_pandas_df("SELECT * FROM users")
268
+ return df.to_dict()
269
+
270
+ query_task = PythonOperator(
271
+ task_id='query_database',
272
+ python_callable=query_database
273
+ )
274
+ ```
275
+
276
+ ## 变量和配置
277
+
278
+ ### 1. Variables
279
+
280
+ ```python
281
+ from airflow.models import Variable
282
+
283
+ # 设置Variable (Web UI: Admin -> Variables)
284
+ # Variable.set('max_items', 100)
285
+
286
+ # 使用Variable
287
+ def use_variable():
288
+ max_items = Variable.get('max_items', default_var=50)
289
+ print(f"Max items: {max_items}")
290
+
291
+ # JSON Variable
292
+ config = Variable.get('config', deserialize_json=True)
293
+ ```
294
+
295
+ ### 2. Jinja模板
296
+
297
+ ```python
298
+ from airflow.operators.bash import BashOperator
299
+
300
+ templated_task = BashOperator(
301
+ task_id='templated_task',
302
+ bash_command='echo "Running {{ ds }}" with {{ params.my_param }}',
303
+ params={'my_param': 'custom_value'}
304
+ )
305
+ ```
306
+
307
+ ## 执行器配置
308
+
309
+ ### 1. SequentialExecutor (默认)
310
+ 单进程执行,适合开发。
311
+
312
+ ### 2. LocalExecutor
313
+ 多进程,适合单机生产。
314
+
315
+ ```python
316
+ # airflow.cfg
317
+ executor = LocalExecutor
318
+ sql_alchemy_conn = postgresql+psycopg2://airflow:airflow@localhost/airflow
319
+ ```
320
+
321
+ ### 3. CeleryExecutor
322
+ 分布式,适合大规模生产。
323
+
324
+ ```python
325
+ # airflow.cfg
326
+ executor = CeleryExecutor
327
+ broker_url = redis://localhost:6379/0
328
+ result_backend = db+postgresql://airflow:airflow@localhost/airflow
329
+ ```
330
+
331
+ ### 4. KubernetesExecutor
332
+ K8s原生,适合云环境。
333
+
334
+ ```python
335
+ # airflow.cfg
336
+ executor = KubernetesExecutor
337
+ kubernetes_namespace = airflow
338
+ ```
339
+
340
+ ## 监控和日志
341
+
342
+ ### 1. 日志配置
343
+
344
+ ```python
345
+ # airflow.cfg
346
+ [core]
347
+ logging_level = INFO
348
+ fab_logging_level = WARN
349
+
350
+ [logging]
351
+ base_log_folder = /path/to/logs
352
+ ```
353
+
354
+ ### 2. 自定义日志
355
+
356
+ ```python
357
+ import logging
358
+
359
+ def my_task(**kwargs):
360
+ logger = logging.getLogger(__name__)
361
+ logger.info("This is an info message")
362
+ logger.error("This is an error message")
363
+ ```
364
+
365
+ ### 3. Email告警
366
+
367
+ ```python
368
+ default_args = {
369
+ 'email': ['admin@example.com'],
370
+ 'email_on_failure': True,
371
+ 'email_on_retry': True,
372
+ }
373
+ ```
374
+
375
+ ## 性能优化
376
+
377
+ ### 1. 并行执行
378
+
379
+ ```python
380
+ from airflow.operators.python import PythonOperator
381
+
382
+ # 并行任务
383
+ parallel_tasks = [
384
+ PythonOperator(task_id=f'task_{i}', python_callable=lambda i=i: print(f"Task {i}"))
385
+ for i in range(10)
386
+ ]
387
+
388
+ # join
389
+ parallel_tasks >> final_task
390
+ ```
391
+
392
+ ### 2. 资源池
393
+
394
+ ```python
395
+ resource_task = PythonOperator(
396
+ task_id='resource_task',
397
+ python_callable=my_function,
398
+ pool='limited_pool' # 限制并发
399
+ )
400
+ ```
401
+
402
+ ### 3. 动态任务映射
403
+
404
+ ```python
405
+ def process_file(filename):
406
+ print(f"Processing {filename}")
407
+
408
+ files = ['file1.csv', 'file2.csv', 'file3.csv']
409
+
410
+ process_tasks = [
411
+ PythonOperator(
412
+ task_id=f'process_{file}',
413
+ python_callable=process_file,
414
+ op_kwargs={'filename': file}
415
+ )
416
+ for file in files
417
+ ]
418
+ ```
419
+
420
+ ## 最佳实践
421
+
422
+ ### ✅ DO
423
+
424
+ 1. **使用DAG上下文管理器**
425
+ ```python
426
+ with DAG(...) as dag:
427
+ # 定义任务
428
+ ```
429
+
430
+ 2. **提供默认参数**
431
+ ```python
432
+ default_args = {
433
+ 'owner': 'team',
434
+ 'retries': 3,
435
+ 'retry_delay': timedelta(minutes=5),
436
+ }
437
+ ```
438
+
439
+ 3. **添加有意义的标签**
440
+ ```python
441
+ with DAG(..., tags=['etl', 'production', 'critical']):
442
+ ```
443
+
444
+ 4. **使用XCom传递少量数据**
445
+ ```python
446
+ # ✅ 好: 少量数据
447
+ ti.xcom_push(key='record_count', value=1000)
448
+
449
+ # ❌ 差: 大量数据
450
+ ti.xcom_push(key='dataframe', value=large_df)
451
+ ```
452
+
453
+ ### ❌ DON'T
454
+
455
+ 1. **不要在顶层代码中写业务逻辑**
456
+ ```python
457
+ # ❌ 错误
458
+ result = query_database() # 每次解析DAG都会执行
459
+
460
+ def my_task():
461
+ # ✅ 正确
462
+ result = query_database()
463
+ ```
464
+
465
+ 2. **不要使用全局变量**
466
+ ```python
467
+ # ❌ 错误
468
+ GLOBAL_VAR = []
469
+
470
+ def my_task():
471
+ GLOBAL_VAR.append(1)
472
+ ```
473
+
474
+ 3. **不要硬编码敏感信息**
475
+ ```python
476
+ # ❌ 错误
477
+ password = "secret123"
478
+
479
+ # ✅ 正确: 使用Connection或Variable
480
+ password = Variable.get('db_password')
481
+ ```
482
+
483
+ ## 学习路径
484
+
485
+ ### 初级 (1周)
486
+ 1. Airflow架构和核心概念
487
+ 2. 第一个DAG
488
+ 3. 基础Operator使用
489
+
490
+ ### 中级 (2周)
491
+ 1. Sensor和XCom
492
+ 2. 动态DAG生成
493
+ 3. Hook和Connection
494
+
495
+ ### 高级 (2周)
496
+ 1. 自定义Operator
497
+ 2. 分布式执行器
498
+ 3. 性能优化
499
+
500
+ ### 专家级 (持续)
501
+ 1. 多租户架构
502
+ 2. 安全和权限管理
503
+ 3. 监控和故障排查
504
+
505
+ ## 参考资料
506
+
507
+ ### 官方文档
508
+ - [Airflow官方文档](https://airflow.apache.org/docs/)
509
+ - [Provider包](https://airflow.apache.org/docs/apache-airflow-providers/index.html)
510
+
511
+ ### 教程
512
+ - [Airflow教程](https://airflow.apache.org/docs/tutorial.html)
513
+ - [Astronomer指南](https://www.astronomer.io/guides/)
514
+
515
+ ---
516
+
517
+ **知识ID**: `airflow-complete`
518
+ **领域**: data-engineering
519
+ **类型**: standards
520
+ **难度**: intermediate
521
+ **质量分**: 92
522
+ **维护者**: data-team@umadev.com
523
+ **最后更新**: 2026-03-28