Docs: Consolidate deployment guides and remove deprecated framework references #366
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Enhanced Agentic AI with Secure Azure Deployment
…ough an exception Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
…ted NPM libraries and added Dockerfile for containerization
React UI Conversion & Updates
- Add intentionalClose flag to WebSocket manager to prevent auto-reconnect on intentional close - Fix Dockerfile to copy from Vite 'dist' instead of CRA 'build' directory - Update backend static file serving to handle both Vite (assets/) and CRA (static/) structures - Add catch-all exception handler for WebSocket disconnections in backend
* WIP: Save local changes before switching to int-agentic * Fix WebSocket reconnect issue and Vite build compatibility - Add intentionalClose flag to WebSocket manager to prevent auto-reconnect on intentional close - Fix Dockerfile to copy from Vite 'dist' instead of CRA 'build' directory - Update backend static file serving to handle both Vite (assets/) and CRA (static/) structures - Add catch-all exception handler for WebSocket disconnections in backend --------- Co-authored-by: James N. <james.nguyen@microsoft.com>
…ed lychee checker
- Use mcr.microsoft.com/k8se/quickstart:latest as placeholder image - Add lifecycle ignore_changes for container image (managed by update-containers) - Solves chicken-and-egg problem: Container Apps created before images exist in ACR - update-containers.yml sets real images after Docker builds complete
- Docker workflows should only run via workflow_call from orchestrate.yml - Prevents duplicate/orphan runs that occur before infrastructure exists - Manual dispatch still available for ad-hoc builds
- Add placeholder image support (mcr.microsoft.com/k8se/quickstart:latest) - Fix MCP allowInsecure when mcpInternalOnly is true - Add readiness probe to application container (/docs endpoint) - Add missing env vars: AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME, AZURE_OPENAI_EMBEDDING_DEPLOYMENT - Make AZURE_OPENAI_API_VERSION configurable via parameter - Align naming convention with environment suffix - Change image name from workshop-app to backend-app for consistency
…guide - Replace ASCII architecture diagrams with interactive Mermaid diagrams - Add comprehensive enterprise security sections (VNet, Private Endpoints, Managed Identity) - Document security profiles (Dev/Staging/Production) - Add CI/CD with GitHub Actions OIDC section linking to GITHUB_ACTIONS_SETUP.md - Update main README with enterprise deployment table linking to all guides - Add data flow and authentication flow sequence diagrams - Include troubleshooting guide with common issues
…guide - Replace ASCII architecture diagrams with interactive Mermaid diagrams - Add comprehensive enterprise security sections (VNet, Private Endpoints, Managed Identity) - Document security profiles (Dev/Staging/Production) - Add CI/CD with GitHub Actions OIDC section linking to GITHUB_ACTIONS_SETUP.md - Update main README with enterprise deployment table linking to all guides - Add data flow and authentication flow sequence diagrams - Include troubleshooting guide with common issues
- Create _backend_sqlite.py for local SQLite development - Create _backend_cosmos.py for production Cosmos DB - Update contoso_tools.py to select backend via USE_COSMOSDB env var - Remove mcp_service_cosmos.py (merged into mcp_service.py) - Remove contoso_tools_cosmos.py (merged into _backend_cosmos.py) - Remove unused sqlite3 import from mcp_service.py Usage: Set USE_COSMOSDB=true for Cosmos DB, false (default) for SQLite
…ars, add data seeding option
* WIP: Save local changes before switching to int-agentic * Fix WebSocket reconnect issue and Vite build compatibility - Add intentionalClose flag to WebSocket manager to prevent auto-reconnect on intentional close - Fix Dockerfile to copy from Vite 'dist' instead of CRA 'build' directory - Update backend static file serving to handle both Vite (assets/) and CRA (static/) structures - Add catch-all exception handler for WebSocket disconnections in backend * update authentication and bicep deployment to use AAD authentication instead of key * complete terraform deployment * update DEPLOYMENT and Terraform * update DEPLOYMENT and Terraform * Changed AZURE_OPENAI_API_VERSION to use a variable * Reverted the OIDC changes on providers.tf * Reverted the OIDC changes on providers.tf * Removing key vault referene from orchestration workflow * removing key vault reference and openai secret key from infrastructure workflow. I have also commented out all the tests for model endpoint, since that currently relies on key based access. * changing docker to build off new image * changing docker to build off new image * changing docker to build off new image * Making backend config optionally remote in the proper way * Reverting backend change, seems to have broken state connection * adding a local provider file so I can have flexible backends * upgrade version of agent-framework and allow mcp in internal communication to be insecure * Updated to work with both local and remote state * optimize reflection agent code and remove workflow reflection agent * add github workflow * update github workflow to use repo level variables * update github workflow to use repo level variables * update github workflow to use repo level variables * update github workflow to use repo level variables * update test cases & test timeout & excluce MCP test bc mcp is deployed internal * move test to after deployment * move test to after deployment * fix api version * fix api version * fix test run * fix: Use placeholder image for Container Apps initial deployment - Use mcr.microsoft.com/k8se/quickstart:latest as placeholder image - Add lifecycle ignore_changes for container image (managed by update-containers) - Solves chicken-and-egg problem: Container Apps created before images exist in ACR - update-containers.yml sets real images after Docker builds complete * fix: Remove pull_request triggers from Docker workflows - Docker workflows should only run via workflow_call from orchestrate.yml - Prevents duplicate/orphan runs that occur before infrastructure exists - Manual dispatch still available for ad-hoc builds * feat: Add james-dev to destroy-infrastructure condition * feat: Update Bicep for feature parity with Terraform - Add placeholder image support (mcr.microsoft.com/k8se/quickstart:latest) - Fix MCP allowInsecure when mcpInternalOnly is true - Add readiness probe to application container (/docs endpoint) - Add missing env vars: AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME, AZURE_OPENAI_EMBEDDING_DEPLOYMENT - Make AZURE_OPENAI_API_VERSION configurable via parameter - Align naming convention with environment suffix - Change image name from workshop-app to backend-app for consistency * docs: enhance README with Mermaid diagrams and enterprise deployment guide - Replace ASCII architecture diagrams with interactive Mermaid diagrams - Add comprehensive enterprise security sections (VNet, Private Endpoints, Managed Identity) - Document security profiles (Dev/Staging/Production) - Add CI/CD with GitHub Actions OIDC section linking to GITHUB_ACTIONS_SETUP.md - Update main README with enterprise deployment table linking to all guides - Add data flow and authentication flow sequence diagrams - Include troubleshooting guide with common issues * docs: enhance README with Mermaid diagrams and enterprise deployment guide - Replace ASCII architecture diagrams with interactive Mermaid diagrams - Add comprehensive enterprise security sections (VNet, Private Endpoints, Managed Identity) - Document security profiles (Dev/Staging/Production) - Add CI/CD with GitHub Actions OIDC section linking to GITHUB_ACTIONS_SETUP.md - Update main README with enterprise deployment table linking to all guides - Add data flow and authentication flow sequence diagrams - Include troubleshooting guide with common issues * Updated deployment to reference tfvars file for local file/iteration value --------- Co-authored-by: James N. <james.nguyen@microsoft.com> Co-authored-by: Tim Sullivan <timothyj.sullivan1@gmail.com>
…reflection_workflow_agent
… state features Resolved merge conflicts: - _aca-mcp.tf: Combined MCP backend (USE_COSMOSDB, SEED_ON_STARTUP) with agent state env vars - cosmosdb.tf: Kept all containers from james-dev, added agent_state from int-agentic - variables.tf: Added seed_cosmos_data variable - main.bicep: Kept seedCosmosData parameter - mcp-service.bicep: Kept USE_COSMOSDB and SEED_ON_STARTUP env vars Accepted int-agentic's versions for: - deploy.ps1, providers.tf, dev.tfvars (cleaner structure with remote backend support) - reflection_agent.py, .env.sample, azure.yaml, SETUP.md, _backend_cosmos.py Kept james-dev's versions for: - infra/README.md (includes MCP backend documentation)
* WIP: Save local changes before switching to int-agentic * Fix WebSocket reconnect issue and Vite build compatibility - Add intentionalClose flag to WebSocket manager to prevent auto-reconnect on intentional close - Fix Dockerfile to copy from Vite 'dist' instead of CRA 'build' directory - Update backend static file serving to handle both Vite (assets/) and CRA (static/) structures - Add catch-all exception handler for WebSocket disconnections in backend * update authentication and bicep deployment to use AAD authentication instead of key * complete terraform deployment * update DEPLOYMENT and Terraform * update DEPLOYMENT and Terraform * Changed AZURE_OPENAI_API_VERSION to use a variable * Reverted the OIDC changes on providers.tf * Reverted the OIDC changes on providers.tf * Removing key vault referene from orchestration workflow * removing key vault reference and openai secret key from infrastructure workflow. I have also commented out all the tests for model endpoint, since that currently relies on key based access. * changing docker to build off new image * changing docker to build off new image * changing docker to build off new image * Making backend config optionally remote in the proper way * Reverting backend change, seems to have broken state connection * adding a local provider file so I can have flexible backends * upgrade version of agent-framework and allow mcp in internal communication to be insecure * Updated to work with both local and remote state * optimize reflection agent code and remove workflow reflection agent * add github workflow * update github workflow to use repo level variables * update github workflow to use repo level variables * update github workflow to use repo level variables * update github workflow to use repo level variables * update test cases & test timeout & excluce MCP test bc mcp is deployed internal * move test to after deployment * move test to after deployment * fix api version * fix api version * fix test run * fix: Use placeholder image for Container Apps initial deployment - Use mcr.microsoft.com/k8se/quickstart:latest as placeholder image - Add lifecycle ignore_changes for container image (managed by update-containers) - Solves chicken-and-egg problem: Container Apps created before images exist in ACR - update-containers.yml sets real images after Docker builds complete * fix: Remove pull_request triggers from Docker workflows - Docker workflows should only run via workflow_call from orchestrate.yml - Prevents duplicate/orphan runs that occur before infrastructure exists - Manual dispatch still available for ad-hoc builds * feat: Add james-dev to destroy-infrastructure condition * feat: Update Bicep for feature parity with Terraform - Add placeholder image support (mcr.microsoft.com/k8se/quickstart:latest) - Fix MCP allowInsecure when mcpInternalOnly is true - Add readiness probe to application container (/docs endpoint) - Add missing env vars: AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME, AZURE_OPENAI_EMBEDDING_DEPLOYMENT - Make AZURE_OPENAI_API_VERSION configurable via parameter - Align naming convention with environment suffix - Change image name from workshop-app to backend-app for consistency * docs: enhance README with Mermaid diagrams and enterprise deployment guide - Replace ASCII architecture diagrams with interactive Mermaid diagrams - Add comprehensive enterprise security sections (VNet, Private Endpoints, Managed Identity) - Document security profiles (Dev/Staging/Production) - Add CI/CD with GitHub Actions OIDC section linking to GITHUB_ACTIONS_SETUP.md - Update main README with enterprise deployment table linking to all guides - Add data flow and authentication flow sequence diagrams - Include troubleshooting guide with common issues * docs: enhance README with Mermaid diagrams and enterprise deployment guide - Replace ASCII architecture diagrams with interactive Mermaid diagrams - Add comprehensive enterprise security sections (VNet, Private Endpoints, Managed Identity) - Document security profiles (Dev/Staging/Production) - Add CI/CD with GitHub Actions OIDC section linking to GITHUB_ACTIONS_SETUP.md - Update main README with enterprise deployment table linking to all guides - Add data flow and authentication flow sequence diagrams - Include troubleshooting guide with common issues * refactor: merge MCP backends into unified contoso_tools with env switch - Create _backend_sqlite.py for local SQLite development - Create _backend_cosmos.py for production Cosmos DB - Update contoso_tools.py to select backend via USE_COSMOSDB env var - Remove mcp_service_cosmos.py (merged into mcp_service.py) - Remove contoso_tools_cosmos.py (merged into _backend_cosmos.py) - Remove unused sqlite3 import from mcp_service.py Usage: Set USE_COSMOSDB=true for Cosmos DB, false (default) for SQLite * Update Cosmos DB setup scripts to reference unified backend with USE_COSMOSDB env var * Enable MCP deployment with CosmosDB: add all 12 containers, fix env vars, add data seeding option * Simplify deploy.ps1 for local-only execution with sensible defaults * Remove unused local.env.ps1 - all config is in dev.tfvars * Updated deployment to reference tfvars file for local file/iteration value * update mcp service to support CosmosDB * add bicep update & MCP with Cosmos * fix bicep script * update infra readme and mcp readme for CosmosDB as option for mcp backend --------- Co-authored-by: James N. <james.nguyen@microsoft.com> Co-authored-by: Tim Sullivan <timothyj.sullivan1@gmail.com>
There is a security warning if we don't set permissions on the GitHub token. I'm adding contents read as a minimum, this may or may not be enough.
Docs: Consolidate deployment guides and remove deprecated framework references
tjsullivan1
approved these changes
Jan 12, 2026
Contributor
tjsullivan1
left a comment
tjsullivan1
left a comment
There was a problem hiding this comment.
Changes reviewed - this is good.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Summary
Streamlines documentation by consolidating deployment guides into
README.mdand removing references to deprecated frameworks (Autogen, Semantic Kernel).Changes
Removed Files
DEPLOYMENT.md
Superseded by the enterprise deployment guide.
AZD_DEPLOYMENT.md
Consolidated into
README.md.SETUP_UV.md
Redundant with
SETUP.md.AZD_DEPLOYMENT_GUIDE.md
Outdated.
azd-deploy.ps1
Replaced by the native
azd upcommand.Updated Documentation
azdquick-start section