You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`AZURE_ENV_NAME`| string |`macae`| Used as a prefix for all resource names to ensure uniqueness across environments. |
12
-
|`AZURE_LOCATION`| string |`swedencentral`| Location of the Azure resources. Controls where the infrastructure will be deployed. |
13
-
|`AZURE_ENV_OPENAI_LOCATION`| string |`swedencentral`| Specifies the region for OpenAI resource deployment. |
12
+
|`AZURE_LOCATION`| string |`<User selects during deployment>`| Location of the Azure resources. Controls where the infrastructure will be deployed. |
13
+
|`AZURE_ENV_OPENAI_LOCATION`| string |`<User selects during deployment>`| Specifies the region for OpenAI resource deployment. |
14
14
|`AZURE_ENV_MODEL_DEPLOYMENT_TYPE`| string |`GlobalStandard`| Defines the deployment type for the AI model (e.g., Standard, GlobalStandard). |
15
15
|`AZURE_ENV_MODEL_NAME`| string |`gpt-4o`| Specifies the name of the GPT model to be deployed. |
16
16
|`AZURE_ENV_FOUNDRY_PROJECT_ID`| string |`<Existing Workspace Id>`| Set this if you want to reuse an AI Foundry Project instead of creating a new one. |
Copy file name to clipboardExpand all lines: docs/DeploymentGuide.md
+30-5Lines changed: 30 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -219,6 +219,10 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
219
219
220
220
7. If you are done trying out the application, you can delete the resources by running `azd down`.
221
221
222
+
223
+
### 🛠️ Troubleshooting
224
+
If you encounter any issues during the deployment process, please refer [troubleshooting](../docs/TroubleShootingSteps.md) document for detailed steps and solutions.
225
+
222
226
# Local setup
223
227
224
228
> **Note for macOS Developers**: If you are using macOS on Apple Silicon (ARM64) the DevContainer will **not** work. This is due to a limitation with the Azure Functions Core Tools (see [here](https://github.com/Azure/azure-functions-core-tools/issues/3112)).
@@ -233,7 +237,7 @@ The easiest way to run this accelerator is in a VS Code Dev Containers, which wi
233
237
234
238
## Detailed Development Container setup instructions
235
239
236
-
The solution contains a [development container](https://code.visualstudio.com/docs/remote/containers) with all the required tooling to develop and deploy the accelerator. To deploy the Chat With Your Data accelerator using the provided development container you will also need:
240
+
The solution contains a [development container](https://code.visualstudio.com/docs/remote/containers) with all the required tooling to develop and deploy the accelerator. To deploy the Multi-Agent solutions accelerator using the provided development container you will also need:
237
241
238
242
-[Visual Studio Code](https://code.visualstudio.com)
239
243
-[Remote containers extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
@@ -287,7 +291,7 @@ The files for the dev container are located in `/.devcontainer/` folder.
287
291
288
292
- You can use the Bicep extension for VSCode (Right-click the `.bicep` file, thenselect"Show deployment plan") or use the Azure CLI:
289
293
```bash
290
-
az deployment group create -g <resource-group-name> -f deploy/macae-dev.bicep --query 'properties.outputs'
294
+
az deployment group create -g <resource-group-name> -f infra/main.bicep --query 'properties.outputs'
291
295
```
292
296
- **Note**: You will be prompted for a `principalId`, which is the ObjectID of your user in Entra ID. To find it, use the Azure Portal or run:
293
297
@@ -301,7 +305,7 @@ The files for the dev container are located in `/.devcontainer/` folder.
301
305
302
306
**Role Assignments in Bicep Deployment:**
303
307
304
-
The **macae-dev.bicep** deployment includes the assignment of the appropriate roles to AOAI and Cosmos services. If you want to modify an existing implementation—for example, to use resources deployed as part of the simple deployment for local debugging—you will need to add your own credentials to access the Cosmos and AOAI services. You can add these permissions using the following commands:
308
+
The **main.bicep** deployment includes the assignment of the appropriate roles to AOAI and Cosmos services. If you want to modify an existing implementation—for example, to use resources deployed as part of the simple deployment for local debugging—you will need to add your own credentials to access the Cosmos and AOAI services. You can add these permissions using the following commands:
305
309
306
310
```bash
307
311
az cosmosdb sql role assignment create --resource-group <solution-accelerator-rg> --account-name <cosmos-db-account-name> --role-definition-name "Cosmos DB Built-in Data Contributor" --principal-id <aad-user-object-id> --scope /subscriptions/<subscription-id>/resourceGroups/<solution-accelerator-rg>/providers/Microsoft.DocumentDB/databaseAccounts/<cosmos-db-account-name>
@@ -320,11 +324,21 @@ The files for the dev container are located in `/.devcontainer/` folder.
320
324
321
325
5. **Create a `.env` file:**
322
326
323
-
- Navigate to the `src` folder and create a `.env` file based on the provided `.env.sample` file.
327
+
- Navigate to the `src\backend` folder and create a `.env` file based on the provided `.env.sample` file.
328
+
- Update the `.env` file with the required values from your Azure resource group in Azure Portal App Service environment variables.
329
+
- Alternatively, if resources were
330
+
provisioned using `azd provision` or `azd up`, a `.env` file is automatically generated in the `.azure/<env-name>/.env`
331
+
file. You can copy the contents of this file into your backend `.env` file.
332
+
333
+
_**Note**: To get your `<env-name>` run `azd env list` to see which env is default._
324
334
325
335
6. **Fill in the `.env` file:**
326
336
327
337
- Use the output from the deployment or check the Azure Portal under "Deployments" in the resource group.
338
+
- Make sure to set APP_ENV to "**dev**" in `.env` file.
339
+
- For local development, make sure to include below env variables in the `.env`
340
+
- `BACKEND_API_URL=http://localhost:8000`
341
+
- `FRONTEND_SITE_NAME=http://127.0.0.1:3000` .
328
342
329
343
7. **(Optional) Set up a virtual environment:**
330
344
@@ -337,8 +351,19 @@ The files for the dev container are located in `/.devcontainer/` folder.
337
351
```bash
338
352
pip install -r requirements.txt
339
353
```
354
+
355
+
9. **Build the frontend (important):**
356
+
357
+
- Before running the frontend server, you must build the frontend to generate the necessary `build/assets` directory.
0 commit comments