Skip to content
This repository has been archived by the owner on Nov 25, 2021. It is now read-only.

Latest commit

 

History

History
268 lines (228 loc) · 11.8 KB

DotNet-FunctionApp-CD.md

File metadata and controls

268 lines (228 loc) · 11.8 KB
Raw

Here is one example to Release a .NET method to an Azure Function App. You could adapt it with your own context, needs and constraints.

2 ways to create the associated Release Definition + another one just to deploy the Azure services:

Import the Release Definition

You could import the associated Release Definition stored in this repository and then follow these steps to adapt it to your current project, credentials, etc.:

TODO

Create manually the Release Definition

Overview

Release Overview

Artifacts

  • Build - DotNet-FunctionApp-CI
    • Source (Build definition) = DotNet-FunctionApp-CI
    • Default version = Latest
    • Source alias = DotNet-FunctionApp-CI
    • Continuous deployment trigger = Enabled

Variables

  • ResourceGroupName = set appropriate
  • SlotName = staging
  • Location = East US
  • ReleaseConfiguration = Release
  • ReleasePlatform = Any CPU
  • functionUrl =
    • Empty, because it will be set by the "Set functionUrl variable" task.
  • deployProductionWhileDeployingStaging =
    • Empty, because it will be set by the "Set deployProductionWhileDeployingStaging variable" task.
  • FunctionAppName = set appropriate
  • FunctionName = SampleHelloDotNetFunction
  • FunctionUrlTestQueryString = &name=test

Release Variables

Staging Environment

Staging Release Overview

Pre-deployment conditions

  • Triggers
    • Select the source of the trigger = Release
  • Pre-deployment approvers
    • Approval type = Automatic

Tasks

  • Set deployProductionWhileDeployingStaging variable
    • Type = Azure PowerShell
    • Version = 1.*
    • Azure Connection Type = Azure Resource Manager
    • Azure Subscription = set appropriate
    • Script Type = Script File Path
    • Script Path = $(System.DefaultWorkingDirectory)/DotNet-FunctionApp-CI/scripts/SetDeployProductionWhileDeployingStagingVariableValue.ps1
    • Script Arguments = -WebAppName $(ResourceGroupName)
  • Provision Staging
    • Type = Azure Resource Group Deployment
    • Version = 2.*
    • Azure Subscription = set appropriate
    • Action = Create Or Update Resource Group
    • Resource Group = $(ResourceGroupName)
    • Location = $(Location)
    • Template location = Linked artifact
    • Template = $(System.DefaultWorkingDirectory)/DotNet-FunctionApp-CI/infra/deplo-slot.json
    • Override Template Parameters = -functionAppName $(FunctionAppName) -slotName $(SlotName)
    • Deployment Mode = Incremental
  • Set Resource Group ResourceTypes policy
    • Type = Azure PowerShell
    • Version = 1.*
    • Azure Connection Type = Azure Resource Manager
    • Azure Subscription = set appropriate
    • Script Type = Script File Path
    • Script Path = $(System.DefaultWorkingDirectory)/DotNet-FunctionApp-CI/scripts/AddResourceGroupAllowedResourceTypesPolicy.ps1
    • Script Arguments = -ResourceGroupName $(ResourceGroupName)
  • Set Resource Group Locations policy
    • Type = Azure PowerShell
    • Version = 1.*
    • Azure Connection Type = Azure Resource Manager
    • Azure Subscription = set appropriate
    • Script Type = Script File Path
    • Script Path = $(System.DefaultWorkingDirectory)/DotNet-FunctionApp-CI/scripts/AddResourceGroupAllowedLocationsPolicy.ps1
    • Script Arguments = -ResourceGroupName $(ResourceGroupName)
  • Deploy Function App on Staging
    • Type = Azure App Service Deploy
    • Version = 3.*
    • Azure Subscription = set appropriate
    • App Service Name = $(FunctionAppName)
    • Deploy to Slot = true
    • Resource Group = $(ResourceGroupName)
    • Slot = $(SlotName)
    • Package or Folder = $(System.DefaultWorkingDirectory)/DotNet-FunctionApp-CI/function
    • Publish using Web Deploy = true
    • App Service URL = BaseUrl
  • Get Function Outputs
    • Type = Azure Resource Group Deployment
    • Version = 2.*
    • Azure Subscription = set appropriate
    • Action = Create Or Update Resource Group
    • Resource Group = $(ResourceGroupName)
    • Location = $(Location)
    • Template location = Linked artifact
    • Template = $(System.DefaultWorkingDirectory)/DotNet-FunctionApp-CI/infra/get-function-outputs-slot.json
    • Override Template Parameters = -functionAppName $(FunctionAppName) -functionName $(FunctionName) -slotName $(SlotName)
    • Deployment Mode = Incremental
  • Set functionUrl variable
    • Type = ARM Outputs
    • Version = 1.*
    • Azure Connection Type = Azure Resource Manager
    • AzureRM Subscription = set appropriate
    • Resource Group = $(ResourceGroupName)
    • Outputs to process = functionUrl
  • Check Staging URL
    • Type = Check URL Status
    • Version = 1.*
    • URL = $(functionUrl)$(FunctionUrlTestQueryString)
  • Replace tokens in IntegrationTests config file
    • Type = Replace Tokens
    • Version = 2.*
    • Target files = $(System.DefaultWorkingDirectory)/DotNet-FunctionApp-CI/integration-tests/*.config
    • Files encoding = auto
    • Write unicode BOM = true
    • Action (Missing variables) = fail
    • Keep token = true
    • Token prefix = #{
    • Token suffix = }#
  • Run IntegrationTests
    • Type = Visual Studio Test
    • Version = 2.*
    • Select tests using = Test assemblies
    • Test assemblies = *IntegrationTests.dll
    • Search folder = $(System.DefaultWorkingDirectory)/DotNet-FunctionApp-CI/integration-tests
    • Select test platform using = Version
    • Test paltform version = Latest
    • Test run title = IntegrationTests
    • Build Platform = $(ReleasePlatform)
    • Build Configuration = $(ReleaseConfiguration)
    • Upload test attachments = true

Production Environment

Production Release Overview

Pre-deployment conditions

  • Triggers
    • Select the source of the trigger = Environment
    • Environment(s) that will trigger a deployment = Staging
  • Pre-deployment approvers
    • Approval type = Specific users
    • Select approvers = set appropriate

Tasks

  • Swap Staging to Production
    • Type = Azure App Service Manage (PREVIEW)
    • Version = 0.*
    • Azure Subscription = set appropriate
    • Action = Swap Slots
    • App Service Name = $(FunctionAppName)
    • Resource Group = $(ResourceGroupName)
    • Source Slot = $(SlotName)
    • Swap with Production = true
  • Set Resource Group DoNotDelete Lock
    • Type = Azure PowerShell
    • Version = 1.*
    • Azure Connection Type = Azure Resource Manager
    • Azure Subscription = set appropriate
    • Script Type = Script File Path
    • Script Path = $(System.DefaultWorkingDirectory)/DotNet-FunctionApp-CI/scripts/AddResourceGroupDoNotDeleteLock.ps1
    • Script Arguments = -ResourceGroupName $(ResourceGroupName)
  • Get Function Outputs
    • Type = Azure Resource Group Deployment
    • Version = 2.*
    • Azure Subscription = set appropriate
    • Action = Create Or Update Resource Group
    • Resource Group = $(ResourceGroupName)
    • Location = $(Location)
    • Template location = Linked artifact
    • Template = $(System.DefaultWorkingDirectory)/DotNet-FunctionApp-CI/infra/get-function-outputs.json
    • Override Template Parameters = -functionAppName $(FunctionAppName) -functionName $(FunctionName)
    • Deployment Mode = Incremental
  • Set functionUrl variable
    • Type = ARM Outputs
    • Version = 1.*
    • Azure Connection Type = Azure Resource Manager
    • AzureRM Subscription = set appropriate
    • Resource Group = $(ResourceGroupName)
    • Outputs to process = functionUrl
  • Check Production URL
    • Type = Check URL Status
    • Version = 1.*
    • URL = $(functionUrl)$(FunctionUrlTestQueryString)

General remark

For the "Set Resource Group DoNotDelete Lock", "Set Resource Group ResourceTypes policy" and "Set Resource Group Locations policy" steps, you will need to make sure that your default Service Principal user created by VSTS (during the Azure RM service endpoint creation) has the Owner role and not by default the Contributor role. Otherwise this task will fail. To assign the Owner role, you could go to the Access control (IAM) blade of your Azure subscription within the new Azure portal and then Assign (Add button) the associated VisualStudioSPN... user to the Owner role.

Rollback Environment

This environment should be used just if necessary when the bad things happened in Production just after this release pipeline. It allows to be prepared by automation to rollback the changed and get back to the previous version.

Rollback Release Overview

Pre-deployment conditions

  • Triggers
    • Select the source of the trigger = Environment
    • Environment(s) that will trigger a deployment = Production
  • Pre-deployment approvers
    • Approval type = Specific users
    • Select approvers = set appropriate

Tasks

  • Rollback Swap
    • Type = Azure App Service Manage (PREVIEW)
    • Version = 0.*
    • Azure Subscription = set appropriate
    • Action = Swap Slots
    • App Service Name = $(FunctionAppName)
    • Resource Group = $(ResourceGroupName)
    • Source Slot = $(SlotName)
    • Swap with Production = true
  • Get Function Outputs
    • Type = Azure Resource Group Deployment
    • Version = 2.*
    • Azure Subscription = set appropriate
    • Action = Create Or Update Resource Group
    • Resource Group = $(ResourceGroupName)
    • Location = $(Location)
    • Template location = Linked artifact
    • Template = $(System.DefaultWorkingDirectory)/DotNet-FunctionApp-CI/infra/get-function-outputs.json
    • Override Template Parameters = -functionAppName $(FunctionAppName) -functionName $(FunctionName)
    • Deployment Mode = Incremental
  • Set functionUrl variable
    • Type = ARM Outputs
    • Version = 1.*
    • Azure Connection Type = Azure Resource Manager
    • AzureRM Subscription = set appropriate
    • Resource Group = $(ResourceGroupName)
    • Outputs to process = functionUrl
  • Check Production URL
    • Type = Check URL Status
    • Version = 1.*
    • URL = $(functionUrl)$(FunctionUrlTestQueryString)

Deploy to Azure buttons

By using the buttons below it's another way to deploy the Azure services without VSTS and without taking into account the app/method by itself, just deploying the infrastructure within Azure.

The Azure Function App + its Blob storage + Application Insights:

Deploy to Azure

The Azure Function App Slot + its Application Insights (you should deploy the Azure Function App before, see button above):

Deploy to Azure