MSI MS-96E0 User's Guide

User Guide Release Management for Visual Studio 2013

10 The deployment agent can be configured in the Client by choosing Administration, Settings, Deployer Settings. The following options are availa

100 Parameter Variable Mandatory? Description -NewKeyName No The new name to give to the key. Used only in the ModifyKeyValue action. -CreateFileIf

11 2 CONFIGURATION 2.1 First Time Configuration Using release management features for the first time can seem a bit difficult to grasp. In order t

12  Maximum Resource File Size for Tools – Maximum size (in KB) of a resource attached to a Tool.  Default Component Deployment Timeout – Defaul

13 2.4 Configure Groups 2.4.1 “Everyone” The group named Everyone is a reserved group automatically added by the system. Some security parameters

14 2. Double-click the group you want to start editing. 3. Edit the group name and description. 4. In the Security tab, you can configure permiss

15 2.6.2 Configure Technology Types Technology types are informational values that allow the user to identify what kinds of technologies are used i

16 6. In the Resources section, you can enter one or more resources (executables, scripts, etc.). These resources will then be available to be used

17 Although servers can be registered in the system manually, we recommend they are configured using the Scan for New feature (see next section). 5.

18 2.8.3 Scan for new Servers If you have installed deployment agents before creating the corresponding Servers in release management, you can “sca

19 c. Select whether to use the Server or Gateway IP Address to uniquely identify the Server across multiple networks. 2.9 Configuring Release Pat

ABOUT THIS GUIDE The User Guide for the release management features is for administrators and users. The following related documents for release mana

20 11. Choose the Save & Close button in the Release Path form title bar to persist your changes. The new release path will now appear in the

21 5. Specify how the component gets the files used during the deployment by selecting one of the following 3 options: i. Builds with application:

22 9. Select the configuration variable replacement mode from the Variable Replacement Mode dropdown. Variable Replacement Mode The Variable Replac

23 10. Choose the Add button on top of the list of configuration variables in order to create a new configuration variable for the component. Ente

24 Note: If you cannot find the release template in the list, it may be because its status is inactive. This is the default status when creating a

25 2.12 Deploy a Release 2.12.1 Open a Draft Release We are assuming in this section that a release has already been configured. 1. In the main

26 Note: When debugging to find the reason why a deployment failed, it can be helpful to execute the installation command (which can be found in the

27 2.13.2 Visual Studio 2010, Visual Studio 2012 and Visual Studio 2013 When using Visual Studio 2010, Visual Studio 2012, or Visual Studio 2013, r

28 2.14.2 Updating Metadata Argument Open the argument Metadata. Add the 3 entries found in Metadata collection of ReleaseDefaultTemplate.xaml fi

29 3 - Initialize Tokens logic From the ReleaseDefaultTemplate.xaml, navigate to and copy the Initialize Tokens sequence. Paste it in your Build

3 Contents ABOUT THIS GUIDE ...

30 From the ReleaseDefaultTemplate.xaml, navigate to and copy the If ReleaseBuild is Set sequence. Paste it in your Build Template after the s

31 3 RELEASE TEMPLATES 3.1 Overview The Release Template allows for the definition of the sequence used to orchestrate the deployment of your appl

32 3.3 Deployment Sequence Following the creation of a Release Template, you are placed in the Deployment Sequence view. The Toolbox contains a lis

33 If any of the preceding rules is not met, it will not be possible to activate the Release Template and therefore Releases cannot be created using

34 3.4 Configuration Variables Components and Actions can be dynamically configured by providing values specific to a Stage. This is done via Confi

35 The Configuration Variables panel is useful when you want to compare values across multiple Stages. You can also use it to manage the values (i.e

36 3.5 Copying a stage to another It is possible to copy the entire deployment sequence of a stage onto another one. This is done by using the cont

37 2. When a user opens a release template, he will be informed that it is locked by someone else. The user can still open the release template, b

38 3.7.2 Example 2 During normal execution, if ‘Create Application Pool’

39 4 RELEASES 4.1 Overview Releases represent the physical act of deploying your application through a Release Path until the Target Stage is reac

4 2.10.3 Configure Component in a Release Template ... 23 2.10.4 C

40 When selecting a Release Template that is associated with a Release Path that contains more than one Stage, you can then also select the Target S

41 4.4 Deployment Log The Deployment Log can be accessed by selecting the View Log option. In this view you get all the already completed or curren

42 5 RELEASE EXPLORER 5.1 Overview For approvers, a web client called Release Explorer is available. To access your Release Explorer, request the

43 5.2 Operations 5.2.1 Viewing Component Details To view the Component Details for a Release, 1. Choose the Component button. This will open the

44 5.2.2 Release Stage To retrieve the details of a Release Stage: 1. Choose the blue square, which indicates the active stage. This will open the

45 4. Approve the Release by choosing the Approve button. 5.2.4 Rejecting a Release To reject a Release: 1. Select the Release you want to rejec

46 5.2.5 Reassigning a Release To reassign a Release: 1. Select the release you want to reassign by choosing it. 2. Choose the Reassign button. T

47 Appendix

48 A1. SECURITY MANAGEMENT Release Path Security Introduction The release path can be secured to control who can view, edit or manage security on t

49 5. Choose the Add button to access the group lookup and select one or more group (hold CTRL key to select more than one). 6. Select View, Edit

5 5.2.1 Viewing Component Details ...

50 What is affected? Release Paths Only Release Paths accessible with the View or Edit permission for the user will be visible in the list. When a u

51 3. In the properties of the release template, look under the Security section. 4. By default, the system’s reserved group named Everyone will

52 17. Choose the Security tab. 18. By default, the system’s reserved group named Everyone will have Can Create Release Template permissions. Sin

53 What is affected? Release Templates Only release templates accessible with the View or Edit permission for the user will be visible in the list.

54 Track Release From the release list’s advanced filter (button ), only the release template available in View or Edit will be available. When cre

55 What is affected? Track Releases A release will be visible for a user only if this user has access to its release template or is an approver or i

56 Release Explorer (Web) A release will be visible for a user only if this user has access to its release template or is an approver or is a releas

57 Stage Type Security Introduction The Stage Type can be secured to control who can edit the Configuration Variables, the Target Servers, the Appro

58 Control variables, target servers, approvals and environment permissions 1. Navigate to Administration, Groups. 2. By default, the system’s re

59 What is affected? Release Paths Only environments allowed by the selected stage type will be available in the Environment dropdown list. Also, if

6 Configure Virtual Directory ...

60 Prerequisites Here are some prerequisites in order to use this security level:  You must login using a Release Manager account; Security Groups

61 Prerequisites Here are some prerequisites in order to use this security level:  You must login using a Release Manager account since Inventory

62 A2. ACTIONS CATALOG Windows Azure Start a Windows Azure VM This action allows users to start an existing VM in Windows Azure. It will fail if th

63 Parameters Mandatory? Description IdentityUserDomain No Domain of the user to use as the identity of the application pool. This parameter is allo

64 Parameters Mandatory? Description IsAutoStart No Flag that indicate if the application pool must be started automatically. This parameter is allo

65 Parameters Mandatory? Description RecycleKbMemory No The maximum number of Kb of memory that be used before the application pool is recycled. Rec

66 Parameters Mandatory? Description AppPoolName Yes The name of the application pool to start. Stop Application Pool This action allows users to st

67 Parameters Mandatory? Description SiteName Yes The name of the web site to configure. PortNumber No The port number to use for the web site to co

68 Restart Web Site This action allows users to restart an existing web site under IIS 7.0, 7.5, 8.0 and 8.5. It will fail a deployment if the web s

69 Parameters Mandatory? Description IsPreloadEnabled No Flag that indicate if the preload functionality is enabled for the web application. The all

7 Remove Section ...

70 Parameters Mandatory? Description WebApplicationName No The name of the web application under which the virtual directory resides. If not defined

71 Backup SQL Database This action allows users to backup an existing SQL Server database. The configuration variables of this action are: Parameter

72 Parameters Mandatory? Description FileFolderName Yes The file(s) or folder name and path to delete. Wildcards can be used (i.e. c:\temp\*.log). M

73 Parameters Mandatory? Description System No Allow the user to set or reset the file(s) or folder system attribute. - + : Set the flag - - : Res

74 Parameters Mandatory? Description VariableValue No The new value to give to the variable. If no value is set, the variable will be deleted. Delet

75 Delete Windows Registry Key This action allows deleting an existing registry key. It will fail if the registry key does not exist. The configurat

76 Parameters Mandatory? Description OperatingSystemType No The operating system type in which to create the registry value. The allowed values are:

77 Delete Windows Registry Value This action allows deleting an existing registry value. It will fail if the registry value does not exist. The conf

78 Parameter Variable Mandatory? Description -command N/A Yes Fixed value ./WindowsProcess.ps1. -ProcessName Yes The name of the Windows process to

79 Configure Service This action allows users to configure an existing Windows service. It will fail if the service to configure does not exist. The

8 1 OVERVIEW 1.1 Introduction Release management is a continuous deployment solution that makes release cycles repeatable, visible and more effici

80 Parameters Mandatory? Description ServiceName Yes Name of the service to delete. Start Service This action allows users to start an existing Wind

81 Parameters Mandatory? Description NewSectionName No The new section name to affect. If not specified, the keys of the old section will be put und

82 Parameters Mandatory? Description SectionName No The section name where the key is to be modified. If not specified, the root section will be con

83 A3. TOOLS CATALOG Database Deployment Agent – Execute Script This tool allows users to execute a SQL query in a specific database. It is based o

84 Parameter Variable Mandatory? Description -i Yes if single items Item file. If specified, the item name must be provided (-n). This parameter is

85 Parameter Variable Mandatory? Description -PrevProductName No Allow the user to specify the previous product name to be uninstalled prior to ins

86 Windows Registry Manager This tool allows users to manipulate registry information in Windows. It is based on a custom release management PowerSh

87 Parameter Variable Mandatory? Description -ValueType No Type of the value being affected. The accepted values are: - REG_SZ : String (default v

88 Windows Common IO This tool allows users to perform common IO under Windows. It is based on a custom release management PowerShell script. The co

89 Parameter Variable Mandatory? Description -OwnerDomain No Represent the domain of the new owner to affect to the file or folder. -OwnerName No

9 1.2 Main Components The following figure shows the main components that require deployment in order for release management components to function

90 Parameter Variable Mandatory? Description -UserName No User name that will be used for the credentials to start the service (must be in the form

91 Parameter Variable Mandatory? Description /TargetDatabaseName: DatabaseName Yes The name of the SQL Server database where to publish. IIS Deploym

92 Parameter Variable Mandatory? Description -apIdentUserPassword No The password of the user to use as the identity of the application pool. This

93 Parameter Variable Mandatory? Description -AutoStart No Flag that indicate if the application pool must be started automatically. This parameter

94 Parameter Variable Mandatory? Description -AutoStart No Allowed on IIS 7.0, 7.5, 8.0 and 8.5. Flag that indicates if the web site must be automa

95 Parameter Variable Mandatory? Description -Action Yes Indicate the action to be performed: - CreateVirtualDirectory - ConfigureVirtualDirector

96 XBAP Deployer This tool allows users to deploy XBAP application. It is based on a custom release management executable. The configuration variabl

97 Parameter Variable Mandatory? Description -SuiteId SuiteId Yes The identifier of the Teat Plan under which the tests must run (Unique ID as defin

98 Parameter Variable Mandatory? Description -BuildNumber No* Allows the user to specify the build number whose drop location will contain the Auto

99 TFSCollection $(TfsUrlWithCollection) TeamProject $(TeamProject) INI File Manager This tool allows users to alter the content of an INI file and