### 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
5.4 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.
Code Deployment — App Service (and Premium/EP1 Functions)
After IaC deployment creates the Azure resources, deploy application code.
⛔ Functions on Flex Consumption (the default Functions floor) do NOT deploy through this SCM/Kudu path. They use a blob-container package channel with no
basicPublishingCredentialsPoliciestoggle. Use code-deployment-functions-flex.md instead. This file applies to App Service web apps and to Functions only on Premium (EP1).
⛔
--subscription {subscriptionId}on EVERYazcommand.
⛔ Verify
SCM_DO_BUILD_DURING_DEPLOYMENT=trueis active BEFORE deploying. ARM timing can delay propagation. Check:az webapp config appsettings list -g {rg} -n {app} --query "[?name=='SCM_DO_BUILD_DURING_DEPLOYMENT'].value" -o tsv. If nottrue:az webapp config appsettings set -g {rg} -n {app} --settings SCM_DO_BUILD_DURING_DEPLOYMENT=true ENABLE_ORYX_BUILD=true. Wait 10s. Ifaz webapp deployreports "Build successful. Time: 0(s)", Oryx was skipped — use Kudu zipdeploy instead.
⛔
ORYX_DISABLE_COMPRESSION=trueandWEBSITES_CONTAINER_START_TIME_LIMIT=1800must be in Bicep app settings (fromprepare-plan.json.deployStrategy.requiredAppSettings).
Pre-Deploy Verification (Step 6a)
⛔ TypeScript projects: Oryx with
NODE_ENV=productionskips devDependencies. Iftypescript,@types/*, or build tools are indevDependencies, move them todependenciesbefore zipdeploy. Alternative: setNPM_CONFIG_PRODUCTION=falseas app setting so Oryx installs devDeps during build.
⛔ Wait for App Service to stabilize (B1: ~30-90s cold start on a freshly created plan). Poll
az webapp show -g {rg} -n {app} --query stateevery 10s, max 2 min. If notRunning, check logs.
When deployStrategy.codeDeployPattern == "startup-install", surface: "⚠️ First cold start: 2-5 min (native module compilation)."
Zip Deploy (Step 6b)
SCM lifecycle: enable → deploy → re-disable.
Enable SCM:
az rest --method put --url "/subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.Web/sites/{app}/basicPublishingCredentialsPolicies/scm?api-version=2023-12-01" --headers "Content-Type=application/json" --body '{"properties":{"allow":true}}'
Choose deploy method:
| Runtime | Needs Oryx? | Method |
|---|---|---|
| Python, Node.js, Ruby, PHP | Yes | Kudu zipdeploy (/api/zipdeploy) |
| .NET, Java, static front-end | No | az webapp deploy --type zip |
⛔ OneDeploy NEVER triggers Oryx — use Kudu zipdeploy for runtimes needing server-side install.
⛔ NEVER use az webapp deployment source config-zip — deprecated.
⛔ az webapp deploy does NOT support --track-status.
Kudu Zipdeploy (Oryx-Dependent Runtimes)
For apps needing server-side package installation (Python, Node.js, Ruby, PHP), use Kudu zipdeploy directly:
# Get publishing credentials
$creds = az webapp deployment list-publishing-credentials --subscription {sub} -g {rg} -n {app} --query "{user:publishingUserName, pass:publishingPassword}" -o json | ConvertFrom-Json
$auth = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes("$($creds.user):$($creds.pass)"))
# Deploy via Kudu zipdeploy (triggers Oryx pip install)
Invoke-WebRequest -Uri "https://{app}.scm.azurewebsites.net/api/zipdeploy?isAsync=true" -Method POST -InFile $zipPath -Headers @{Authorization="Basic $auth"} -ContentType "application/zip" -UseBasicParsing
# Poll until build completes
for ($i = 1; $i -le 40; $i++) {
Start-Sleep -Seconds 15
$resp = Invoke-WebRequest -Uri "https://{app}.scm.azurewebsites.net/api/deployments/latest" -Headers @{Authorization="Basic $auth"} -UseBasicParsing
$deploy = $resp.Content | ConvertFrom-Json
if ($deploy.complete -eq $true) { break }
}
Prerequisites:
SCM_DO_BUILD_DURING_DEPLOYMENT=truemust be set (verified in Step 6a)- Runtime manifest must be at the zip root — Oryx detects the runtime from it:
- Python:
requirements.txt(orpyproject.toml) - Node.js:
package.json(+ lockfile) - Ruby:
Gemfile - PHP:
composer.json
- Python:
- Do NOT pre-install packages locally — let Oryx run the install remotely
SCM auth lifecycle (REST API toggle — no Bicep edits):
IaC has
scm.allow: true(deploy convenience). Deploy phase: Deploy code → health check → re-disable via REST API → verifyfalse. If re-disable fails, log but don't block — add postDeployRecommendation.
Zip creation: Use System.IO.Compression.ZipFile with relative paths from workspace root. On Windows, normalize entry paths: $entryName = $relativePath.Replace('\', '/') — ZipFile preserves backslashes which Linux App Service cannot resolve. Never use Compress-Archive -Path $files.FullName — absolute paths flatten the directory structure, causing app crashes (./src/app not found).
Database Post-Deploy Verification
⛔ You MUST read
database-post-deploy.mdfor migration discovery, execution via App Service SSH, error handling, and PostgreSQL-specific checks.