@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.
- package/00-governance/governance-capabilities.md +557 -0
- package/00-governance/knowledge-map.md +39 -0
- package/00-governance/maintenance-policy.md +76 -0
- package/00-governance/review-checklist.md +81 -0
- package/README.md +13 -0
- package/ai/01-standards/agent-development-complete.md +691 -0
- package/ai/01-standards/llm-application-complete.md +488 -0
- package/ai/01-standards/mlops-complete.md +798 -0
- package/ai/01-standards/prompt-engineering-complete.md +646 -0
- package/ai/01-standards/rag-architecture-complete.md +649 -0
- package/ai/02-playbooks/llm-evaluation-playbook.md +847 -0
- package/ai/03-checklists/ai-project-checklist.md +215 -0
- package/ai/04-antipatterns/ai-antipatterns.md +661 -0
- package/ai/05-cases/case-rag-production.md +147 -0
- package/ai/06-glossary/ai-glossary.md +162 -0
- package/ai/agent-evaluation-benchmark.md +53 -0
- package/ai/ai-agent-memory-context-management.md +41 -0
- package/ai/ai-cost-capacity-optimization-playbook.md +42 -0
- package/ai/ai-data-security-and-compliance-playbook.md +37 -0
- package/ai/ai-domain-index-and-checklist.md +40 -0
- package/ai/ai-governance-maturity-model.md +50 -0
- package/ai/ai-model-selection-and-routing-strategy.md +47 -0
- package/ai/ai-observability-and-oncall-runbook.md +52 -0
- package/ai/ai-rag-engineering-playbook.md +42 -0
- package/ai/ai-red-team-and-safety-evaluation.md +42 -0
- package/ai/ai-release-readiness-and-rollback-gate.md +42 -0
- package/ai/llm-agent-engineering-deep-dive.md +57 -0
- package/ai/prompt-and-tool-guardrails.md +52 -0
- package/api/01-standards/enterprise-api-standards.md +198 -0
- package/api/01-standards/rest-api-design-guide.md +63 -0
- package/api/02-playbooks/api-pagination-playbook.md +93 -0
- package/api/02-playbooks/graphql-production-playbook.md +176 -0
- package/api/03-checklists/api-review-checklist.md +55 -0
- package/api/04-antipatterns/api-antipatterns.md +112 -0
- package/architecture/01-standards/api-gateway-patterns.md +496 -0
- package/architecture/01-standards/cloud-native-patterns.md +644 -0
- package/architecture/01-standards/distributed-systems-patterns.md +591 -0
- package/architecture/01-standards/event-driven-architecture.md +595 -0
- package/architecture/01-standards/microservices-patterns-complete.md +968 -0
- package/architecture/01-standards/microservices-patterns.md +495 -0
- package/architecture/01-standards/system-design-interview.md +664 -0
- package/architecture/02-playbooks/microservices-patterns-playbook.md +137 -0
- package/architecture/02-playbooks/migration-playbook.md +780 -0
- package/architecture/02-playbooks/system-design-playbook.md +779 -0
- package/architecture/03-checklists/architecture-decision-checklist.md +297 -0
- package/architecture/04-antipatterns/architecture-antipatterns.md +417 -0
- package/architecture/05-cases/case-netflix-microservices.md +413 -0
- package/architecture/06-glossary/architecture-glossary.md +164 -0
- package/architecture/adr-template-and-examples.md +38 -0
- package/architecture/api-gateway-deep-dive.md +1291 -0
- package/architecture/configuration-management.md +1162 -0
- package/architecture/distributed-transactions.md +1220 -0
- package/architecture/microservices-complete.md +735 -0
- package/architecture/resilience-and-disaster-patterns.md +37 -0
- package/architecture/service-governance.md +1198 -0
- package/architecture/system-architecture-deep-dive.md +37 -0
- package/backend/01-standards/analytics-and-growth.md +65 -0
- package/backend/01-standards/api-and-error-conventions.md +120 -0
- package/backend/01-standards/application-layering-and-packaging.md +160 -0
- package/backend/01-standards/auth-implementation.md +104 -0
- package/backend/01-standards/backend-framework-idioms.md +74 -0
- package/backend/01-standards/background-jobs-and-async.md +66 -0
- package/backend/01-standards/caching-strategies-complete.md +390 -0
- package/backend/01-standards/config-and-observability.md +77 -0
- package/backend/01-standards/data-modeling-and-persistence.md +94 -0
- package/backend/01-standards/django-complete.md +1765 -0
- package/backend/01-standards/email-and-notifications.md +64 -0
- package/backend/01-standards/fastapi-complete.md +925 -0
- package/backend/01-standards/file-upload-and-storage.md +66 -0
- package/backend/01-standards/graphql-api-complete.md +416 -0
- package/backend/01-standards/llm-application-standard.md +78 -0
- package/backend/01-standards/message-queue-patterns.md +379 -0
- package/backend/01-standards/microservices-and-distributed.md +78 -0
- package/backend/01-standards/nestjs-complete.md +2167 -0
- package/backend/01-standards/payment-integration.md +80 -0
- package/backend/01-standards/rate-limiting-complete.md +451 -0
- package/backend/01-standards/realtime-and-websocket.md +65 -0
- package/backend/01-standards/search-and-filtering.md +64 -0
- package/backend/01-standards/spring-boot-complete.md +445 -0
- package/backend/02-playbooks/api-design-playbook.md +718 -0
- package/backend/02-playbooks/email-send-playbook.md +130 -0
- package/backend/02-playbooks/file-upload-s3-playbook.md +153 -0
- package/backend/02-playbooks/typescript-enterprise-playbook.md +133 -0
- package/backend/02-playbooks/websocket-realtime-playbook.md +154 -0
- package/backend/03-checklists/api-launch-checklist.md +189 -0
- package/backend/04-antipatterns/backend-antipatterns.md +1051 -0
- package/blockchain/01-standards/blockchain-basics.md +557 -0
- package/blockchain/01-standards/smart-contract-development.md +1315 -0
- package/cicd/01-standards/deployment-and-delivery-standard.md +96 -0
- package/cicd/01-standards/github-actions-complete.md +473 -0
- package/cicd/01-standards/release-and-store-submission.md +75 -0
- package/cicd/02-playbooks/cicd-pipeline-playbook.md +144 -0
- package/cicd/02-playbooks/release-management-playbook.md +605 -0
- package/cicd/03-checklists/pipeline-security-checklist.md +168 -0
- package/cicd/04-antipatterns/cicd-antipatterns.md +589 -0
- package/cicd/05-cases/case-deployment-automation.md +221 -0
- package/cicd/05-cases/case-gitops-transformation.md +212 -0
- package/cicd/06-glossary/cicd-glossary.md +114 -0
- package/cicd/cicd-blueprint-deep-dive.md +38 -0
- package/cicd/release-readiness-gate.md +37 -0
- package/cloud-native/01-standards/container-security.md +741 -0
- package/cloud-native/01-standards/kubernetes-complete.md +812 -0
- package/cloud-native/02-playbooks/api-gateway-playbook.md +155 -0
- package/cloud-native/02-playbooks/gitops-with-argocd.md +760 -0
- package/cloud-native/02-playbooks/k8s-troubleshooting-playbook.md +1942 -0
- package/cloud-native/02-playbooks/message-queue-playbook.md +129 -0
- package/cloud-native/02-playbooks/multicloud-governance.md +726 -0
- package/cloud-native/02-playbooks/serverless-patterns.md +788 -0
- package/cloud-native/02-playbooks/service-mesh-playbook.md +612 -0
- package/cloud-native/02-playbooks/terraform-iac-playbook.md +143 -0
- package/cloud-native/03-checklists/container-security-checklist.md +431 -0
- package/cloud-native/03-checklists/k8s-production-readiness-checklist.md +460 -0
- package/cloud-native/04-antipatterns/container-antipatterns.md +660 -0
- package/cloud-native/04-antipatterns/k8s-antipatterns.md +743 -0
- package/cloud-native/05-cases/case-k8s-migration.md +478 -0
- package/cloud-native/05-cases/case-k8s-scaling.md +642 -0
- package/cloud-native/05-cases/case-k8s-security-incident.md +397 -0
- package/cloud-native/06-glossary/cloud-native-glossary.md +337 -0
- package/cross-platform/01-standards/cross-platform-frameworks.md +83 -0
- package/cross-platform/01-standards/platform-selection-and-architecture.md +77 -0
- package/data/01-standards/elasticsearch-complete.md +2098 -0
- package/data/01-standards/postgresql-complete.md +1613 -0
- package/data/01-standards/redis-complete.md +1527 -0
- package/data/02-playbooks/database-optimization-playbook.md +403 -0
- package/data/02-playbooks/elasticsearch-production-playbook.md +132 -0
- package/data/03-checklists/database-launch-checklist.md +187 -0
- package/data/04-antipatterns/database-antipatterns.md +873 -0
- package/data/05-cases/case-database-migration.md +310 -0
- package/data/06-glossary/database-glossary.md +440 -0
- package/data/data-governance-and-modeling-deep-dive.md +39 -0
- package/data-engineering/01-standards/airflow-complete.md +523 -0
- package/data-engineering/01-standards/kafka-complete.md +1521 -0
- package/data-engineering/02-playbooks/spark-etl-playbook.md +496 -0
- package/data-engineering/03-checklists/pipeline-launch-checklist.md +194 -0
- package/data-engineering/04-antipatterns/data-pipeline-antipatterns.md +684 -0
- package/data-engineering/05-cases/case-real-time-pipeline.md +355 -0
- package/data-engineering/06-glossary/data-engineering-glossary.md +429 -0
- package/database/01-standards/database-schema-standards.md +147 -0
- package/database/02-playbooks/postgresql-optimization-quick.md +52 -0
- package/database/02-playbooks/postgresql-performance-optimization.md +58 -0
- package/database/02-playbooks/postgresql-production-playbook.md +146 -0
- package/database/02-playbooks/redis-caching-playbook.md +117 -0
- package/database/03-checklists/database-review-checklist.md +50 -0
- package/database/04-antipatterns/database-antipatterns.md +112 -0
- package/design/01-standards/ui-design-system-complete.md +423 -0
- package/design/02-playbooks/design-handoff-playbook.md +254 -0
- package/design/02-playbooks/design-review-playbook.md +388 -0
- package/design/03-checklists/design-review-checklist.md +246 -0
- package/design/04-antipatterns/design-antipatterns.md +378 -0
- package/design/05-cases/case-design-system-adoption.md +328 -0
- package/design/06-glossary/design-glossary.md +329 -0
- package/design/ui-full-lifecycle-cross-platform-playbook.md +571 -0
- package/design/ux-system-deep-dive.md +38 -0
- package/design-systems/00-craft-rules.md +71 -0
- package/design-systems/aesthetic-families.md +43 -0
- package/design-systems/anti-ai-slop.md +162 -0
- package/design-systems/bold-geometric.md +120 -0
- package/design-systems/brutalist-bold.md +103 -0
- package/design-systems/editorial-clean.md +109 -0
- package/design-systems/glass-aurora.md +108 -0
- package/design-systems/modern-minimal.md +145 -0
- package/design-systems/premium-luxury.md +106 -0
- package/design-systems/product-type-design-map.md +48 -0
- package/design-systems/soft-warm.md +123 -0
- package/design-systems/tech-utility.md +113 -0
- package/desktop/01-standards/desktop-app-standard.md +72 -0
- package/desktop/01-standards/desktop-design.md +71 -0
- package/development/00-governance/document-template.md +41 -0
- package/development/01-standards/api-versioning-strategies.md +432 -0
- package/development/01-standards/authentication-patterns-complete.md +479 -0
- package/development/01-standards/css-architecture-complete.md +550 -0
- package/development/01-standards/database-migration-strategies.md +484 -0
- package/development/01-standards/elasticsearch-complete.md +347 -0
- package/development/01-standards/git-complete.md +371 -0
- package/development/01-standards/golang-complete.md +1565 -0
- package/development/01-standards/graphql-complete.md +298 -0
- package/development/01-standards/javascript-bundlers-complete.md +469 -0
- package/development/01-standards/javascript-typescript-complete.md +528 -0
- package/development/01-standards/jest-complete.md +275 -0
- package/development/01-standards/linux-complete.md +234 -0
- package/development/01-standards/logging-observability-complete.md +526 -0
- package/development/01-standards/microservices-communication.md +502 -0
- package/development/01-standards/mongodb-complete.md +406 -0
- package/development/01-standards/oauth2-complete.md +285 -0
- package/development/01-standards/performance-optimization-complete.md +289 -0
- package/development/01-standards/playwright-complete.md +247 -0
- package/development/01-standards/postgresql-complete.md +456 -0
- package/development/01-standards/pytest-complete.md +340 -0
- package/development/01-standards/python-async-programming.md +902 -0
- package/development/01-standards/python-complete.md +956 -0
- package/development/01-standards/python-decorators-complete.md +799 -0
- package/development/01-standards/python-design-patterns.md +2854 -0
- package/development/01-standards/python-packaging-distribution.md +420 -0
- package/development/01-standards/python-testing-strategies.md +607 -0
- package/development/01-standards/python-web-frameworks-comparison.md +471 -0
- package/development/01-standards/redis-complete.md +317 -0
- package/development/01-standards/rest-api-complete.md +316 -0
- package/development/01-standards/rust-complete.md +578 -0
- package/development/01-standards/typescript-advanced-types.md +1513 -0
- package/development/01-standards/web-security-complete.md +292 -0
- package/development/02-playbooks/api-design-playbook.md +810 -0
- package/development/02-playbooks/database-migration-playbook.md +580 -0
- package/development/02-playbooks/debugging-playbook.md +692 -0
- package/development/02-playbooks/feature-delivery-playbook.md +430 -0
- package/development/02-playbooks/incident-hotfix-playbook.md +387 -0
- package/development/02-playbooks/performance-optimization-playbook.md +531 -0
- package/development/02-playbooks/performance-tuning-playbook.md +652 -0
- package/development/02-playbooks/refactor-playbook.md +403 -0
- package/development/02-playbooks/release-playbook.md +469 -0
- package/development/03-checklists/architecture-review-checklist.md +168 -0
- package/development/03-checklists/data-migration-checklist.md +157 -0
- package/development/03-checklists/oncall-handover-checklist.md +173 -0
- package/development/03-checklists/pr-checklist.md +158 -0
- package/development/03-checklists/production-readiness-checklist.md +190 -0
- package/development/03-checklists/release-readiness-checklist.md +154 -0
- package/development/03-checklists/security-review-checklist.md +182 -0
- package/development/04-antipatterns/api-antipatterns.md +657 -0
- package/development/04-antipatterns/architecture-antipatterns.md +686 -0
- package/development/04-antipatterns/backend-antipatterns.md +648 -0
- package/development/04-antipatterns/cicd-antipatterns.md +540 -0
- package/development/04-antipatterns/code-smell-antipatterns.md +571 -0
- package/development/04-antipatterns/data-antipatterns.md +658 -0
- package/development/04-antipatterns/database-antipatterns.md +578 -0
- package/development/04-antipatterns/frontend-antipatterns.md +635 -0
- package/development/04-antipatterns/reliability-antipatterns.md +700 -0
- package/development/04-antipatterns/security-antipatterns.md +747 -0
- package/development/05-cases/case-api-version-migration.md +428 -0
- package/development/05-cases/case-authorization-hardening.md +383 -0
- package/development/05-cases/case-bluegreen-rollback.md +466 -0
- package/development/05-cases/case-cache-snowball-protection.md +485 -0
- package/development/05-cases/case-ci-cd-pipeline.md +544 -0
- package/development/05-cases/case-database-scaling.md +500 -0
- package/development/05-cases/case-db-hotspot-optimization.md +487 -0
- package/development/05-cases/case-incident-mttr-reduction.md +563 -0
- package/development/05-cases/case-microservice-migration.md +375 -0
- package/development/05-cases/case-performance-optimization.md +406 -0
- package/development/05-cases/case-security-incident-response.md +345 -0
- package/development/06-glossary/full-stack-glossary.md +166 -0
- package/development/09-maturity/quarterly-audit-template.md +35 -0
- package/development/11-ui-excellence/ui-aesthetic-system.md +41 -0
- package/development/11-ui-excellence/ui-engineering-excellence.md +435 -0
- package/development/12-scenarios/development-scenarios-guide.md +565 -0
- package/development/13-implementation-assets/implementation-toolkit.md +282 -0
- package/development/13-implementation-assets/knowledge-gates-execution.md +43 -0
- package/development/14-full-lifecycle/software-lifecycle-gates.md +511 -0
- package/development/15-lifecycle-templates/project-templates-collection.md +791 -0
- package/development/api-contract-and-versioning-guide.md +36 -0
- package/development/api-governance-complete.md +43 -0
- package/development/backend-engineering-complete.md +43 -0
- package/development/code-review-quality-complete.md +43 -0
- package/development/concurrency-reliability-complete.md +43 -0
- package/development/database-engineering-complete.md +43 -0
- package/development/engineering-effectiveness-complete.md +43 -0
- package/development/engineering-standards-deep-dive.md +38 -0
- package/development/frontend-engineering-complete.md +43 -0
- package/development/performance-capacity-complete.md +43 -0
- package/development/refactor-migration-complete.md +42 -0
- package/development/refactoring-and-techdebt-playbook.md +37 -0
- package/development/security-in-development-complete.md +43 -0
- package/devops/01-standards/cicd-pipeline-complete.md +262 -0
- package/devops/01-standards/docker-complete.md +1490 -0
- package/devops/01-standards/github-actions-complete.md +337 -0
- package/devops/01-standards/kubernetes-complete.md +638 -0
- package/devops/01-standards/terraform-complete.md +2117 -0
- package/devops/02-playbooks/docker-compose-playbook.md +233 -0
- package/devops/02-playbooks/docker-k8s-production-playbook.md +186 -0
- package/devops/02-playbooks/docker-production-playbook.md +952 -0
- package/edge-iot/01-standards/edge-iot-complete.md +473 -0
- package/experts/architect/api-design.md +178 -0
- package/experts/architect/methodology.md +124 -0
- package/experts/architect/security.md +75 -0
- package/experts/backend-lead/methodology.md +216 -0
- package/experts/devops/methodology.md +160 -0
- package/experts/frontend-lead/methodology.md +178 -0
- package/experts/product-manager/industry/ecommerce.md +43 -0
- package/experts/product-manager/industry/saas.md +40 -0
- package/experts/product-manager/methodology.md +97 -0
- package/experts/qa-lead/methodology.md +123 -0
- package/experts/qa-lead/test-strategy.md +128 -0
- package/experts/uiux-designer/methodology.md +125 -0
- package/frontend/01-standards/accessibility-complete.md +532 -0
- package/frontend/01-standards/accessibility-standard.md +74 -0
- package/frontend/01-standards/admin-dashboard-and-crud.md +72 -0
- package/frontend/01-standards/design-tokens-complete.md +444 -0
- package/frontend/01-standards/forms-and-validation.md +77 -0
- package/frontend/01-standards/frontend-architecture-and-layering.md +119 -0
- package/frontend/01-standards/i18n-and-localization.md +65 -0
- package/frontend/01-standards/nextjs-complete.md +451 -0
- package/frontend/01-standards/react-complete.md +713 -0
- package/frontend/01-standards/react-hooks-complete-guide.md +1100 -0
- package/frontend/01-standards/react-hooks-complete.md +1171 -0
- package/frontend/01-standards/seo-and-web-vitals.md +77 -0
- package/frontend/01-standards/state-management-complete.md +444 -0
- package/frontend/01-standards/vue-complete.md +499 -0
- package/frontend/01-standards/vue3-complete.md +2002 -0
- package/frontend/01-standards/web-framework-best-practices.md +64 -0
- package/frontend/01-standards/web-performance-complete.md +495 -0
- package/frontend/02-playbooks/accessibility-a11y-playbook.md +161 -0
- package/frontend/02-playbooks/frontend-performance-playbook.md +707 -0
- package/frontend/02-playbooks/i18n-internationalization-playbook.md +120 -0
- package/frontend/02-playbooks/performance-optimization-playbook.md +163 -0
- package/frontend/02-playbooks/react-nextjs-production-playbook.md +167 -0
- package/frontend/02-playbooks/react-state-management-playbook.md +173 -0
- package/frontend/03-checklists/component-quality-checklist.md +166 -0
- package/frontend/03-checklists/frontend-launch-checklist.md +299 -0
- package/frontend/04-antipatterns/frontend-antipatterns.md +886 -0
- package/frontend/05-cases/case-performance-optimization.md +274 -0
- package/harmony/01-standards/harmonyos-arkts-standard.md +75 -0
- package/harmony/01-standards/harmonyos-design.md +65 -0
- package/high-quality-engineering-playbook.md +54 -0
- package/incident/01-standards/incident-response-complete.md +303 -0
- package/incident/02-playbooks/chaos-engineering-playbook.md +883 -0
- package/incident/02-playbooks/postmortem-playbook.md +398 -0
- package/incident/03-checklists/incident-readiness-checklist.md +181 -0
- package/incident/04-antipatterns/incident-antipatterns.md +490 -0
- package/incident/05-cases/case-cascade-failure.md +176 -0
- package/incident/06-glossary/incident-glossary.md +114 -0
- package/incident/postmortem-and-response-deep-dive.md +39 -0
- package/industries/ecommerce/ecommerce-complete.md +631 -0
- package/industries/education/education-complete.md +555 -0
- package/industries/fintech/fintech-complete.md +501 -0
- package/industries/gaming/gaming-complete.md +587 -0
- package/industries/healthcare/healthcare-complete.md +452 -0
- package/low-code/01-standards/low-code-complete.md +944 -0
- package/miniprogram/01-standards/ai-common-mistakes.md +61 -0
- package/miniprogram/01-standards/miniprogram-custom-navbar-capsule.md +77 -0
- package/miniprogram/01-standards/miniprogram-design.md +61 -0
- package/miniprogram/01-standards/miniprogram-standard.md +81 -0
- package/mobile/01-standards/android-material-design.md +70 -0
- package/mobile/01-standards/flutter-complete.md +384 -0
- package/mobile/01-standards/ios-design-hig.md +78 -0
- package/mobile/01-standards/mobile-app-standard.md +85 -0
- package/mobile/01-standards/react-native-complete.md +352 -0
- package/mobile/02-playbooks/mobile-cross-platform-playbook.md +175 -0
- package/mobile/02-playbooks/mobile-performance.md +473 -0
- package/mobile/03-checklists/mobile-release-checklist.md +234 -0
- package/mobile/04-antipatterns/mobile-antipatterns.md +798 -0
- package/mobile/05-cases/case-app-performance.md +500 -0
- package/mobile/05-cases/case-app-startup-optimization.md +218 -0
- package/mobile/06-glossary/mobile-glossary.md +484 -0
- package/observability/01-standards/observability-standards.md +103 -0
- package/observability/02-playbooks/prometheus-grafana-playbook.md +135 -0
- package/observability/02-playbooks/structured-logging-playbook.md +73 -0
- package/observability/03-checklists/observability-checklist.md +54 -0
- package/observability/04-antipatterns/observability-antipatterns.md +106 -0
- package/operations/01-standards/prometheus-monitoring-complete.md +1578 -0
- package/operations/02-playbooks/capacity-planning-playbook.md +620 -0
- package/operations/03-checklists/production-launch-checklist.md +365 -0
- package/operations/04-antipatterns/operations-antipatterns.md +664 -0
- package/operations/05-cases/case-sre-practices.md +581 -0
- package/operations/06-glossary/operations-glossary.md +120 -0
- package/operations/aiops-anomaly-detection.md +758 -0
- package/operations/capacity-planning.md +1061 -0
- package/operations/chaos-engineering.md +659 -0
- package/operations/incident-command-system.md +38 -0
- package/operations/observability-complete.md +442 -0
- package/operations/slo-sli-playbook.md +517 -0
- package/operations/sre-operations-deep-dive.md +39 -0
- package/package.json +8 -0
- package/performance/01-standards/performance-and-scalability.md +80 -0
- package/performance/01-standards/performance-standards.md +156 -0
- package/performance/02-playbooks/query-optimization-playbook.md +103 -0
- package/performance/03-checklists/performance-checklist.md +56 -0
- package/performance/04-antipatterns/performance-antipatterns.md +146 -0
- package/product/01-standards/product-management-complete.md +285 -0
- package/product/02-playbooks/feature-launch-playbook.md +207 -0
- package/product/02-playbooks/user-research-playbook.md +532 -0
- package/product/03-checklists/feature-launch-checklist.md +275 -0
- package/product/04-antipatterns/product-antipatterns.md +355 -0
- package/product/05-cases/case-mvp-to-scale.md +384 -0
- package/product/06-glossary/product-glossary.md +462 -0
- package/product/feature-prioritization-framework.md +40 -0
- package/product/kpi-and-metric-tree.md +37 -0
- package/product/product-discovery-and-prd-deep-dive.md +41 -0
- package/quantum/01-standards/quantum-complete.md +1186 -0
- package/security/01-standards/api-security-complete.md +511 -0
- package/security/01-standards/container-runtime-security.md +574 -0
- package/security/01-standards/data-protection-gdpr.md +543 -0
- package/security/01-standards/owasp-top10-complete.md +1890 -0
- package/security/01-standards/secure-coding-baseline.md +90 -0
- package/security/01-standards/supply-chain-security.md +441 -0
- package/security/01-standards/web-security-checklist.md +108 -0
- package/security/01-standards/zero-trust-architecture.md +521 -0
- package/security/02-playbooks/auth-sso-playbook.md +166 -0
- package/security/02-playbooks/incident-response-security-playbook.md +588 -0
- package/security/02-playbooks/owasp-api-security-playbook.md +129 -0
- package/security/02-playbooks/payment-integration-playbook.md +119 -0
- package/security/02-playbooks/penetration-testing-playbook.md +517 -0
- package/security/03-checklists/security-audit-checklist.md +356 -0
- package/security/04-antipatterns/security-coding-antipatterns.md +580 -0
- package/security/05-cases/case-log4shell-incident.md +537 -0
- package/security/05-cases/case-major-breaches.md +468 -0
- package/security/06-glossary/security-glossary.md +212 -0
- package/security/compliance-automation.md +993 -0
- package/security/container-security.md +680 -0
- package/security/devsecops-complete.md +426 -0
- package/security/sast-dast-sca.md +775 -0
- package/security/secrets-management.md +594 -0
- package/security/security-architecture-deep-dive.md +37 -0
- package/security/threat-modeling-stride-playbook.md +40 -0
- package/seed-templates/auth-system.md +59 -0
- package/seed-templates/blog-content.md +94 -0
- package/seed-templates/dashboard.md +89 -0
- package/seed-templates/docs-site.md +73 -0
- package/seed-templates/e-commerce.md +50 -0
- package/seed-templates/saas-landing.md +92 -0
- package/seed-templates/settings-page.md +51 -0
- package/testing/01-standards/test-strategy-and-layering.md +83 -0
- package/testing/01-standards/testing-strategy-complete.md +422 -0
- package/testing/01-standards/unit-testing-best-practices.md +118 -0
- package/testing/02-playbooks/e2e-testing-playbook.md +988 -0
- package/testing/02-playbooks/testing-strategy-playbook.md +126 -0
- package/testing/03-checklists/test-strategy-checklist.md +208 -0
- package/testing/04-antipatterns/testing-antipatterns.md +718 -0
- package/testing/05-cases/case-testing-transformation.md +300 -0
- package/testing/06-glossary/testing-glossary.md +110 -0
- package/testing/risk-based-test-matrix.md +36 -0
- package/testing/testing-strategy-deep-dive.md +37 -0
|
@@ -0,0 +1,233 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: docker-compose-playbook
|
|
3
|
+
title: Docker Compose完整指南
|
|
4
|
+
domain: devops
|
|
5
|
+
category: 02-playbooks
|
|
6
|
+
difficulty: intermediate
|
|
7
|
+
tags: [compose, devops, docker, playbook, 学习路径, 最佳实践, 核心概念, 概述]
|
|
8
|
+
quality_score: 70
|
|
9
|
+
last_updated: 2026-06-15
|
|
10
|
+
---
|
|
11
|
+
# Docker Compose完整指南
|
|
12
|
+
|
|
13
|
+
## 概述
|
|
14
|
+
Docker Compose是多容器Docker应用定义和运行工具。本指南覆盖服务编排、网络、卷管理和最佳实践。
|
|
15
|
+
|
|
16
|
+
## 核心概念
|
|
17
|
+
|
|
18
|
+
### 1. 基础配置
|
|
19
|
+
|
|
20
|
+
**docker-compose.yml**:
|
|
21
|
+
```yaml
|
|
22
|
+
version: '3.8'
|
|
23
|
+
|
|
24
|
+
services:
|
|
25
|
+
web:
|
|
26
|
+
build: .
|
|
27
|
+
ports:
|
|
28
|
+
- "8000:8000"
|
|
29
|
+
environment:
|
|
30
|
+
- DATABASE_URL=postgresql://user:pass@db:5432/mydb
|
|
31
|
+
depends_on:
|
|
32
|
+
- db
|
|
33
|
+
- redis
|
|
34
|
+
networks:
|
|
35
|
+
- backend
|
|
36
|
+
|
|
37
|
+
db:
|
|
38
|
+
image: postgres:15-alpine
|
|
39
|
+
environment:
|
|
40
|
+
POSTGRES_DB: mydb
|
|
41
|
+
POSTGRES_USER: user
|
|
42
|
+
POSTGRES_PASSWORD: pass
|
|
43
|
+
volumes:
|
|
44
|
+
- postgres_data:/var/lib/postgresql/data
|
|
45
|
+
networks:
|
|
46
|
+
- backend
|
|
47
|
+
|
|
48
|
+
redis:
|
|
49
|
+
image: redis:7-alpine
|
|
50
|
+
networks:
|
|
51
|
+
- backend
|
|
52
|
+
|
|
53
|
+
volumes:
|
|
54
|
+
postgres_data:
|
|
55
|
+
|
|
56
|
+
networks:
|
|
57
|
+
backend:
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### 2. 常用命令
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
# 启动服务
|
|
64
|
+
docker-compose up -d
|
|
65
|
+
|
|
66
|
+
# 查看服务状态
|
|
67
|
+
docker-compose ps
|
|
68
|
+
|
|
69
|
+
# 查看日志
|
|
70
|
+
docker-compose logs -f
|
|
71
|
+
|
|
72
|
+
# 停止服务
|
|
73
|
+
docker-compose down
|
|
74
|
+
|
|
75
|
+
# 重建服务
|
|
76
|
+
docker-compose up -d --build
|
|
77
|
+
|
|
78
|
+
# 进入容器
|
|
79
|
+
docker-compose exec web /bin/bash
|
|
80
|
+
|
|
81
|
+
# 运行命令
|
|
82
|
+
docker-compose run web python manage.py migrate
|
|
83
|
+
|
|
84
|
+
# 扩展服务
|
|
85
|
+
docker-compose up -d --scale worker=3
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### 3. 环境变量
|
|
89
|
+
|
|
90
|
+
```yaml
|
|
91
|
+
services:
|
|
92
|
+
web:
|
|
93
|
+
image: myapp
|
|
94
|
+
environment:
|
|
95
|
+
- NODE_ENV=production
|
|
96
|
+
- DB_HOST=${DB_HOST}
|
|
97
|
+
env_file:
|
|
98
|
+
- .env
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### 4. 卷管理
|
|
102
|
+
|
|
103
|
+
```yaml
|
|
104
|
+
services:
|
|
105
|
+
web:
|
|
106
|
+
volumes:
|
|
107
|
+
# 命名卷
|
|
108
|
+
- data_volume:/app/data
|
|
109
|
+
# 绑定挂载
|
|
110
|
+
- ./app:/app
|
|
111
|
+
# 匿名卷
|
|
112
|
+
- /app/node_modules
|
|
113
|
+
|
|
114
|
+
volumes:
|
|
115
|
+
data_volume:
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### 5. 网络配置
|
|
119
|
+
|
|
120
|
+
```yaml
|
|
121
|
+
services:
|
|
122
|
+
web:
|
|
123
|
+
networks:
|
|
124
|
+
- frontend
|
|
125
|
+
- backend
|
|
126
|
+
|
|
127
|
+
db:
|
|
128
|
+
networks:
|
|
129
|
+
- backend
|
|
130
|
+
|
|
131
|
+
networks:
|
|
132
|
+
frontend:
|
|
133
|
+
backend:
|
|
134
|
+
internal: true # 内部网络
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### 6. 健康检查
|
|
138
|
+
|
|
139
|
+
```yaml
|
|
140
|
+
services:
|
|
141
|
+
web:
|
|
142
|
+
image: myapp
|
|
143
|
+
healthcheck:
|
|
144
|
+
test: ["CMD", "curl", "-f", "http://localhost:8000/health"]
|
|
145
|
+
interval: 30s
|
|
146
|
+
timeout: 10s
|
|
147
|
+
retries: 3
|
|
148
|
+
start_period: 40s
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### 7. 资源限制
|
|
152
|
+
|
|
153
|
+
```yaml
|
|
154
|
+
services:
|
|
155
|
+
web:
|
|
156
|
+
image: myapp
|
|
157
|
+
deploy:
|
|
158
|
+
resources:
|
|
159
|
+
limits:
|
|
160
|
+
cpus: '0.5'
|
|
161
|
+
memory: 512M
|
|
162
|
+
reservations:
|
|
163
|
+
cpus: '0.25'
|
|
164
|
+
memory: 256M
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
## 最佳实践
|
|
168
|
+
|
|
169
|
+
### ✅ DO
|
|
170
|
+
|
|
171
|
+
1. **使用健康检查**
|
|
172
|
+
```yaml
|
|
173
|
+
healthcheck:
|
|
174
|
+
test: ["CMD", "curl", "-f", "http://localhost/health"]
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
2. **明确指定版本**
|
|
178
|
+
```yaml
|
|
179
|
+
image: postgres:15-alpine # ✅ 好
|
|
180
|
+
image: postgres # ❌ 差
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
3. **使用命名卷持久化数据**
|
|
184
|
+
```yaml
|
|
185
|
+
volumes:
|
|
186
|
+
db_data:
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### ❌ DON'T
|
|
190
|
+
|
|
191
|
+
1. **不要使用latest标签**
|
|
192
|
+
```yaml
|
|
193
|
+
image: myapp:latest # ❌ 差
|
|
194
|
+
image: myapp:v1.2.3 # ✅ 好
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
2. **不要在compose中硬编码密码**
|
|
198
|
+
```yaml
|
|
199
|
+
# ❌ 差
|
|
200
|
+
environment:
|
|
201
|
+
- DB_PASSWORD=mypassword
|
|
202
|
+
|
|
203
|
+
# ✅ 好
|
|
204
|
+
env_file:
|
|
205
|
+
- .env
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
## 学习路径
|
|
209
|
+
|
|
210
|
+
### 初级 (1周)
|
|
211
|
+
1. 基础配置
|
|
212
|
+
2. 常用命令
|
|
213
|
+
3. 服务管理
|
|
214
|
+
|
|
215
|
+
### 中级 (1-2周)
|
|
216
|
+
1. 网络配置
|
|
217
|
+
2. 卷管理
|
|
218
|
+
3. 环境变量
|
|
219
|
+
|
|
220
|
+
### 高级 (2-3周)
|
|
221
|
+
1. 多环境配置
|
|
222
|
+
2. 生产部署
|
|
223
|
+
3. 性能调优
|
|
224
|
+
|
|
225
|
+
---
|
|
226
|
+
|
|
227
|
+
**知识ID**: `docker-compose-complete`
|
|
228
|
+
**领域**: devops
|
|
229
|
+
**类型**: playbooks
|
|
230
|
+
**难度**: beginner
|
|
231
|
+
**质量分**: 92
|
|
232
|
+
**维护者**: devops-team@umadev.com
|
|
233
|
+
**最后更新**: 2026-03-28
|
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: docker-k8s-production-playbook
|
|
3
|
+
title: Docker/Kubernetes 生产安全手册
|
|
4
|
+
domain: devops
|
|
5
|
+
category: 02-playbooks
|
|
6
|
+
difficulty: advanced
|
|
7
|
+
tags: [devops, docker, kubernetes, k8s, security, multi-stage, non-root, secrets, scanning, rbac, network-policy, tls, enterprise]
|
|
8
|
+
quality_score: 94
|
|
9
|
+
maintainer: devops-team@umadev.com
|
|
10
|
+
last_updated: 2026-06-14
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Docker/Kubernetes 生产安全手册
|
|
14
|
+
|
|
15
|
+
> 基于 [Tigera Container Security 2025](https://www.tigera.io/learn/guides/container-security-best-practices/) + [Sysdig 17 Best Practices](https://www.sysdig.com/learn-cloud-native/container-security-best-practices) + [ThinkSys Docker Guide](https://thinksys.com/devops/docker-best-practices/)
|
|
16
|
+
|
|
17
|
+
## Docker 五大生产原则
|
|
18
|
+
|
|
19
|
+
### 1. 永远不以 root 运行
|
|
20
|
+
```dockerfile
|
|
21
|
+
# ❌ 默认 root(容器逃逸 = 主机 root)
|
|
22
|
+
FROM node:20
|
|
23
|
+
CMD ["node", "server.js"]
|
|
24
|
+
|
|
25
|
+
# ✅ 创建非 root 用户
|
|
26
|
+
FROM node:20-alpine
|
|
27
|
+
RUN addgroup -S app && adduser -S app -G app
|
|
28
|
+
USER app # 关键!
|
|
29
|
+
CMD ["node", "server.js"]
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### 2. 多阶段构建(减镜像 + 减攻击面)
|
|
33
|
+
```dockerfile
|
|
34
|
+
# ✅ 构建工具不进最终镜像
|
|
35
|
+
FROM node:20-alpine AS builder
|
|
36
|
+
WORKDIR /app
|
|
37
|
+
COPY package*.json ./
|
|
38
|
+
RUN npm ci
|
|
39
|
+
COPY . .
|
|
40
|
+
RUN npm run build # 产物在 dist/
|
|
41
|
+
|
|
42
|
+
FROM node:20-alpine AS runner
|
|
43
|
+
WORKDIR /app
|
|
44
|
+
RUN addgroup -S app && adduser -S app -G app
|
|
45
|
+
COPY --from=builder /app/dist ./dist
|
|
46
|
+
COPY --from=builder /app/node_modules ./node_modules
|
|
47
|
+
COPY --from=builder /app/package.json ./
|
|
48
|
+
USER app
|
|
49
|
+
CMD ["node", "dist/server.js"]
|
|
50
|
+
# 最终镜像不含 npm/COPY/源码 → 更小更安全
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### 3. 密钥不入镜像
|
|
54
|
+
```dockerfile
|
|
55
|
+
# ❌ 密钥硬编码在 Dockerfile(任何人 pull 镜像就泄露)
|
|
56
|
+
ENV DATABASE_URL=postgres://user:pass@db:5432/app
|
|
57
|
+
|
|
58
|
+
# ✅ 运行时注入(K8s Secret / 环境变量)
|
|
59
|
+
# K8s 部署:
|
|
60
|
+
env:
|
|
61
|
+
- name: DATABASE_URL
|
|
62
|
+
valueFrom:
|
|
63
|
+
secretKeyRef:
|
|
64
|
+
name: app-secrets
|
|
65
|
+
key: database-url
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### 4. 用最小基础镜像
|
|
69
|
+
```dockerfile
|
|
70
|
+
# ❌ 完整 OS(含 shell/apt/系统工具 → 攻击面大)
|
|
71
|
+
FROM ubuntu:22.04
|
|
72
|
+
|
|
73
|
+
# ✅ Alpine(5MB)或 Distroless(无 shell)
|
|
74
|
+
FROM node:20-alpine # Alpine
|
|
75
|
+
# 或
|
|
76
|
+
FROM gcr.io/distroless/nodejs20 # Distroless(连 shell 都没有)
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### 5. CI 中扫描漏洞
|
|
80
|
+
```yaml
|
|
81
|
+
# .github/workflows/ci.yml
|
|
82
|
+
- name: Scan image for vulnerabilities
|
|
83
|
+
uses: aquasecurity/trivy-action@master
|
|
84
|
+
with:
|
|
85
|
+
image-ref: app:latest
|
|
86
|
+
severity: CRITICAL,HIGH
|
|
87
|
+
exit-code: 1 # 有高危漏洞就 CI 失败
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## Kubernetes 生产配置
|
|
91
|
+
|
|
92
|
+
### Pod 安全上下文
|
|
93
|
+
```yaml
|
|
94
|
+
apiVersion: apps/v1
|
|
95
|
+
kind: Deployment
|
|
96
|
+
spec:
|
|
97
|
+
template:
|
|
98
|
+
spec:
|
|
99
|
+
securityContext:
|
|
100
|
+
runAsNonRoot: true # 禁止 root
|
|
101
|
+
runAsUser: 1000
|
|
102
|
+
fsGroup: 2000
|
|
103
|
+
seccompProfile:
|
|
104
|
+
type: RuntimeDefault # 默认 Seccomp 配置
|
|
105
|
+
containers:
|
|
106
|
+
- name: app
|
|
107
|
+
image: app:latest
|
|
108
|
+
securityContext:
|
|
109
|
+
allowPrivilegeEscalation: false # 禁止提权
|
|
110
|
+
readOnlyRootFilesystem: true # 只读文件系统
|
|
111
|
+
capabilities:
|
|
112
|
+
drop: [ALL] # 丢掉所有 Linux capabilities
|
|
113
|
+
# 只 add 必需的,如:add: [NET_BIND_SERVICE]
|
|
114
|
+
resources:
|
|
115
|
+
limits:
|
|
116
|
+
cpu: 500m
|
|
117
|
+
memory: 512Mi
|
|
118
|
+
requests:
|
|
119
|
+
cpu: 100m
|
|
120
|
+
memory: 128Mi
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Network Policy(零信任网络)
|
|
124
|
+
```yaml
|
|
125
|
+
apiVersion: networking.k8s.io/v1
|
|
126
|
+
kind: NetworkPolicy
|
|
127
|
+
metadata:
|
|
128
|
+
name: app-network-policy
|
|
129
|
+
spec:
|
|
130
|
+
podSelector:
|
|
131
|
+
matchLabels:
|
|
132
|
+
app: api-server
|
|
133
|
+
policyTypes:
|
|
134
|
+
- Ingress
|
|
135
|
+
- Egress
|
|
136
|
+
ingress:
|
|
137
|
+
- from:
|
|
138
|
+
- podSelector:
|
|
139
|
+
matchLabels:
|
|
140
|
+
app: frontend # 只允许前端 Pod 访问
|
|
141
|
+
ports:
|
|
142
|
+
- protocol: TCP
|
|
143
|
+
port: 3000
|
|
144
|
+
egress:
|
|
145
|
+
- to:
|
|
146
|
+
- podSelector:
|
|
147
|
+
matchLabels:
|
|
148
|
+
app: postgres # 只允许访问数据库
|
|
149
|
+
ports:
|
|
150
|
+
- protocol: TCP
|
|
151
|
+
port: 5432
|
|
152
|
+
- to:
|
|
153
|
+
- namespaceSelector: {} # 允许 DNS
|
|
154
|
+
ports:
|
|
155
|
+
- protocol: UDP
|
|
156
|
+
port: 53
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
### RBAC(最小权限)
|
|
160
|
+
```yaml
|
|
161
|
+
apiVersion: rbac.authorization.k8s.io/v1
|
|
162
|
+
kind: Role
|
|
163
|
+
metadata:
|
|
164
|
+
name: app-role
|
|
165
|
+
rules:
|
|
166
|
+
- apiGroups: [""]
|
|
167
|
+
resources: ["configmaps"]
|
|
168
|
+
verbs: ["get", "list"] # 只读,不写
|
|
169
|
+
# 不用 verbs: ["*"]
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
## 生产检查清单
|
|
173
|
+
|
|
174
|
+
- [ ] 容器以非 root 运行(USER 指令)
|
|
175
|
+
- [ ] 多阶段构建(最终镜像无构建工具)
|
|
176
|
+
- [ ] 基础镜像是最小化(Alpine/Distroless)
|
|
177
|
+
- [ ] CI 有漏洞扫描(Trivy/Grype)
|
|
178
|
+
- [ ] 密钥用 K8s Secret / Vault(不入镜像)
|
|
179
|
+
- [ ] readOnlyRootFilesystem: true
|
|
180
|
+
- [ ] capabilities.drop: [ALL]
|
|
181
|
+
- [ ] allowPrivilegeEscalation: false
|
|
182
|
+
- [ ] Network Policy 限制 Pod 间通信
|
|
183
|
+
- [ ] Resource limits 设置(CPU + memory)
|
|
184
|
+
- [ ] RBAC 最小权限(不用 cluster-admin)
|
|
185
|
+
- [ ] TLS 加密所有通信
|
|
186
|
+
- [ ] 镜像用固定 tag(不用 :latest)
|