Introduction
Understanding component interactions
When to use the CloudBees Build Acceleration cluster
Before you install
IntroductionAdditional Linux installation informationInstalling the Cluster Manager on LinuxInstalling Electric Agent/EFS on LinuxInstalling Electric Make on LinuxPath settings
IntroductionAdditional Windows installation informationInstalling the Cluster Manager on WindowsInstalling Electric Agent/EFS on WindowsInstalling Electric Make on Windows
Installing CloudBees Build Acceleration silently
Additional installation options
Installing JDBC drivers for MySQL or Oracle databases
Migrating an eMake-only installation
Installing the backward-compatible eMake package
Uninstalling CloudBees Build Acceleration from Linux
Uninstalling CloudBees Build Acceleration from Windows
Uninstalling CloudBees Build Acceleration silently
Introduction
Configuring CloudBees Build Acceleration on Linux
IntroductionWindows notesRegistry information
IntroductionChanging log locationsDisabling agents by defaultSetting up user authenticationSetting up email notificationAdding custom protocol mismatch error textUsing the database connection monitor
Configuring agent log rotation
Changing the disk cache directory or agent temporary storage location
Default directories
Logging in and enabling licensing
Installing an Apache server certificate
Stopping, starting, or restarting the Cluster Manager service
Configuring CloudBees Build Acceleration to run in Docker containers
IntroductionConfiguring your cloud platform for agent cloud burstingChoosing a machine to run eMakeConfiguring agent cloud bursting resourcesChecking the agent cloud bursting setup
Enabling automatic scaling of the number of agents
Configuring eMake and agents for multiple interface communications
Introduction
IntroductionBreakpointsCluster Manager administration toolsecconfigecagent toolsecinstconfeclockrunagent.local file
IntroductionCleaning up dataDeleting from the builds listManaging the message logSecuring the Cluster Manager databaseConfiguring the databaseBacking up a databaseEnabling LDAPImporting a licenseUsing comments
IntroductionStopping buildsDeleting buildsCreating build classesEditing Build ClassesDeleting build classes
IntroductionSetting the agent allocation policyUnderstanding a cluster sharing policyModifying the number of agents per hostEnabling agentsDisabling agentsTesting agentsDeleting agents
IntroductionCreating resourcesEditing resourcesDeleting resources
IntroductionCreating filtersEditing filtersDeleting filters
IntroductionGenerating reportsAdding custom reports
IntroductionThe home pageBuildsBuild detailsBuild classesBuild class detailsBuild classes - create or edit a build classAgentsAgent detailsResourcesResource detailsResources - create or edit a resourceReportsServer loadRealtime server metricsMessagesMessage policiesCloudCloud credentialsView cloud credentialsCreate or edit cloud credentialsCloud messagesAdministrationFiltersFilters - create or edit a filterPermissionsEdit User PermissionsEnable UserEdit group permissionsEnable groupUsersUsers - create or edit a local userUser passwordGroupsGroups - create or edit a local groupAdd new user to groupUser settings - view or edit user settingsServer settingsLicenses
Error code information
Introduction
Understanding component interactions
Virtualization
Understanding build parts
Setting up CloudBees Build Acceleration
Invoking Electric Make
Setting the Electric Make root directory
Configuring tools
Tools that access or modify the system registry
Configuring environment variables
Setting the Cluster Manager host and port
Setting Electric Make emulation
Electric Make command-line options, environment variables, and configuration file
CloudBees Build Acceleration sample build
Simulating builds
Using build classes
Using priority pools
Using the proxy command
Configuring TLS between eMake and agents
Building multiple targets simultaneously
Using Electric Make variables
Using the ninja build system
Specifying pragmas in an addendum file
Terminating a build
Shutting down cluster hosts during builds
IntroductionUnsupported GNU Make options and featuresUnsupported NMAKE optionsCommands that read from the consoleTransactional command outputStubbed submake outputHidden targetsWildcard sort orderDelayed existence checksMultiple remakes (GNU Make only)NMAKE inline file locations (Windows only)How eMake processes MAKEFLAGS
IntroductionOptimizing Android build performanceDependency optimizationJob cachingJob caching for katiParse avoidanceJavadoc cachingSchedule optimizationRunning a local job on the Make machineSerializing all Make instance jobsManaging temporary files
IntroductionCloudBees Build Acceleration eDependCloudBees Build Acceleration ledger fileManaging the history data fileConflicts and conflict detection
Annotation
IntroductionClearCaseCoverityCygwin (Windows only)EclipseBitBake
Electrify
IntroductionAgent issuesElectric Make debug log levelsUsing the annotation file to troubleshoot builds
Introduction
Installing Insight
Annotation
Starting Insight
Using Insight with BitBake builds
IntroductionAgents and jobsNavigationIntroductionLegendJob summaryZoomReplayMonitor live build
IntroductionBuild propertiesJob details dialogMake details dialogSearching for jobsViewing all jobsUsing the hyperlog
IntroductionGenerating reportsAnnotation differences reportBuild manifest reportBuild metrics reportBuild summary reportCluster sharing reportDerived files analysis reportElectricSimulator reportExport timeline reportFiles modified multiple times reportJob stats reportJob time by type reportJobs by agent reportJobs by file reportLongest jobs reportLongest serial chain reportMakefile manifest reportMetric differences reportMost read files reportRoot conflicts reportSerialization analysis reportSubmake stub reportTerminator lag reportWhy rebuild reportCommand-line enabled reportsCreating custom reports
Understanding build performance
Annolib programmer’s reference

What’s new

2 minute read

New features and functionality in version 5.4.0

Visual Studio IDE Extension

  • The automatic search and addition of Electrify roots is enhanced. This feature now automatically scans your project files and determines all inputs and outputs for that project and adds them to the eMake roots. These settings are saved as part of the project settings for subsequent builds. (VSP-1214 and VSP-1195)

  • A progress bar for eMake root generation is added as part of this enhancement. This progress bar appears when you select a command to invoke a build. For details, see Electrify Roots Progress Bar.

  • Support for Visual Studio 2019 is introduced for builds invoked using the Visual Studio IDE extension. (Command-line builds, which use ecdevenv and the Visual Studio Converter Extension, do not support Visual Studio 2019.) (VSP-1185)

Visual Studio Converter Extension

  • No changes.

ecdevenv Utility

  • No changes.

ecmsbuild Utility New!

Installer

  • The installer now turns off the Visual Studio Customer Experience Improvement Program (VSCEIP). For Visual Studio 2012 and later, it is turned off on a global, machine-wide basis. For Visual Studio 2005 and 2008, it is turned off for the current user only. (VSP-1216)

Other new features and functionality

  • The performance of incremental builds is improved. (EC-13637)

Resolved Issues in Version 5.4.0

Visual Studio IDE Extension

  • An issue where memory-resident programs related to Electrify and the Visual Studio Extension were sometimes not detoured upon exit is fixed. Electrify now kills the following processes so that manual termination as a workaround is not needed. (VSP-1220)

  • msbuild.exe

  • mspdbsrv.exe

  • electrify.exe

  • electrifymon.exe

  • electrify_proxy.exe

  • csc.exe

  • link.exe

  • cl.exe

Visual Studio Converter Extension

  • No changes.

ecdevenv utility

  • An issue where ecdevenv could not find the eMake executable because of an incorrect eMake registry entry is fixed. (VSP-1209)

VSPackage

  • The Tools > Extensions and Updates > <CloudBees_VSPackage_name> > More Information target URLs are changed from the electric-cloud.com home page to the cloudbees.com home page. Also, the Getting Started target URL is changed from docs.electric-cloud.com to point to the CloudBees Build Acceleration documentation directly. (VSP-1146)

Introduction
Known issues