@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,612 @@
1
+ ---
2
+ title: 服务网格作战手册
3
+ version: 1.0.0
4
+ last_updated: 2025-03-20
5
+ owner: platform-team
6
+ tags: [service-mesh, istio, traffic-management, observability]
7
+ status: production
8
+ domain: cloud-native
9
+ difficulty: intermediate
10
+ quality_score: 70
11
+ ---
12
+
13
+ # 开发:Excellent(11964948@qq.com)
14
+ # 功能:服务网格实施与运维作战手册
15
+ # 作用:指导 Istio/Linkerd 服务网格的部署、配置和运维
16
+ # 创建时间:2025-03-20
17
+ # 最后修改:2025-03-20
18
+
19
+ ## 目标
20
+
21
+ 建立服务网格标准化运维流程,确保:
22
+ - 流量管理可控可观测
23
+ - 服务间通信安全
24
+ - 故障快速定位和恢复
25
+ - 渐进式发布能力
26
+
27
+ ## 适用场景
28
+
29
+ - 微服务流量管理
30
+ - 金丝雀/蓝绿发布
31
+ - 服务间 mTLS 加密
32
+ - 分布式追踪和可观测性
33
+ - 故障注入和混沌工程
34
+
35
+ ## 执行清单
36
+
37
+ ### 部署前准备
38
+
39
+ - [ ] 评估集群资源是否满足 Sidecar 开销(每 Pod 约增加 100MB 内存)
40
+ - [ ] 确定 Sidecar 资源配额
41
+ - [ ] 规划命名空间启用策略
42
+ - [ ] 准备监控和日志基础设施
43
+ - [ ] 制定回滚计划
44
+
45
+ ### Istio 安装
46
+
47
+ - [ ] 下载并验证 Istio 版本
48
+ - [ ] 配置 IstioOperator 自定义资源
49
+ - [ ] 安装控制平面
50
+ - [ ] 验证组件运行状态
51
+ - [ ] 配置自动 Sidecar 注入
52
+
53
+ ### 应用接入
54
+
55
+ - [ ] 标记命名空间启用注入
56
+ - [ ] 重启 Pod 注入 Sidecar
57
+ - [ ] 验证 Sidecar 运行状态
58
+ - [ ] 配置流量路由
59
+ - [ ] 启用 mTLS
60
+
61
+ ## 核心配置
62
+
63
+ ### 1. Istio 安装配置
64
+
65
+ ```yaml
66
+ apiVersion: install.istio.io/v1alpha1
67
+ kind: IstioOperator
68
+ metadata:
69
+ name: production-istio
70
+ namespace: istio-system
71
+ spec:
72
+ profile: default
73
+ components:
74
+ pilot:
75
+ enabled: true
76
+ k8s:
77
+ resources:
78
+ requests:
79
+ cpu: 500m
80
+ memory: 2Gi
81
+ limits:
82
+ cpu: 2000m
83
+ memory: 4Gi
84
+ hpaSpec:
85
+ minReplicas: 2
86
+ maxReplicas: 5
87
+ ingressGateways:
88
+ - name: istio-ingressgateway
89
+ enabled: true
90
+ k8s:
91
+ resources:
92
+ requests:
93
+ cpu: 500m
94
+ memory: 1Gi
95
+ limits:
96
+ cpu: 2000m
97
+ memory: 2Gi
98
+ hpaSpec:
99
+ minReplicas: 2
100
+ maxReplicas: 10
101
+ cni:
102
+ enabled: true
103
+ meshConfig:
104
+ accessLogFile: /dev/stdout
105
+ enableAutoMtls: true
106
+ defaultConfig:
107
+ proxyMetadata:
108
+ PROXY_CONFIG_TRACE: "verbose"
109
+ tracing:
110
+ zipkin:
111
+ address: zipkin.istio-system:9411
112
+ outboundTrafficPolicy:
113
+ mode: REGISTRY_ONLY
114
+ values:
115
+ global:
116
+ proxy:
117
+ resources:
118
+ requests:
119
+ cpu: 100m
120
+ memory: 128Mi
121
+ limits:
122
+ cpu: 500m
123
+ memory: 512Mi
124
+ sidecarInjectorWebhook:
125
+ rewriteAppHTTPProbe: true
126
+ ```
127
+
128
+ ### 2. 命名空间启用注入
129
+
130
+ ```yaml
131
+ apiVersion: v1
132
+ kind: Namespace
133
+ metadata:
134
+ name: production
135
+ labels:
136
+ istio-injection: enabled
137
+ ```
138
+
139
+ ### 3. Gateway 配置
140
+
141
+ ```yaml
142
+ apiVersion: networking.istio.io/v1beta1
143
+ kind: Gateway
144
+ metadata:
145
+ name: production-gateway
146
+ namespace: production
147
+ spec:
148
+ selector:
149
+ istio: ingressgateway
150
+ servers:
151
+ - port:
152
+ number: 80
153
+ name: http
154
+ protocol: HTTP
155
+ tls:
156
+ httpsRedirect: true
157
+ hosts:
158
+ - "*.example.com"
159
+ - port:
160
+ number: 443
161
+ name: https
162
+ protocol: HTTPS
163
+ tls:
164
+ mode: SIMPLE
165
+ credentialName: wildcard-tls
166
+ hosts:
167
+ - "*.example.com"
168
+ ```
169
+
170
+ ### 4. VirtualService 流量路由
171
+
172
+ ```yaml
173
+ apiVersion: networking.istio.io/v1beta1
174
+ kind: VirtualService
175
+ metadata:
176
+ name: api-service
177
+ namespace: production
178
+ spec:
179
+ hosts:
180
+ - api.example.com
181
+ gateways:
182
+ - production-gateway
183
+ http:
184
+ - match:
185
+ - headers:
186
+ x-canary:
187
+ exact: "true"
188
+ route:
189
+ - destination:
190
+ host: api-service
191
+ subset: canary
192
+ headers:
193
+ response:
194
+ add:
195
+ x-version: "v2"
196
+ - route:
197
+ - destination:
198
+ host: api-service
199
+ subset: stable
200
+ weight: 95
201
+ - destination:
202
+ host: api-service
203
+ subset: canary
204
+ weight: 5
205
+ timeout: 30s
206
+ retries:
207
+ attempts: 3
208
+ perTryTimeout: 10s
209
+ retryOn: gateway-error,connect-failure,refused-stream
210
+ ```
211
+
212
+ ### 5. DestinationRule 配置
213
+
214
+ ```yaml
215
+ apiVersion: networking.istio.io/v1beta1
216
+ kind: DestinationRule
217
+ metadata:
218
+ name: api-service
219
+ namespace: production
220
+ spec:
221
+ host: api-service
222
+ trafficPolicy:
223
+ connectionPool:
224
+ tcp:
225
+ maxConnections: 100
226
+ connectTimeout: 5s
227
+ http:
228
+ h2UpgradePolicy: UPGRADE
229
+ http1MaxPendingRequests: 100
230
+ http2MaxRequests: 1000
231
+ outlierDetection:
232
+ consecutive5xxErrors: 5
233
+ interval: 30s
234
+ baseEjectionTime: 60s
235
+ maxEjectionPercent: 50
236
+ minHealthPercent: 25
237
+ tls:
238
+ mode: ISTIO_MUTUAL
239
+ subsets:
240
+ - name: stable
241
+ labels:
242
+ version: v1
243
+ - name: canary
244
+ labels:
245
+ version: v2
246
+ ```
247
+
248
+ ### 6. 服务入口(外部服务)
249
+
250
+ ```yaml
251
+ apiVersion: networking.istio.io/v1beta1
252
+ kind: ServiceEntry
253
+ metadata:
254
+ name: external-api
255
+ namespace: production
256
+ spec:
257
+ hosts:
258
+ - external-api.example.com
259
+ ports:
260
+ - number: 443
261
+ name: https
262
+ protocol: HTTPS
263
+ location: MESH_EXTERNAL
264
+ resolution: DNS
265
+ ```
266
+
267
+ ### 7. 授权策略
268
+
269
+ ```yaml
270
+ apiVersion: security.istio.io/v1beta1
271
+ kind: AuthorizationPolicy
272
+ metadata:
273
+ name: api-service-policy
274
+ namespace: production
275
+ spec:
276
+ selector:
277
+ matchLabels:
278
+ app: api-service
279
+ action: ALLOW
280
+ rules:
281
+ - from:
282
+ - source:
283
+ principals:
284
+ - "cluster.local/ns/production/sa/frontend"
285
+ - "cluster.local/ns/production/sa/worker"
286
+ to:
287
+ - operation:
288
+ methods:
289
+ - GET
290
+ - POST
291
+ paths:
292
+ - /api/*
293
+ - /health
294
+ ```
295
+
296
+ ### 8. PeerAuthentication(mTLS)
297
+
298
+ ```yaml
299
+ apiVersion: security.istio.io/v1beta1
300
+ kind: PeerAuthentication
301
+ metadata:
302
+ name: production-mtls
303
+ namespace: production
304
+ spec:
305
+ mtls:
306
+ mode: STRICT
307
+ ```
308
+
309
+ ### 9. 故障注入测试
310
+
311
+ ```yaml
312
+ apiVersion: networking.istio.io/v1beta1
313
+ kind: VirtualService
314
+ metadata:
315
+ name: api-service-fault-injection
316
+ namespace: production
317
+ spec:
318
+ hosts:
319
+ - api-service
320
+ http:
321
+ - match:
322
+ - headers:
323
+ x-test-fault:
324
+ exact: "true"
325
+ fault:
326
+ delay:
327
+ percentage:
328
+ value: 100
329
+ fixedDelay: 5s
330
+ abort:
331
+ percentage:
332
+ value: 10
333
+ httpStatus: 500
334
+ route:
335
+ - destination:
336
+ host: api-service
337
+ - route:
338
+ - destination:
339
+ host: api-service
340
+ ```
341
+
342
+ ### 10. 请求限流
343
+
344
+ ```yaml
345
+ apiVersion: networking.istio.io/v1beta1
346
+ kind: EnvoyFilter
347
+ metadata:
348
+ name: rate-limit
349
+ namespace: production
350
+ spec:
351
+ workloadSelector:
352
+ labels:
353
+ app: api-service
354
+ configPatches:
355
+ - applyTo: HTTP_FILTER
356
+ match:
357
+ context: SIDECAR_INBOUND
358
+ patch:
359
+ operation: INSERT_BEFORE
360
+ value:
361
+ name: envoy.filters.http.local_ratelimit
362
+ typed_config:
363
+ "@type": type.googleapis.com/udpa.type.v1.TypedStruct
364
+ type_url: type.googleapis.com/envoy.extensions.filters.http.local_ratelimit.v3.LocalRateLimit
365
+ value:
366
+ stat_prefix: http_local_rate_limiter
367
+ token_bucket:
368
+ max_tokens: 100
369
+ tokens_per_fill: 100
370
+ fill_interval: 60s
371
+ filter_enabled:
372
+ runtime_key: local_rate_limit_enabled
373
+ default_value:
374
+ numerator: 100
375
+ denominator: HUNDRED
376
+ filter_enforced:
377
+ runtime_key: local_rate_limit_enforced
378
+ default_value:
379
+ numerator: 100
380
+ denominator: HUNDRED
381
+ response_headers_to_add:
382
+ - header:
383
+ key: x-rate-limited
384
+ value: "true"
385
+ ```
386
+
387
+ ## 最佳实践
388
+
389
+ ### 1. 金丝雀发布流程
390
+
391
+ ```yaml
392
+ # 第一阶段:1% 流量
393
+ apiVersion: networking.istio.io/v1beta1
394
+ kind: VirtualService
395
+ metadata:
396
+ name: api-service
397
+ spec:
398
+ http:
399
+ - route:
400
+ - destination:
401
+ host: api-service
402
+ subset: stable
403
+ weight: 99
404
+ - destination:
405
+ host: api-service
406
+ subset: canary
407
+ weight: 1
408
+
409
+ ---
410
+ # 第二阶段:10% 流量(观察指标后)
411
+ # weight: 90 / 10
412
+
413
+ ---
414
+ # 第三阶段:50% 流量(继续观察)
415
+ # weight: 50 / 50
416
+
417
+ ---
418
+ # 第四阶段:100% 流量(全量切换)
419
+ # weight: 0 / 100
420
+ ```
421
+
422
+ ### 2. 熔断配置
423
+
424
+ ```yaml
425
+ apiVersion: networking.istio.io/v1beta1
426
+ kind: DestinationRule
427
+ metadata:
428
+ name: api-service
429
+ spec:
430
+ host: api-service
431
+ trafficPolicy:
432
+ connectionPool:
433
+ tcp:
434
+ maxConnections: 100
435
+ http:
436
+ http1MaxPendingRequests: 100
437
+ http2MaxRequests: 1000
438
+ outlierDetection:
439
+ consecutive5xxErrors: 5
440
+ interval: 30s
441
+ baseEjectionTime: 60s
442
+ maxEjectionPercent: 50
443
+ ```
444
+
445
+ ### 3. 可观测性配置
446
+
447
+ ```yaml
448
+ # Prometheus 采集配置
449
+ apiVersion: v1
450
+ kind: ConfigMap
451
+ metadata:
452
+ name: prometheus-config
453
+ namespace: istio-system
454
+ data:
455
+ prometheus.yml: |
456
+ scrape_configs:
457
+ - job_name: 'istio-mesh'
458
+ kubernetes_sd_configs:
459
+ - role: pod
460
+ namespaces:
461
+ names:
462
+ - production
463
+ relabel_configs:
464
+ - source_labels: [__meta_kubernetes_pod_label_app]
465
+ action: keep
466
+ ```
467
+
468
+ ## 反模式
469
+
470
+ ### 禁止操作
471
+
472
+ ```yaml
473
+ # [FAIL] 禁止:所有流量立即切换
474
+ route:
475
+ - destination:
476
+ host: api-service
477
+ subset: canary
478
+ weight: 100 # 立即 100%
479
+
480
+ # [FAIL] 禁止:无超时配置
481
+ http:
482
+ - route:
483
+ - destination:
484
+ host: api-service
485
+ # 缺少 timeout
486
+
487
+ # [FAIL] 禁止:无熔断配置
488
+ # 缺少 outlierDetection
489
+
490
+ # [FAIL] 禁止:全量启用 mTLS 无灰度
491
+ spec:
492
+ mtls:
493
+ mode: STRICT # 直接全量开启
494
+
495
+ # [FAIL] 禁止:Sidecar 资源无限制
496
+ # 缺少 resources 配置
497
+ ```
498
+
499
+ ## 实战案例
500
+
501
+ ### 案例 1:渐进式金丝雀发布
502
+
503
+ ```bash
504
+ # 1. 部署新版本
505
+ kubectl apply -f deployment-v2.yaml
506
+
507
+ # 2. 配置 1% 流量
508
+ kubectl apply -f virtualservice-1pct.yaml
509
+
510
+ # 3. 监控关键指标 10 分钟
511
+ # - 错误率 < 0.1%
512
+ # - P99 延迟 < 200ms
513
+ # - 业务指标正常
514
+
515
+ # 4. 逐步放量:1% -> 10% -> 50% -> 100%
516
+ for weight in 10 50 100; do
517
+ kubectl patch virtualservice api-service \
518
+ --type=json \
519
+ -p="[{\"op\": \"replace\", \"path\": \"/spec/http/0/route/1/weight\", \"value\": $weight}]"
520
+
521
+ # 等待并监控
522
+ sleep 600
523
+ done
524
+
525
+ # 5. 下线旧版本
526
+ kubectl scale deployment api-service-v1 --replicas=0
527
+ ```
528
+
529
+ ### 案例 2:故障注入混沌测试
530
+
531
+ ```yaml
532
+ # 注入延迟测试服务韧性
533
+ apiVersion: networking.istio.io/v1beta1
534
+ kind: VirtualService
535
+ metadata:
536
+ name: api-service-chaos
537
+ spec:
538
+ hosts:
539
+ - api-service
540
+ http:
541
+ - match:
542
+ - headers:
543
+ x-chaos-test:
544
+ exact: "latency"
545
+ fault:
546
+ delay:
547
+ percentage:
548
+ value: 100
549
+ fixedDelay: 500ms
550
+ route:
551
+ - destination:
552
+ host: api-service
553
+ ```
554
+
555
+ ### 案例 3:紧急回滚
556
+
557
+ ```bash
558
+ # 发现问题时立即回滚
559
+ kubectl patch virtualservice api-service \
560
+ --type=json \
561
+ -p='[{"op": "replace", "path": "/spec/http/0/route/0/weight", "value": 100}]'
562
+
563
+ kubectl patch virtualservice api-service \
564
+ --type=json \
565
+ -p='[{"op": "replace", "path": "/spec/http/0/route/1/weight", "value": 0}]'
566
+
567
+ # 缩容新版本
568
+ kubectl scale deployment api-service-v2 --replicas=0
569
+ ```
570
+
571
+ ## 检查清单
572
+
573
+ ### 部署检查
574
+
575
+ - [ ] Istio 控制平面组件健康
576
+ - [ ] Sidecar 注入正常工作
577
+ - [ ] Gateway 配置正确
578
+ - [ ] VirtualService 路由规则生效
579
+ - [ ] mTLS 状态符合预期
580
+ - [ ] 授权策略配置正确
581
+ - [ ] 监控指标正常采集
582
+ - [ ] 追踪数据正常上报
583
+
584
+ ### 流量管理检查
585
+
586
+ - [ ] 超时配置合理(默认 30s)
587
+ - [ ] 重试策略配置正确
588
+ - [ ] 熔断配置生效
589
+ - [ ] 限流配置合理
590
+ - [ ] 金丝雀发布流程定义
591
+
592
+ ### 安全检查
593
+
594
+ - [ ] mTLS 已启用(STRICT 模式)
595
+ - [ ] 授权策略最小权限
596
+ - [ ] 外部服务访问受控
597
+ - [ ] 敏感流量已加密
598
+
599
+ ### 可观测性检查
600
+
601
+ - [ ] Prometheus 指标正常
602
+ - [ ] Jaeger/Zipkin 追踪正常
603
+ - [ ] Kiali 控制台可访问
604
+ - [ ] 日志正常输出
605
+
606
+ ## 参考资料
607
+
608
+ - [Istio 官方文档](https://istio.io/latest/docs/)
609
+ - [Istio 最佳实践](https://istio.io/latest/docs/ops/best-practices/)
610
+ - [Linkerd 文档](https://linkerd.io/2/overview/)
611
+ - [Envoy 配置参考](https://www.envoyproxy.io/docs/envoy/latest/)
612
+ - [服务网格模式](https://philcalcado.com/2017/08/03/pattern_service_mesh.html)