We started 2018 with multiple deployments during regular business hours for one of our clients – the same client that used to send out multiple emails to their users about system outage for a big bang deployment during off hours having their entire team in office for smoke testing …. A scenario that today seems prehistoric even though a few years old !
Welcome to the world of DevOps – continuing from our previous post on this topic ensure to put some Castrol on your engine or in tech speak – CICD on your deployment pipe.
Continuous Integration refers to a software development practice where programmers integrate and check-in their code frequently.
Continuous Delivery refers to a software development discipline where you build software in such a way that it can be released to production at any time.
Continuous Deployment means that every change you make gets automatically deployed through a deployment pipeline. This term is often confused with “Continuous Delivery”.
Traditionally we have seen that teams are more focused during Go Live ! In fact I can tell that apart from a few, most folks that will be affected due to the solution are not involved (or care much) till it is Live. One solution to this problem is to go live often … this solution is a challenge using traditional Big Bang GO Live model. It can be implemented by
- Reducing the feature list that it included in each release
- Automating the release process
You can get an idea of the first point outlined in this blog post.
The second point is where CICD is used.
There are MANY tools available that can get this done but in the end you need to ensure it is acceptable with your change control team (Audit, compliance, ‘server guys’ ! Etc…)
As we help our clients move to the cloud leveraging the container based deployments and transferring the compliance risks to the cloud service providers like Microsoft and Amazon we work with solutions that have ample support and integrate with the development tools. During our Microsoft Gold Certification we validated our CICD process using Azure. It integrates very well Visual Studio and deployments are permission controlled for each environments.
System Requirements for deploying an agent on Windows
To build your code or deploy your software you need at least one agent. When your build or deployment runs, the system begins one or more jobs. An agent is install-able software that runs one build or deployment job at a time.
There are two types of agents: Hosted Agents and Private Agents.
Hosted Agents: If you’re using Team Services, you have the option to build and deploy using a hosted agent. When you use a hosted agent, maintenance and upgrades are taken care of by the Teams Service. So for many teams this is the simplest way to build and deploy. The hosted agents are there in the hosted pool. If you need to run more than one job at a time, you’ll need to get more concurrent pipelines.
Private Agents: An agent that you set up and manage on your own to run build and deployment jobs is a private agent. You can use private agents in Team Services or Team Foundation Server (TFS). Private agents give you more control to install dependent software needed for your builds and deployments. After you’ve installed the agent on a machine, you can install any other software on that machine as required by your build or deployment jobs.
Before creating and deploying your agent, make sure that your machine is prepared with the Windows system prerequisites:
- Windows 10 and Beyond (64-bit): No known system prerequisites are known at this time.
- Windows 7 to Windows 8.1, Windows Server 2008 R2 SP1 to Windows Server 2012 R2 (64-bit): PowerShell 3.0 or higher
- Visual Studio: Even though not technically required by the agent, many build scenarios require Visual Studio installed to get all the tools. It is recommended that you install Visual Studio 2015 or higher in your machine.
Prepare Permissions to Register Agent
Decide which user account you’re going to use to register the agent.
- Point your web browser to the visual studio URL: https://<your company>.visualstudio.com/ and key in the login credentials.
- From your home page, mouse-over your profile. Go to your security details.
- Create a personal access token (PAT) by clicking on “Add” under Personal Access Tokens:
- Key in the description, set “Expires In” option to 1 year and select <company> as “Accounts”.
- For the scope select “Agent Pools (read, manage)” and make sure all the other boxes are cleared.
- Click on “Create Token“.
- Copy the token that is generated and keep it in a notepad. You will use this token when you configure the agent.
Download and configure your agent
- Point your web browser to the teams services URL: https://<your company>.visualstudio.com/_admin/_AgentPool and click on “New Pool”.
- Key in pool name and click “Ok”.
- The pool thus created appears under the All Pools In this case we’ve created a new pool – Exigent-FJC.
- Select the pool name i.e. Exigent-FJC, and click Download Agent.
- On the Get agent dialog box, Windows remain selected by default.
- Click the Download button
- Follow the instructions on the page.
Creating Build Definition
A build definition is the entity through which you define your automated build process.
- In Team Explorer, select the project for which you want to create a new build definition. In this case we’ve selected– “MSTN”.
- Select “Build & Release” hub in your Team services project. The Builds tab will remain selected by default. Create a new definition by clicking on “New“.
- Start with an empty process.
- Specify whatever Name you want to use. For the Default agent queue, select Hosted.
- Click Save & queue, and then click Save.
A task is the building block for defining automation in a build definition. In the build definition, you compose a set of tasks, each of which performs a step in your build. The task catalogue provides a rich set of tasks for you to get started.
Different sets of tasks have to be created for Azure and non-Azure servers. Let us first understand the tasks to be created for Azure servers.
On the Tasks tab, click Add Task, and add the following tasks with their respective sets of parameters:
- NuGet restore: Click the —- category, click the NuGet restore task, and then click
- Enter display name.
- Path to Publish: Path to the folder or file you want to publish. The path must be a fully qualified path or a valid path relative to the root directory of your repo. Enter the following path: **/*.sln
- Feeds to use: select the option “Feed(s) I selected here”.
- Checkmark the option “Use packages from NuGet.org“
- Click on “Save & Queue” to save the task.
- Visual Studio Build: Go to Build category, click the Visual Studio Build task, and then click
- Enter the display name as you want it to be.
- Solution: If you want to build a single solution, click the … button and select the solution. If you want to build multiple solutions, specify search criteria. You can use a single-folder wildcard (*) and recursive wildcards (**). For example, ***.sln searches for all .sln files in all subdirectories. Make the sure the solutions you specify are downloaded by this build definition.
- Visual Studio Version: select Visual Studio 2015.
- MSBuild Arguments: pass additional MSBuild arguments as shown in the screen shot above.
- Platform: Specify the platform you want to build.
- Configuration: Specify the configuration you want to build such as debug or release.
- Once done, click on “Save & Queue” to save the task.
- Index Sources & Publish Symbols: Go to Build category, click the Index Sources & Publish Symbols task, and then click
- Path to publish symbols: If you want to publish your symbols, specify the path to the SymStore file share. This is an optional field. If you leave this argument blank, your symbols will be source indexed but not published.
- Search pattern: Specify search criteria to find the .pdb files in the folder that you specify in Path to symbols folder argument. You can use a single-folder wildcard (*) and recursive wildcards (**). For example, **bin***.pdb searches for all .pdb files in all subdirectories named bin.
- Path to symbols folder: The path to the folder you want to search for symbol files. If you leave it blank, the path used is Build.SourcesDirectory.
- Once done, click on “Save & Queue” to save the task.
- Publish Build Artifacts: Go to the Utility category, click the Publish Build Artifacts task, and then click
- Enter the display name.
- Path to publish: Path to the folder or file you want to publish. The path must be a fully qualified path or a valid path relative to the root directory of your repo. Typically you’ll specify $(Build.ArtifactStagingDirectory).
- Artifact name: Specify the name of the artifact. For example: drop.
- Artifact Type: Choose server to store the artifact on your Team Foundation Server.
- Click on “Save & Queue” to save the task.
Creating Releases in Release Management
A release is the package or container that holds a versioned set of artifacts specified in a release definition. It includes a snapshot of all the information required to carry out all the tasks and actions in the release definition – like the environments, the task steps for each one, the values of task parameters and variables, and the release policies such as triggers, approvers, and release queuing options.
Releases can be created from a release definition in several ways:
- By a continuous deployment trigger that creates a release when a new version of the source build artifacts is available.
- By using the Release command in the UI to create a release manually from the Releases tab or the Builds tab.
- By sending a command over the network to the REST interface.
Whatever be the approach of creating a release definition, please understand that the action of creating a release does not mean that it will automatically or immediately start a deployment.
Here, we’ll discuss creating release definition by continuous deployment trigger.
- To create a release definition, choose Create Release Definition from the Release drop-down list.
- Start with an empty definition.
- Click Next. The project and build definition for which the release is being created will be selected by default. Click Create.
- Give your Release definition a name by clicking on the edit icon and click on Save.
- Once you save a release definition it shows up in the list of all Release Definitions.
An environment is a logical and independent entity that represents where you want to deploy a release generated from a release definition. Dev, QA and Prod are some good examples of release environment. As new builds are produced, they can be deployed to Dev. They can then be promoted to QA, and finally to Prod. At any time, each of these environments may have a different release (set of build artifacts) deployed to them.
A release definition, by default, contains a single environment. You can however, configure additional to represent the target server(s) or locations where you will deploy your app.
- To create a new environment, edit the release definition. In this case, let’s edit MSTN Release.
- Click on Add environment and choose Create new environment.
- In the Add new environment dialog select a template for the new environment to automatically add appropriate tasks, or create an empty environment with no default tasks.
- Select the pre-deployment approval and trigger settings for the new environment. You can quickly select users or groups as pre-deployment approvers by typing part of the name.
- Choose Create and then edit the new environment name as required.
You can define approvers for each environment. When a release is created from a release definition that contains approvers, the deployment stops at each point where approval is required until the specified approver grants approval or rejects the release (or re-assigns the approval to another user).
You can define pre-deployment approvers, post-deployment approvers, or both for an environment.
The Automatic option allows you to approve a deployment automatically. When you select the Specific Users option, you can select one or more approvers for an approval step. You can add multiple approvers for both pre-deployment and post-deployment settings.
When you add multiple approvers, you can control how they can approve the deployment. The options are:
- All users in any order: Choose this option if you want sign-off from a set of users, all of them must approve, and it does not matter in what order they approve.
- All users in sequential order: Choose this option if you want sign-off from a set of users, all of them must approve, and you want them to approve in the specified order. For example, the second user can approve only after the first user approves, and so on.
- Any one user: Choose this option if you want sign-off from only one of a set of users. When any one of the users approves, the release moves forward.
You can also specify account (user) groups as approvers. When a group is specified as an approver, only one of the users in that group needs to approve in order for the release to move forward.
After you have created and configured your environments, add tasks to them.
Select an environment in the definition and choose Add tasks.
By default, the task selector shows tasks generally used in a release definition. More tasks are available in the other tabs of the Task catalogue dialog. Add the following release tasks with their respective sets of parameters:
- Azure App Service Deploy: Go to Deploy category, click the Azure App Service Deploy task, and then click
- Click on the edit icon to enter your preferred display name.
- Azure Subscription: Select the AzureRM Subscription. If none exists, then click on the Manage link, to navigate to the Services tab in the Administrators panel. In the tab click on New Service Endpoint and select Azure Resource Manager from the dropdown.
- App Service Name: Select the name of an existing AzureRM Web Application. Enter the name of the Web App if it was provisioned dynamically using the Azure PowerShell task and AzureRM PowerShell scripts.
- Deploy to Slot: Select the option to deploy to an existing slot other than the Production slot. Do not select this option if the Web project is being deployed to the Production slot. The Web App itself is the Production slot.
- Virtual Application: Specify the name of the Virtual Application that has been configured in the Azure portal. The option is not required for deployments to the website root. The Virtual Application should have been configured prior to deploying the Web project to it using the task.
- Package or Folder: Location of the Web App zip package or folder on the automation agent or on a UNC path accessible to the automation agent like, \BudgetITWebDeployFabrikam.zip. Predefined system variables and wild cards like, $(System.DefaultWorkingDirectory)***.zip can be also used here.
- Visual Studio Tests: Go to the Test category, click the Visual Studio Test task, and then click
- Test Assembly: Use this to specify one or more test file names from which the tests should be picked.
- Paths are relative to the ‘Search Folder’ input.
- Multiple paths can be specified, one on each line.
- Uses the minimatch patterns
For example: To run tests from any test assembly that has ‘test’ in the assembly name, ***test*.dll. To exclude tests in any folder called obj, !**obj**.
- Test Filter Criteria: Filters tests from within the test assembly files. For example, “Priority=1 | Name=MyTestMethod”. This option works the same way as the console option /TestCaseFilter of vstest.console.exe
- Run Settings File: Path to a runsettings or testsettings file can be specified here. The path can be to a file in the repository or a path to file on disk. Use $(Build.SourcesDirectory) to access the root project folder.
- Override TestRun Parameters: Override parameters defined in the TestRunParameters section of the runsettings file. For example: Platform=$(platform);Port=8080 Click here for more information on overriding parameters.
- Code Coverage Enabled: If set, this will collect code coverage information during the run and upload the results to the server. This is supported for .Net and C++ projects only. Click here to learn more about how to customize code coverage and manage inclusions and exclusions.
- Run in Parallel: If set, tests will run in parallel leveraging available cores of the machine. Click here to learn more about how tests are run in parallel.
- Cloud-based Web Performance Test: Go to the Test category, click the Cloud-based Web Performance Test task, and then click Add
- Enter the display name.
- VS Team Service Connection: It is the name of a Generic Service Endpoint that refers to the Team Services account you will be running the load test from and publishing the results to. Since it’s an optional field you may leave it blank.
- Website URL: Enter the URL of the app to test.
- Test Name: Enter a name for this load test. This particular name is used to identify it for reporting and for comparison with other test runs.
- User Load: The number of concurrent users to simulate in this test. Select a value from the drop-down list.
- Run Duration (sec): The duration of this test in seconds. Select a value from the drop-down list.
- Load Location: The location from which the load will be generated. Select a global Azure location, or Default to generate the load from the location associated with your Team Services account.
- Run load test using: Select “Automatically provisioned agents” if you want the cloud-based load testing service to automatically provision agents for running the load tests. The application URL must be accessible from the Internet.
Alternatively, select “Self-provisioned agents” if you want to test applications behind the firewall. You must provision agents and register them against your Team Services account when using this option.
- Fail test if Avg. Response Time (ms) exceeds: Specify a threshold for the average response time in milliseconds. If the observed response time during the load test exceeds this threshold, the task will fail.
Once done, click on “Save” to save the tasks and the release definition.
A release definition often contains several environments such as development, testing, QA, and production. Typically, all these environments are fundamentally similar, and the techniques used to set up and deploy to each one are the same with the exception of minor differences in configuration for each environment and task (such as target URLs, service paths, and server names).
After you have added an environment to a release definition and configured it by adding tasks and setting the properties for each one, clone it to create another environment within the same definition. Select the environment you want to clone in the environments column, open the Add environment list, and choose Clone selected environment.
The cloned environment has the same tasks, task properties, and configuration settings as the original. The Add new environment dialog that opens lets you change the pre-deployment approval and trigger settings for the cloned environment.
You can configure when releases should be created through release triggers in a release definition.
With certain types of artifacts specified in a release definition, enable Continuous deployment.
This setting instructs Release Management to create new releases automatically when it detects new artifacts are available. At present this option is available only for Team Foundation Build artifacts and Git-based sources such as Team Foundation Git, GitHub, and other Git repositories.
If you have linked multiple Team Foundation Build artifacts to a release definition, you can configure continuous deployment for each of them. In other words, you can choose to have a release created automatically when a new build of any of those artifacts is produced. You can further choose to create the release only when the build is produced by compiling code from certain branches (only applicable when the code is in a Team Services or a TFS Git repository) or when the build has certain tags.
You can also choose to have a release created automatically based on a schedule. When you select this option, you can select the days of the week and the time of day that Release Management will automatically create a new release. You can configure multiple schedules as required.
You can also combine the two automated settings and have releases created automatically either when a new build is available or according to a schedule.
See these steps in action here:
Blog post by: Sam Banerjee. Reach Sam @ firstname.lastname@example.org
Sam ensures Medullus’s drumbeat of execution is in rhythm (heads Operations!) – an IT professional with a myriad of experience across various platforms and domains with significant knowledge in the design, implementation and testing of various systems for organizations as ADP, Bristol-Myers Squibb & Ross Stores. With a Masters in Computer Science from SUNY, Sam leads the Tech innovations within Medullus (Artificial Intelligence, BlockChain, Mobility, BI).