Introduction
Quick start
Terms and concepts
Introduction
Linux platform prerequisites
Windows platform prerequisites
Supported third-party build tools
Hardware requirements
Port usage
Non-virtualized toolchain
Cygwin
Component compatibility matrix
Ensuring a consistent build environment
Checksum utility
Introduction
Understanding component interactions
When to use the CloudBees Build Acceleration cluster
Before you install
Installing CloudBees Build Acceleration on Linux
IntroductionAdditional Linux installation informationInstalling the Cluster Manager on LinuxInstalling Electric Agent/EFS on LinuxInstalling Electric Make on LinuxPath settings
Installing CloudBees Build Acceleration on Windows
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
Configuring CloudBees Build Acceleration on Windows
IntroductionWindows notesRegistry information
Using the accelerator.properties file
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
Configuring CloudBees Build Acceleration for agent cloud bursting
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
Using CloudBees Build Acceleration tools
IntroductionBreakpointsCluster Manager administration toolsecconfigecagent toolsecinstconfeclockrunagent.local file
System maintenance tasks
IntroductionCleaning up dataDeleting from the builds listManaging the message logSecuring the Cluster Manager databaseConfiguring the databaseBacking up a databaseEnabling LDAPImporting a licenseUsing comments
Working with builds and build classes
IntroductionStopping buildsDeleting buildsCreating build classesEditing Build ClassesDeleting build classes
Working with agents
IntroductionSetting the agent allocation policyUnderstanding a cluster sharing policyModifying the number of agents per hostEnabling agentsDisabling agentsTesting agentsDeleting agents
Working with resources
IntroductionCreating resourcesEditing resourcesDeleting resources
Working with filters
IntroductionCreating filtersEditing filtersDeleting filters
Working with reports
IntroductionGenerating reportsAdding custom reports
Web interface help
IntroductionThe home pageBuildsBuild detailsBuild classesBuild class detailsBuild classes - create or edit a build classAgentsAgent detailsAgent policiesResourcesResource 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 settingsDatabase configurationLicensesImport license
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
Make compatibility
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
Performance optimization
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
Dependency management
IntroductionCloudBees Build Acceleration eDependCloudBees Build Acceleration ledger fileManaging the history data fileConflicts and conflict detection
Annotation
Third-party integrations
IntroductionClearCaseCoverityCygwin (Windows only)EclipseBitBake
Electrify
Troubleshooting
IntroductionAgent issuesElectric Make debug log levelsUsing the annotation file to troubleshoot builds
Introduction
Installing Insight
Annotation
Starting Insight
Using Insight with BitBake builds
Navigating the interface
IntroductionAgents and jobsNavigationIntroductionLegendJob summaryZoomReplayMonitor live build
Build, job, and Make information
IntroductionBuild propertiesJob details dialogMake details dialogSearching for jobsViewing all jobsUsing the hyperlog
Insight Reports
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
Introduction
What’s new
Known issues
System requirements
Installing the Visual Studio IDE integration
Using the IDE extension interface
IntroductionMain menu and toolbarSolution settingsHelp menu
Using the ecdevenv.exe utility
Building Visual Studio solutions from the command line
Setting Visual Studio converter environment variables
Tuning performance
Using MSBuild
Using Visual Studio 6
Uninstalling the Visual Studio integration
Debugging a failed build
Troubleshooting problems
Introduction
Upgrading on Linux
Upgrading on Windows
Upgrading on cluster hosts
Introduction
Logging in
Using cmtool
Using runAgentCmd
Global arguments
Support policies
Supported platforms

CloudBees Build Acceleration help menu

1 minute read

You use this menu to access links to the CloudBees "Ask" website and the CloudBees Build Acceleration documentation.

Help popup

This popup shows the help resources:

Go to the "Ask" website at https://ask.cloudbees.com/, a member-moderated community forum where you can:

  • Ask and answer questions as well as comment on (and vote for) the questions of others and their answers

  • Get help with installation and configuration

  • Submit feedback

Go to ElectricAccelerator to find documentation for all CloudBees Build Acceleration products.

"About" popup

This popup shows version information about the currently installed IDE add-in or package, the eMake version and the Insight version. Refer to these versions where contacting support or asking questions on the community forum.

Solution settings