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

The Home page

3 minute read

The Home page provides a news feed, links to documentation and other assistance, instruction for novice users, and real-time charts for agent usage and build durations during the past 24 hours.

Banner pulldown menus

The banner contains two pulldown menus, which are located in the top right of the banner.

Current user pulldown menu

This menu provides a link to the current user’s profile page and a Logout link.

current user menu

User assistance pulldown menu

This menu provides several links for more information about the Cluster Manager.

user assistance menu

  • Help —Opens page-specific (context-sensitive) HTML help throughout the web UI.

    The help is loaded from the CloudBees Build Acceleration documentation web page. The web UI also provides overview and concept help topics that are not context-sensitive (meaning that they are not linked to a specific page in the web UI). The left pane (table of contents) of any help page that appears will contain the list of help topics.

  • About —Displays information about the Cluster Manager server (such as the product version) and information about the Cluster Manager license (such as the expiration date and the grace period for renewal).

  • Release Notes —Opens a welcome screen containing new release announcements and links about the related release notes and downloads page.

  • Online Resources And Lessons —Provides a quick start guide and instructional videos for beginners as well as resources for documentation and other forms of assistance (such as the Knowledge Base and the “Ask” user forum).

The banner also provides the following key statistics about the cluster:

  • Agents —Number of agents that are currently running in the cluster.

  • Running builds —Number of builds that are running currently in the cluster.

  • CPU Hours Used —Total hours of CPU time used by all builds on all agent machines in the cluster since it was established.

  • Developer Hours Saved —Total hours of build time saved versus builds without build acceleration since the cluster was established.

  • License —Number of days remaining in the Cluster Manager license.

Tabs

The Home page and all other pages in the Cluster Manager web UI provide tab-based access to administration functions as well as information about builds, agents, reports, agent cloud bursting, and messages.

  • Home — Opens the Home page.

  • Builds —Opens the Builds page, which displays running and completed builds, additional build information, and whether completed builds succeeded or failed. For details, see Builds.

  • Agents —Opens the Agents page, which lets you view details about each agent in the cluster, such as the agent host machine, agent software version, and agent status (such as whether it is running, has a problem, or if it failed). For details, see Agents.

  • Reports —Opens the Reports page, which provides many types of analytics about your build cluster and uses several types of data visualization, such as scatter plots and pie charts. For details, see Reports.

  • Messages —Opens the Messages page, which displays messages from the Cluster Manager, agents, and eMake. For details, see Messages.

  • Cloud —Opens the Cloud page, which stores cloud platform credentials, cloud burst resource status, and messages related to cloud platforms. For details, see Cloud.

  • Administration —Opens the User Settings page, which lets you view and edit the details about the current logged-in user (such as full name, email address, and assigned groups). For details, see User Settings.

Online resources

This section provides online resources for documentation and other forms of assistance such as the CloudBees Build Acceleration Knowledge Base.

Lightning lessons

This section provides a quick start guide and instructional videos for beginning users.

Agent usage (last 24 hours) report

This report is a stacked area chart that shows the agent license count and agents available versus agent demand in a specified time period. For details, see Agent Usage Report.

Build duration report

This report is a scatter plot that shows the durations of builds over a specified time period. For details, see Build Duration Report.

Introduction
Builds