diff --git a/README.md b/README.md index 31eb32bb1..357a62f52 100644 --- a/README.md +++ b/README.md @@ -188,7 +188,8 @@ To review Cosmos DB configuration overview and steps, follow the link [here](doc
To ensure sufficient quota is available in your subscription, please follow [quota check instructions guide](./docs/QuotaCheck.md) before you deploy the solution.
-The "Deploy to Azure" button offers a one-click deployment where you don’t have to clone the code. If you would like a developer experience instead, follow the [local deployment instructions](./docs/LOCAL_DEPLOYMENT.md). + +The "Deploy to Azure" button offers a one-click deployment where you don’t have to clone the code. If you would like a developer experience instead, follow the [local deployment instructions](./docs/LOCAL_DEPLOYMENT.md) Once you deploy to Azure, you will have the option to select PostgreSQL or Cosmos DB, see screenshot below. diff --git a/azure.yaml b/azure.yaml index d3e4e84a2..e29061af9 100644 --- a/azure.yaml +++ b/azure.yaml @@ -3,6 +3,10 @@ name: chat-with-your-data-solution-accelerator metadata: template: chat-with-your-data-solution-accelerator@1.7.0 + +requiredVersions: + azd: '>= 1.18.0' + hooks: postprovision: # run: ./infra/prompt-flow/create-prompt-flow.sh diff --git a/docs/LOCAL_DEPLOYMENT.md b/docs/LOCAL_DEPLOYMENT.md index b83179106..da183db7d 100644 --- a/docs/LOCAL_DEPLOYMENT.md +++ b/docs/LOCAL_DEPLOYMENT.md @@ -4,6 +4,8 @@ > **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)). We recommend using the [Non DevContainer Setup](./NON_DEVCONTAINER_SETUP.md) instructions to run the accelerator locally. +> **Note:** This solution accelerator requires **Azure Developer CLI (azd) version 1.18.0 or higher**. Please ensure you have the latest version installed before proceeding with deployment. [Download azd here](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd). + The easiest way to run this accelerator is in a VS Code Dev Containers, which will open the project in your local VS Code using the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers): 1. Start Docker Desktop (install it if not already installed) diff --git a/docs/NON_DEVCONTAINER_SETUP.md b/docs/NON_DEVCONTAINER_SETUP.md index 3b70722d5..64c26361f 100644 --- a/docs/NON_DEVCONTAINER_SETUP.md +++ b/docs/NON_DEVCONTAINER_SETUP.md @@ -13,7 +13,7 @@ If you are unable to run this accelerator using a DevContainer or in GitHub Code - [Teams Toolkit](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.ms-teams-vscode-extension) **Optional** - [Python 3.11](https://www.python.org/downloads/release/python-3119/) - [Node.js LTS](https://nodejs.org/en) -- [Azure Developer CLI](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd) +- [Azure Developer CLI](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd) (v1.18.0+) - [Azure Functions Core Tools](https://docs.microsoft.com/en-us/azure/azure-functions/functions-run-local) ## Setup @@ -51,5 +51,6 @@ The Azure Developer CLI (`azd`) is a developer-centric command-line interface (C ``` azd up ``` + > **Note:** This solution accelerator requires **Azure Developer CLI (azd) version 1.18.0 or higher**. Please ensure you have the latest version installed before proceeding with deployment. [Download azd here](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd). > Select your desired `subscription` and `location`. Wait a moment for the resource deployment to complete, click the website endpoint and you will see the web app page.