Installing the Visual Studio IDE Integration

Installation and Upgrade Notes

New Visual Studio Integration Release Strategy

Starting in August 2019, the release strategy for the Visual Studio integration is updated to add a “preview” release in addition to the standard long-term support (LTS), maintenance (patch), and hotfix releases.

The release numbering for the preview releases uses a new <year> . <month> .00 numbering scheme. For example, {product-version-for-vsp-2020.01.00.build} .

CloudBees recommends that you upgrade to the preview release and test these features in a controlled environment before rolling them out to production.

For details about the new release strategy, see the CloudBees Build Acceleration Release Strategy Update web page.

Upgrade Notes

CloudBees recommends regenerating the history file after you upgrade the Visual Studio Integration.

Installing the Integration Using the GUI

To install the Visual Studio IDE integration using the installation wizard:

  1. Right-click the VSIntegration-<version>-Install.exe file and choose Run as administrator.

  2. When the CloudBees Build Acceleration VS Integration Setup screen appears, click Next.

  3. When the welcome screen appears, click Next.

  4. When the Choose Destination Location screen appears, click Next to accept the default installation location ( C:\ECloud ) or click Browse to change the location and then click Next.

  5. When the Setup Type screen appears, click to choose a setup type and then click Next :

    • CloudBees Build Acceleration VS Integration Local Install

    • CloudBees Build Acceleration VS Integration Cluster Upgrade —Upgrades the Visual Studio IDE Integration on all Windows cluster agents that are registered to the Cluster Manager that you specify.

      For the Visual Studio Integration VSPackage cluster upgrade to proceed, the installation directory on all agents must be C:\ECloud, and you must have installed eRunner on the Cluster Manager and agent machines.
  6. When the Select Visual Studio Version screen appears, click Next to install the converter in all installed Visual Studio versions, or select specific versions and then click Next. By default, all versions are selected.

  7. When the Select Visual Studio Version screen appears, make the following selections and then click Next :

    • Installed versions —Choose specific Visual Studio versions where you want the converter to be installed.

      By default, all the Visual Studio versions are selected .

    • Initialize Visual Studio for ECloudInternalUsers —If you do not virtualize the toolchain, you must use this option, which initializes Visual Studio on every agent host for each ECloudInternalUser.

      Each agent runs as user ECloudInternalUser1, ECloudInternalUser2, and so on.

  8. When the Installing screen appears, you can view the progress of the installation.

  9. When the CloudBees Build Acceleration VS Integration Setup screen displays CloudBees Build Acceleration VS Integration Wizard Complete, your installation is complete. Click Finish to close the installer.

The installation log file is in the installation directory’s root, C:\ECloud by default.

Installing the Integration Silently

To perform a silent installation, follow these steps:

  1. For the first installation, run the installation with the /save-response-file <filename> option and your desired settings.

    This creates the response file in the directory where you ran the installer.

  2. For subsequent silent identical installations, use the resulting response file by using the /response-file <filename> and /mode silent options.

The syntax for silent installation is:

VSIntegration-<version>-Install.exe [<options>]

Option Description

/ clustermanagerhost <hostname_or_IP>

Cluster manager to be used for the cluster upgrade.

/mode <install_mode>

Installation mode. Available values are standard (default) or silent.

/prefix <directory>

Installation directory.

/response-file <response_input_file>

File from which to read installer responses.

/save-response-file <response_output_file>

File to which installer responses are written when the installer exits.

/temp <temp_dir>

Temporary directory used by the installer.

/ type <install_type>

Type of installation. Available values are uiaddin and cluster.

/version

Displays installer version information.

/vsinit <0|1>

Initializes Visual Studio on every agent host for each ECloudInternalUser . You must use this option if you do not virtualize the toolchain. Each agent runs as user ECloudInternalUser1, ECloudInternalUser2, and so on.

The default is 0 (do not initialize).

/vsversions <version1> [, <version2> …​]

Installs the converter for a comma-separated list of Visual Studio versions. Available values are 2005, 2008, 2010, 2012, 2013, 2015, and 2017.