Learn how to easily set up Azure Key Vault to manage connection string and other sensitive information for your applications.
How To Deploy Web App and Web Job In A Single Pipeline
How do you deploy an Azure Web App along with a Web Job?
I keep getting this question. I had covered how to Continuously Deploy Your .NET Core Azure WebJobs in a previous post. Check that out if you are getting started with WebJobs.
This post will add to the earlier project, an Azure Web App and show how to set up a build and deploy pipeline for both Web App and Web Job.
Let’s add an ASP NET Core React Single Page Application to the WebJob project, using the Add New Project in Visual Studio.
The solution now has two projects:
- WebApExample - React Single Page Application
- WebJobExample.WebJob - Web Job Application (set up in this post in detail)
Let’s push this up into Azure DevOps repository, where we will set up the build and deploy pipeline.
Let’s create a new Build Pipeline for this new repository. We already have an
azure-pipelines.yml from the previous Web Jobs set up. All we need to do is add tasks to build the Web App project as well.
publish task, has a specific folder structure (App_Data/jobs/continuous/YoutubeWebJob) as the output folder. It is by convention, and Azure expects WebJobs to be in that folder structure in the web server (IIS). The build artifacts folder changes depending on whether the WebJob is continuous (AppData/jobs/continuous) or triggered (App_Data/jobs/triggered).
publish task uses a wildcard pattern to find the csproj file within the source repository. It was fine when it had only one project. Since now we have two project files, let’s update that to be more specific to our WebJobs project file -
To publish the Web App project, we can add one more DotNetCoreCLI task to the build pipeline (very similar to the publish task for WebJobs)
- task: [email protected] inputs: command: 'publish' publishWebProjects: true arguments: '--output $(Build.BinariesDirectory)/publish_output' zipAfterPublish: false modifyOutputPath: false
The CLI task publishes the web project into the same output folder as that of the Web Jobs. It has zip package turned off since we zip it before publishing the artifact.
azure-pipelines.yml file is available here.
With the build artifact ready, let’s release this to an Azure Web App.
To keep things simple, I’ll be manually creating the resources required to deploy the application manually.
However, I suggest setting up the resources through code. It is referred to as Infrastructure as Code (IaC). One way to implement Infrastructure as code for Azure solutions is to use Azure Resource Manager (ARM) Templates.
But for now, let’s head off to Azure Portal and manually create the resources.
- Azure Web App → To deploy the Web App and Web Job
- Storage Account → Queue where Web Job is listening for messages.
As shown below, create the resources under a Resource Group. A Resource Group is a container that holds related resources for an Azure solution.
To create a new release pipeline under Pipelines → Releases, use the ’New Release Pipeline’ option.
It prompts you to select a template. Choose ‘Azure App Service deployment’, to deploy into an Azure App Service.
The template will automatically set up one stage with the required task to deploy the Azure Web App.
- Under the Artifacts section, select the Build Artifact that we created in the previous step.
- If you want the Release to be automatically triggered, use the icon on top of the Artifacts session and enable ’Continuous deployment trigger‘.
- Give the Pipeline an appropriate name.
- Select the Dev Stage to set up the Task
For the Dev Stage, select the Azure Web App instance created in the previous step.
The appsettings.json file under WebJob project expects the
AzureWebJobsStorage to be populated with a valid Storage Account connection string. To view and copy the connection string, navigate to Access keys under the storage account.
The Variables section in the Release Pipeline helps manage Stage (or environment) specific variables in Azure DevOps. Add a key-value pair for the Scope (stage or environment), in this case, Dev.
To replace the variable value during Release, specify the
appsettings.json file path under the ‘File Transforms & Variable Substitution Options` section for the ‘Deploy Azure App Service Task’.
If you are new to Variables in Azure DevOps, check out the video below which explains it in detail.
When a release is created and deployed to an environment, it will replace the file with the key-value from Variables.
The Task by default uses Zip Deploy unless explicitly specified under the ‘Additional Deployment Options’ section.
With Zip Deploy, it deploys the entire file contents to the wwwroot folder of the Azure App Service. It will overwrite all existing files.
Save and Create a new Release!
We have successfully set up a build/release pipeline for a Web App with a Web Job.
Navigate the Azure App Service URL, and you can see the default React Single Page Application template application running. The Web Job is also successfully running, and you can view that under the Web Jobs section under the App Service in Azure Portal.
I often get asked whether to set up a single release pipeline or multiple pipelines to deploy a Web App and associated Web Job.
If the Web App and Web Job are usually deployed together and depend on each other, then I suggest keeping this in the same pipeline as we have seen above.
However, if the Web Job and the Web App are unrelated and changes are independent and need to be released independently, I suggest keeping them in different App Service.
Instead of deploying it under the same App Service as the Web App, you can create a new App Service. For Azure Web App, the pricing is at the Azure App Service Plan. You can create both the App Service under the same plan to save on cost. You can then create one pipeline for Web App and another pipeline for Web Job.
Keeping it separate avoids deploying into specific folders of the App Service (in this case, web app into wwwroot and web jobs to the AppData/jobs). Any changes to the file will trigger a restart of the App Service instance. You could also consider making the Web Job an Azure Function in this case.
I hope this helps to successfully set up a build deploy pipeline for your Web App and Web Job!
Below are the DevOps links