### Summary of Changes
1. Documentation Consolidation:
• Relocated the docs/ folder and all repository .md files (README.md, DEPLOYMENT.md, DOCKER_README.md,
DOMAINS_README.md, GETTING_STARTED.md, CI_CD_PORTAINER_GUIDE.md, ADMIN_DEPLOYMENT_SUMMARY.md,
SECURITY_PRIVATE_FILES.md, handoff.md, azure-project-plan.md, plus service-specific READMEs) into .
• Updated document links in README.md.
2. AI Agent Project Map:
• Created PROJECT_MAP.md in the project root containing complete architecture diagrams, service specs, ports, DB
schemas, environment variables, and developer workflows.
• Added PROJECT_MAP.md to .gitignore.
3. Monitoring UI & Infrastructure Integration:
• Added monitoring_ui service to docker-compose.yml (port 5175).
• Configured Gitea workflow docker-build.yml for monitoring_ui builds.
• Added CORS middleware headers in index.js.
• Added nginx.conf copy step in Dockerfile.
──────
### Recommended Commit Message
docs: consolidate project documentation into monitoring_ui and add agent project map
- Move all markdown documentation files and docs/ folder into monitoring_ui/docs/
- Update documentation hub index (monitoring_ui/docs/README.md) with relative paths
- Generate comprehensive AI agent reference map (PROJECT_MAP.md) in repository root
- Add PROJECT_MAP.md and monitoring_ui build output/env overrides to .gitignore
- Integrate monitoring_ui service into docker-compose.yml and Gitea CI workflow
- Configure CORS handling in employee_api for monitoring dashboard access
──────
### Alternative Short Commit Message
refactor(docs): move docs to monitoring_ui and create AI agent PROJECT_MAP.md
4.2 KiB
Important: This skill provides guidance and recommended instructions to assist the AI system. Outputs are not guaranteed to be complete, correct, secure, or applicable to every scenario. Results should be reviewed and validated by a human before being applied. The AI model may choose not to follow all instructions exactly, and additional verification may be required.
Dockerfile Generation
Generate Dockerfiles for components targeting Container Apps (or B1+ App Service) that have no existing Dockerfile. Read this when iac-generation-rules.md Step 6b applies.
When to Generate
- Component targets Container Apps and has NO Dockerfile (and no
Dockerfile.azure) - Component targets App Service B1+ with
deployStrategy.containerized: true - ⛔ Do NOT generate for F1/D1 SKUs — use platform runtime stack instead
- ⛔ Do NOT overwrite an existing Dockerfile — create
Dockerfile.azureonly if BuildKit stripping is needed
Principles
Layer ordering
Copy dependency manifests and install BEFORE copying source (preserves layer cache):
COPY {manifest files} ./
RUN {install command}
COPY . .
Base image selection
| Principle | Rule |
|---|---|
| Pin version | node:{major}-slim, NOT node:latest |
| Slim variants | -slim or -alpine for smaller images |
| Multi-stage | Go, .NET, Java, Rust: build in SDK image, copy binary to runtime |
| Match runtime | Read engines, python_requires, go.mod, <TargetFramework> |
Port alignment
EXPOSE port, app's listening port, and Container App targetPort must all match. Mismatch = silent health probe failure. Read app config for listening port, set EXPOSE {port}, add ENV PORT={port} if app reads PORT from env.
Security defaults
- Non-root user — Debian/
-slimbase:RUN groupadd -r app && useradd -r -g app app; Alpine base:RUN addgroup -S app && adduser -S app -G app. ThenUSER app - Never
COPY .envor secrets — use.dockerignore - Direct exec:
CMD ["node", "server.js"]notCMD ["npm", "start"]
.dockerignore
Always generate alongside Dockerfile. Exclude: .git, node_modules, __pycache__, *.pyc, .env, .env.*, .azure, .copilot-azure, infra, *.md.
Common pitfalls
| Mistake | Fix |
|---|---|
COPY . . before deps |
Copy manifests first, install, then source |
npm install in prod |
npm ci --omit=dev |
| Wrong EXPOSE port | Read actual listening port from app source |
Next.js multi-container build args
NEXT_PUBLIC_* env vars are embedded in the client JS bundle at npm run build time — runtime Container App env vars have zero effect on client-side code. For multi-container deploys where a Next.js frontend references another component's API:
- Dockerfile MUST include
ARG NEXT_PUBLIC_API_URLbefore theRUN npm run buildstep - Deploy phase passes
--build-arg NEXT_PUBLIC_API_URL=https://{api-fqdn}toaz acr build
Detect from .env* files containing NEXT_PUBLIC_* pointing to another service (e.g., NEXT_PUBLIC_API_URL=http://localhost:3001).
ACR Build Compatibility — Dockerfile.azure Generation
⛔ ACR az acr build uses the classic Docker builder — NOT BuildKit. Do NOT assume ACR supports BuildKit.
When to generate Dockerfile.azure: If buildRequirements.hasBuildKitSyntax == true OR the existing Dockerfile contains any BuildKit-only syntax, create {component}/Dockerfile.azure with all BuildKit syntax removed.
BuildKit-only syntax (strip all): # syntax= directives, RUN --mount=... (all types: cache, secret, bind, tmpfs), RUN --network=..., RUN --security=..., COPY --link, COPY --chmod=..., heredoc syntax (RUN <<EOF).
⛔ Package manager pinning applies here too. When stripping BuildKit from an existing Dockerfile, also replace npm install -g {pm}@latest with the exact version from the project's packageManager field in package.json (e.g., pnpm@9.4.0). The upstream Dockerfile's @latest may pull a version incompatible with the base image's Node.js version.
⛔ Handle multi-line continuations (\) — remove the BuildKit flag but preserve the actual command across all continuation lines. Never leave a bare RUN with no command.