### 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.8 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.
Preflight Checks
Pre-deployment validation steps. Run after user approval, before deployment execution.
AppOnboard runs direct deployment (no
azd).
Check Sequence
Branch on scaffold-manifest.json.iacFormat:
0. Auth Token Verification
az account show
- Success → proceed. Active subscription + tenant confirmed.
- Failure →
ENVIRONMENT_BLOCKING. Suggestaz login(plain, no scope). - ⛔ NEVER suggest
az login --scope https://graph.microsoft.com/.default— Graph scope is irrelevant for ARM deployments.
0b. Resource Name Availability
Check globally-unique names before deploy: az acr check-name, az storage account check-name, az webapp show, az keyvault show. Name taken → suggest alternate from prepare-plan.json.naming.suffix: "Name {name} taken. Use {altName}?"
0c. F1/Free Tier Warning
If plan includes F1/D1/free SKUs, surface at deploy gate (do NOT block):
⚠️ Free tier: no custom domains, no SSL, no always-on, 60 min/day compute (F1). Dev/test only.
0d. RBAC Scope Pre-Check
az role assignment list --assignee {userId} --scope /subscriptions/{sub} --query "[].roleDefinitionName" -o tsv
Subscription-scope deploy requires Contributor/Owner on subscription. Missing → ENVIRONMENT_BLOCKING with az role assignment create command.
1. Deployment Preview
⛔ MANDATORY — do NOT skip. What-if validates + previews in one call. Use what-if exclusively — az deployment sub/group validate hits a known CLI bug (HTTP stream consumed error). If what-if fails, log + warn user — do not skip to execution.
Bicep (subscription scope)
az deployment sub what-if \
--name "{deploymentName}" \
--location {location} \
--template-file infra/main.bicep \
--parameters @infra/main.parameters.json \
--subscription {subscriptionId} \
--what-if-result-format FullResourcePayloads
Bicep (resource-group scope)
az deployment group create \
--resource-group {rg} \
--template-file infra/main.bicep \
--parameters @infra/main.parameters.json \
--subscription {subscriptionId} \
--what-if \
--what-if-result-format FullResourcePayloads
- Review changes:
Create,Modify,Delete,NoChange. SurfaceDeleteas warnings — user must acknowledge. - Auth error →
ENVIRONMENT_BLOCKING.
Terraform
terraform plan -out=tfplan -detailed-exitcode
- Exit 0 → no changes. Exit 2 → changes (normal). Exit 1 → error.
- Surface
destroyas warnings — user must acknowledge. Auth error →ENVIRONMENT_BLOCKING.
3. RBAC Permission Check
az role assignment list \
--assignee {currentUserObjectId} \
--scope /subscriptions/{sub}/resourceGroups/{rg} \
--query "[].roleDefinitionName" -o tsv
Required: Contributor or Owner on the target resource group. If missing → ENVIRONMENT_BLOCKING with remediation command.
4. SKU Quota Verification
⛔ what-if does NOT catch quota errors. It returns Succeeded even when target SKU has limit=0.
If prepare-plan.json.quotaValidation.verified == true → proceed.
Otherwise → read sku-quota-validation.md and run direct quota checks NOW (per-provider API patterns, offer restrictions). If limit=0 → HALT, present region fallback. Skip regions in quotaValidation.checkedRegions with zero availability.
⛔ SubscriptionIsOverQuotaForSku or LocationIsOfferRestricted in deploy output → HALT. See error-classification.md.
5. Resource Group Existence
az group show --name {rg} --query "location" -o tsv 2>/dev/null
- Exists → verify location matches
prepare-plan.jsonregion. Mismatch → warn. - Not exists → will be created by deployment (if
main.bicephas subscription scope).
Error Handling
Each check runs independently. Collect all results, then present structured report.
| Check | Fail Behavior |
|---|---|
| Deployment preview | Warn, don't block (can fail on unsupported types) |
| RBAC | Block. Surface az role assignment create. |
| RG check | Warn on location mismatch. Don't block. |
Report Format
## Preflight Results
✅ IaC syntax: valid (terraform validate / bicep build)
⚠️ Deployment preview: 3 creates, 0 destroys, 1 update
✅ RBAC: Contributor role confirmed
✅ Resource group: rg-myapp-dev (eastus2)