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

Create or edit cloud credentials

3 minute read

To create or edit cloud credentials:

  1. If you are editing a cloud credential, make sure that no resources are using it.

    If it is already in use, the following error appears:

    The cloud credential <credential> is in use by <resource>. Editing or deleting it is not allowed

    In this case, you must create a new cloud credential, modify the resource to use the new cloud credential (see Resources - Create or Edit a Resource), and then delete the original one (as described in Cloud Credentials).

  2. Supply (for new credentials) or review and edit (for existing credentials) the following:

    Field or Menu Description

    Name

    User-defined name for this credential.

    Description

    User-defined description.

    Type

    One of the following cloud provider cluster types.

    Kubernetes, as supplied with your Kubernetes account:

    • Kubernetes API Endpoint —Endpoint at which the Kubernetes API is reachable. This must be an IP address or a resolvable DNS name in the form: https://<ip_address>:<port_number>.

    • User Name —(Optional) AccountService user who owns the bearer token.

    • Kubernetes Bearer token — Service account bearer token for a service account that has permissions to create resources in the Kubernetes cluster.

    Azure, available from your Azure portal:

    • Azure API ClientID —Azure Application ID as configured from the Azure App registration page. UUID formatted string.

    • Azure API ClientSecret —Azure Client secret as configured from the Azure App registration page. UUID formatted string.

    • Azure API TenantID —Directory ID from the Azure Active Directory, Default Directory Properties page. UUID formatted string.

    • Azure API SubscriptionID —Visual Studio Professional Subscription ID from the Subscriptions page. UUID formatted string.

    EC2, as supplied with your EC2 account:

    • Credential Provider —Choose Access Key ID/Secret Key or Server IAM Role

      If you select Server IAM Role, you can also select No Key Pair from the Key Pair pulldown menu. But this is not recommended, because you cannot SSH to the instance.
      You must set up the appropriate permissions for the IAM role. For the list of required permissions, see Configuring Amazon EC2 for Agent Cloud Bursting - Setting Up a Server IAM Role.

    • Region —Named set of AWS resources in the same geographical area. A region comprises at least two Availability Zones.

    • (If you selected Access Key ID/Secret Key) AWS Access Key ID —Access key ID, which is the unique identifier that is associated with a secret access key. The access key ID and the secret access key are used together to sign programmatic AWS requests cryptographically.

    • (If you selected Access Key ID/Secret Key) AWS Secret Key —Secret access key, which is used in conjunction with the access key ID to cryptographically sign programmatic AWS requests. Signing a request identifies the sender and prevents request alteration. You can generate secret access keys for your AWS account, individual IAM users, and temporary sessions.

    Google Cloud Platform, as supplied with your GCP account:

    • Service Account File —JSON file generated when the private key is created for the service account in the Google Cloud Platform Console. The service account identified by the key pair in the JSON is used. The service account must have Owner permission allocated.

  3. Click Test Connection to verify the new or updated credential.

    If the test succeeds, the following message appears:

Your credentials successfully connected to AWS.

If the test fails, the following message appears.

Unable to connect to endpoint with specified credentials. Please try again. . For a failed test, modify the credentials to fix the issues, and then click Test Connection again. . Click OK to return to the Cloud page.

View cloud credentials
Cloud messages