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

Installing Insight

2 minute read

This section details how to install CloudBees Build Acceleration Insight. Because Insight analyzes build annotation files, CloudBees recommends to install it on the system where you run Electric Make or on a Cluster Manager host where you can upload build annotation files.

For a list of supported platforms, see CloudBees Build Acceleration supported platforms.

Linux installation

Using information from the table below, follow one of these methods:

Installer filename

32-bit: CloudBeesBuildAccelerationInsight-<version>-Linux-x86-Install

64-bit: CloudBeesBuildAccelerationInsight-<version>-Linux-x86_64-Install

Default installation folder

32-bit: /opt/ecloud/i686_Linux/bin 64-bit: /opt/ecloud/i686_Linux/64/bin

Executable

einsight

annolib library

annolib.dll

Default log file

/usr/tmp/einsight_install.log

Insight requires the following libraries:

libX11.so.6 libXss.so.1 libXext.so.6 libXft.so.2 libfreetype.so.6 libfontconfig.so.1 libXrender.so.1 libxcb.so.1 libexpat.so.1 libXau.so.6
▼

macOS installation

To install Insight:

  1. Download the dmg image, CloudbeesBuildAccelerationInsight.dmg.

  2. Double click the image icon for the dmg file to mount it.

  3. From Finder, double click the mounted dmg to open it.

  4. Drag and drop einsight.app to the Applications folder.

  5. Unmount CloudbeesBuildAccelerationInsight.dmg.

Executable

einsight.app

annolib library

Integrated into the executable.

Default installation folder Applications folder

Installer filename

CloudbeesBuildAccelerationInsight.dmg

Default log file

Windows installation

Using information from the table below, follow one of these methods:

Installer filename

CloudBeesBuildAccelerationInsight-<version>-Windows-Install.exe

Default installation folder

32-bit: C:\ECloud\i686_win32\bin

64-bit: C:\ECloud\i686_win32\64\bin

Executable

einsight.exe

A shortcut pointing to the proper executable is created on your desktop.

annolib library

annolib.so

Default log file

C:\Users\<username>\AppData\Local\Temp\einsight_install.log.

Installation methods

GUI installation

You must run the installer as administrator (on Windows) or root (on Linux).

  1. Run the installer file to begin installation.

  2. Click Next on the Welcome screen.

  3. Accept the default installation location or click Browse to choose a different location, and then click Next.

  4. Review your settings and click Next to continue or Back to make changes.

  5. Click Finish to close the installer.

Custom console installation

Specify just the options you need to run an installation with custom settings and minimal interaction.

<installer filename> [options]
▼

The following options are available.

Option Description

/help

Displays help information.

/mode <mode>

Sets the installation mode. The following modes are available.

  • console: (Linux only) Runs the installation in the console.

  • standard: Runs the standard installation mode, including all user prompts.

  • silent: Runs the installation without user prompts.

  • default: Runs the installation while accepting all installation defaults, resulting in fewer user prompts.

/prefix

Sets the installation directory. Type the full path. For example:

C:\ecloud2 (Windows)

/opt/ecloud2 (Linux)

/temp

Sets the temporary directory used by the installer.

/version

Displays installer version information.

For example, to specify a non-default installation directory, enter

CloudBeesBuildAccelerationInsight-<version>-Windows-Install.exe \
    /mode silent /prefix C:\ecloud2
▼

Default console installation

To install Insight on Linux using the console with no installation options:

  1. Run the installer file.

  2. Press Enter to start the installation.

  3. Press Enter to accept the default installation location or enter a different location.

Checking for software updates

Insight is updated periodically to improve its functionality or to fix bugs. To see if an update is available, click Help > Check for updates….

If you want to make these checks automatic, check the Check for updates automatically checkbox and click OK.

Introduction
Annotation