Share env vars in bicep and update docs

Author: 1yefuwang1

CONTRIBUTING.md

@@ -22,6 +22,7 @@ contact [[email protected]](mailto:[email protected]) with any additio
 - [Running unit tests](#running-unit-tests)
 - [Running E2E tests](#running-e2e-tests)
 - [Code Style](#code-style)
+- [Adding new azd environment variables](#add-new-azd-environment-variables)
 
 ## Code of Conduct
 
@@ -160,3 +161,11 @@ python -m black <path-to-file>
 ```
 
 If you followed the steps above to install the pre-commit hooks, then you can just wait for those hooks to run `ruff` and `black` for you.
+
+## Adding new azd environment variables
+
+When adding new azd environment variables, please remember to update:
+1. App Service's [azure.yaml](./azure.yaml)
+2. Azure Container Apps' [azure.yaml](./containerapps/azure.yaml)
+3. [ADO pipeline](.azdo/pipelines/azure-dev.yml).
+4. [Github workflows](.github/workflows/azure-dev.yml)

README.md

@@ -66,7 +66,7 @@ Pricing varies per region and usage, so it isn't possible to predict exact costs
 However, you can try the [Azure pricing calculator](https://azure.com/e/a87a169b256e43c089015fda8182ca87) for the resources below.
 
 - Azure App Service: Basic Tier with 1 CPU core, 1.75 GB RAM. Pricing per hour. [Pricing](https://azure.microsoft.com/pricing/details/app-service/linux/)
-- Azure Container Apps: Consumption plan with 1 CPU core, 2.0 GB RAM. Pricing with Pay-as-You-Go. [Pricing](https://azure.microsoft.com/pricing/details/container-apps/)
+- Azure Container Apps: Only provisioned if you deploy to Azure Container Apps following instructions [here](docs/azure_container_apps.md). Consumption plan with 1 CPU core, 2.0 GB RAM. Pricing with Pay-as-You-Go. [Pricing](https://azure.microsoft.com/pricing/details/container-apps/)
 - Azure OpenAI: Standard tier, GPT and Ada models. Pricing per 1K tokens used, and at least 1K tokens are used per question. [Pricing](https://azure.microsoft.com/pricing/details/cognitive-services/openai-service/)
 - Azure AI Document Intelligence: SO (Standard) tier using pre-built layout. Pricing per document page, sample documents have 261 pages total. [Pricing](https://azure.microsoft.com/pricing/details/form-recognizer/)
 - Azure AI Search: Basic tier, 1 replica, free level of semantic search. Pricing per hour. [Pricing](https://azure.microsoft.com/pricing/details/search/)
@@ -127,7 +127,7 @@ A related option is VS Code Dev Containers, which will open the project in your
 
 ## Deploying
 
-Follow these steps to provision Azure resources and deploy the application code:
+The steps below will provision Azure resources and deploy the application code to Azure App Service. To deploy to Azure Container Apps instead, follow [the container apps deployment guide](docs/azure_container_apps.md).
 
 1. Login to your Azure account:
 

containerapps/README.md

@@ -1,22 +1,3 @@
-# Deploying on Azure Container Apps
+# Deploying to Azure Container Apps
 
-Due to [a limitation](https://github.com/Azure/azure-dev/issues/2736) of azd, the azure.yaml file for deploying to Azure Container Apps lives here.
-To deploy to azure container apps, please run from project root folder:
-
-```bash
-cd containerapps
-azd env new
-azd env set DEPLOYMENT_TARGET containerapps
-azd up
-```
-
-## Customizing Workload Profile
-
-The default workload profile is Consumption. If you want to use a dedicated workload profile like D4, please run:
-
-```bash
-azd env AZURE_CONTAINER_APPS_WORKLOAD_PROFILE D4
-```
-
-For a full list of workload profiles, please check [here](https://learn.microsoft.com/azure/container-apps/workload-profiles-overview#profile-types).
-Please note dedicated workload profiles have a different billing model than Consumption plan. Please check [here](https://learn.microsoft.com/azure/container-apps/billing) for details.
+Please see the [guide](../docs/azure_container_apps.md) for deploying to Azure Container Apps.

containerapps/azure.yaml

@@ -89,6 +89,8 @@ pipeline:
       - AZURE_ADLS_GEN2_STORAGE_ACCOUNT
       - AZURE_ADLS_GEN2_FILESYSTEM_PATH
       - AZURE_ADLS_GEN2_FILESYSTEM
+      - DEPLOYMENT_TARGET
+      - AZURE_CONTAINER_APPS_WORKLOAD_PROFILE
   secrets:
       - AZURE_SERVER_APP_SECRET
       - AZURE_CLIENT_APP_SECRET

docs/azure_container_apps.md

@@ -1,31 +1,22 @@
 # Deploying on Azure Container Apps
 
-Due to [a limitation](https://github.com/Azure/azure-dev/issues/2736) of azd, the azure.yaml file for deploying to Azure Container Apps lives in folder `aca-host` along with symbolic links to `app`,`data` and `scripts` folder.
-
-## For Linux/MacOS users
-
-If you are on Linux/MacOS, it should work without any extra settings to deploy on Azure Container Apps. Please use:
+Due to [a limitation](https://github.com/Azure/azure-dev/issues/2736) of azd, the azure.yaml file for deploying to Azure Container Apps lives here.
+To deploy to azure container apps, please run from project root folder:
 
 ```bash
-cd aca-host
+cd containerapps
+azd env new
+azd env set DEPLOYMENT_TARGET containerapps
 azd up
 ```
 
-## For Windows users
+## Customizing Workload Profile
 
-Because Windows [doesn't enable symbolic links by default](https://stackoverflow.com/questions/5917249/git-symbolic-links-in-windows), you may need to enable [Developer Mode](https://learn.microsoft.com/windows/apps/get-started/enable-your-device-for-development) and symlinks for git before cloning this repo.
-To enable symlinks for git, please use
+The default workload profile is Consumption. If you want to use a dedicated workload profile like D4, please run:
 
 ```bash
-# local setting
-git config core.symlinks true
-# Alternatively, enable symlinks globally
-git config --global core.symlinks true
+azd env AZURE_CONTAINER_APPS_WORKLOAD_PROFILE D4
 ```
 
-Please check whether the symlink works correctly and then run:
-
-```bash
-cd aca-host
-azd up
-```
+For a full list of workload profiles, please check [here](https://learn.microsoft.com/azure/container-apps/workload-profiles-overview#profile-types).
+Please note dedicated workload profiles have a different billing model than Consumption plan. Please check [here](https://learn.microsoft.com/azure/container-apps/billing) for details.