You can provision the required Azure resources in two ways:
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.
-
Download the Azure Developer CLI
-
If you have not cloned this repo:
- Run
azd init -t microsoft/azurechat
- Run
azd auth login
to authenticate with Azure - Run
azd up
to provision and deploy the application
- Run
-
If you have cloned this repo:
- Run
azd init
from the repo root directory - Run
azd auth login
to authenticate with Azure - Run
azd up
to provision and deploy the application
- Run
The following steps describes how the application can be deployed to Azure App service using GitHub Actions.
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.
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.
-
Create a Service Principal with the Contributor role on the resource group that contains the Azure App Service.
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 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. -
Copy the JSON output from the command.
-
In the GitHub repository, navigate to Settings > Secrets > Actions and select New repository secret.
-
Enter
AZURE_CREDENTIALS
as the name and paste the contents of the JSON output as the value. -
Select Add secret.
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/
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.