Merge pull request #492 from microsoft/deployment-docs-hotfix

Deployment Documentation Hotfix

docs/4-deploy-to-azure.md

@@ -1,51 +1,56 @@
-# ☁️ Deploy to Azure - Azure Developer CLI (azd)
+# ☁️ Deploy to Azure
+
+You can provision the required Azure resources in two ways:
+
+## Option 1: Azure Developer CLI (azd)
 
 To deploy the application to Azure using the Azure Developer CLI, follow the steps below. You can do this without cloning the repository, but instructions are also provided for those who have cloned the repository.
 
 1. Download the [Azure Developer CLI](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/overview)
 
-2. **If you have not cloned this repo**: 
-    1. Run `azd init -t microsoft/azurechat` 
-    1. Run `azd up` to provision and deploy the application
+2. **If you have not cloned this repo**:
 
-2. **If you have cloned this repo**:
-    1. Run `azd init` from the repo root directory
-    1. Run `azd up` to provision and deploy the application 
+   1. Run `azd init -t microsoft/azurechat`
+   2. Run `azd auth login` to authenticate with Azure
+   3. Run `azd up` to provision and deploy the application
 
-# ☁️ Deploy to Azure - GitHub Actions
+3. **If you have cloned this repo**:
+   1. Run `azd init` from the repo root directory
+   2. Run `azd auth login` to authenticate with Azure
+   3. Run `azd up` to provision and deploy the application
+
+## Option 2: GitHub Actions
 
 The following steps describes how the application can be deployed to Azure App service using GitHub Actions.
 
-## 🧬 Fork the repository
+### 🧬 Fork the repository
 
 If you haven't already, fork this repository to your own organisation so that you can execute GitHub Actions against your own Azure Subscription. This allows you to edit the code, customise it to your needs, and maintain control over the deployment process.
 
-## 🗝️ Configure secrets in your GitHub repository
-
-### 1. AZURE_CREDENTIALS
+### 🗝️ Configure secrets in your GitHub repository
 
-The GitHub workflow requires a secret named `AZURE_CREDENTIALS` to authenticate with Azure. The secret contains the credentials for a service principal with the Contributor role on the resource group containing the container app and container registry.
+#### 1. AZURE_CREDENTIALS
 
-1. Create a service principal with the Contributor role on the resource group that contains the Azure App Service.
+The GitHub workflow requires a secret named `AZURE_CREDENTIALS` to authenticate with Azure. The secret contains the credentials for a Service Principal with the Contributor role on the resource group containing the Azure App Service.
 
+1. Create a Service Principal with the Contributor role on the resource group that contains the Azure App Service.
    ```console
    az ad sp create-for-rbac
       --name <NAME OF THE CREDENTIAL> --role contributor --scopes /subscriptions/<SUBSCRIPTION ID>/resourceGroups/<RESOURCE GROUP> --sdk-auth --output json
    ```
+   **⚠️ Deprecation:** You may be presented with a warning that `--sdk-auth` is deprecated and will be removed in future versions. For now, you can ignore this warning or check out [#359](https://github.com/microsoft/azurechat/issues/359#issuecomment-2650632190) for more details.
+
+   **💡 Good to know:** The Service Principal secret generated in this step has a default lifespan of 1 year. This can be modified by adding the `--years n` flag to the command above, or generating a new secret for the Service Principal through the Azure Portal. In either case, be sure to update the GitHub secret accordingly.
+3. Copy the JSON output from the command.
+4. In the GitHub repository, navigate to Settings > Secrets > Actions and select **New repository secret**.
+5. Enter `AZURE_CREDENTIALS` as the name and paste the contents of the JSON output as the value.
+6. Select **Add secret**.
 
-2. Copy the JSON output from the command.
-
-3. In the GitHub repository, navigate to Settings > Secrets > Actions and select **New repository secret**.
-
-4. Enter `AZURE_CREDENTIALS` as the name and paste the contents of the JSON output as the value.
-
-5. Select **Add secret**.
-
-### 2. AZURE_APP_SERVICE_NAME
+#### 2. AZURE_APP_SERVICE_NAME
 
 Under the same repository secrets add a new variable `AZURE_APP_SERVICE_NAME` to deploy to your Azure Web app. The value of this secret is the name of your Azure Web app e.g. `my-web-app-name` from the domain https://my-web-app-name.azurewebsites.net/
 
-### 3. Run GitHub Actions
+#### 3. Run GitHub Actions
 
 Once the secrets are configured, the GitHub Actions will be triggered for every code push to the repository. Alternatively, you can manually run the workflow by clicking on the "Run Workflow" button in the Actions tab of your GitHub repository.
 

docs/9-managed-identities.md

@@ -45,7 +45,7 @@ To deploy the application to Azure App Service with Managed Identities, follow t
 1. **Update the Parameter**:
    - Set the parameter `disableLocalAuth` to `true` in [`infra/main.bicep`](/infra/main.bicep) (or [`infra/main.json`](/infra/main.json) for ARM deployment) to use Managed Identities.
 2. **Deploy resources using azd**:
-   - refer to the [README](../README.md)
+   - Refer to the [README](../README.md)
 3. **(Optional) Setup your local development environment**:
 
    Run this script to grant yourself RBAC permissions on the Azure resources so you can run AzureChat locally with managed identities.