diff --git a/docs/DeploymentGuide.md b/docs/DeploymentGuide.md index 8b30f7f09..165cf320d 100644 --- a/docs/DeploymentGuide.md +++ b/docs/DeploymentGuide.md @@ -233,7 +233,7 @@ The easiest way to run this accelerator is in a VS Code Dev Containers, which wi ## Detailed Development Container setup instructions -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: +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: - [Visual Studio Code](https://code.visualstudio.com) - [Remote containers extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) @@ -287,7 +287,7 @@ The files for the dev container are located in `/.devcontainer/` folder. - You can use the Bicep extension for VSCode (Right-click the `.bicep` file, then select "Show deployment plan") or use the Azure CLI: ```bash - az deployment group create -g -f deploy/macae-dev.bicep --query 'properties.outputs' + az deployment group create -g -f infra/main.bicep --query 'properties.outputs' ``` - **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: @@ -301,7 +301,7 @@ The files for the dev container are located in `/.devcontainer/` folder. **Role Assignments in Bicep Deployment:** - 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: + 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: ```bash az cosmosdb sql role assignment create --resource-group --account-name --role-definition-name "Cosmos DB Built-in Data Contributor" --principal-id --scope /subscriptions//resourceGroups//providers/Microsoft.DocumentDB/databaseAccounts/ @@ -321,6 +321,10 @@ The files for the dev container are located in `/.devcontainer/` folder. 5. **Create a `.env` file:** - Navigate to the `src\backend` folder and create a `.env` file based on the provided `.env.sample` file. + - Update the `.env` file with the required values from your Azure resource group in Azure Portal App Service environment variables. + - Alternatively, if resources were + provisioned using `azd provision` or `azd up`, a `.env` file is automatically generated in the `.azure//.env` + file. To get your `` run `azd env list` to see which env is default. 6. **Fill in the `.env` file:** @@ -338,8 +342,19 @@ The files for the dev container are located in `/.devcontainer/` folder. ```bash pip install -r requirements.txt ``` + +9. **Build the frontend (important):** -9. **Run the application:** + - Before running the frontend server, you must build the frontend to generate the necessary `build/assets` directory. + + From the `src/frontend` directory, run: + + ```bash + npm install + npm run build + ``` + +10. **Run the application:** - From the src/backend directory: diff --git a/docs/LocalDeployment.md b/docs/LocalDeployment.md index d23905b98..e7ebe0065 100644 --- a/docs/LocalDeployment.md +++ b/docs/LocalDeployment.md @@ -20,7 +20,7 @@ The easiest way to run this accelerator is in a VS Code Dev Containers, which wi ## Detailed Development Container setup instructions -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: +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 Solution accelerator using the provided development container you will also need: * [Visual Studio Code](https://code.visualstudio.com) * [Remote containers extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) @@ -74,7 +74,7 @@ The files for the dev container are located in `/.devcontainer/` folder. - You can use the Bicep extension for VSCode (Right-click the `.bicep` file, then select "Show deployment plane") or use the Azure CLI: ```bash - az deployment group create -g -f deploy/macae-dev.bicep --query 'properties.outputs' + az deployment group create -g -f infra/main.bicep --query 'properties.outputs' ``` - **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: ```bash @@ -124,8 +124,19 @@ The files for the dev container are located in `/.devcontainer/` folder. ```bash pip install -r requirements.txt ``` + +9. **Build the frontend (important):** + + - Before running the frontend server, you must build the frontend to generate the necessary `build/assets` directory. + + From the `src/frontend` directory, run: + + ```bash + npm install + npm run build + ``` -10. **Run the application:** +11. **Run the application:** - From the src/backend directory: ```bash python app_kernel.py diff --git a/infra/main.bicep b/infra/main.bicep index bf96fe12e..f6ea978ee 100644 --- a/infra/main.bicep +++ b/infra/main.bicep @@ -1738,3 +1738,4 @@ output AZURE_AI_MODEL_DEPLOYMENT_NAME string = aiFoundryAiServicesModelDeploymen // output APPLICATIONINSIGHTS_CONNECTION_STRING string = applicationInsights.outputs.connectionString output AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME string = aiFoundryAiServicesModelDeployment.name output AZURE_AI_AGENT_ENDPOINT string = aiFoundryAiServices.outputs.aiProjectInfo.apiEndpoint +output APP_ENV string = 'Prod'