Introduction
IntroductionPre-installation requirementsInstallingVerifying Docker imagesUninstalling
IntroductionPre-installation requirementsInstallingVerifying Docker imagesUninstalling
IntroductionPre-installation requirementsInstallingVerifying Docker imagesUninstalling
IntroductionPre-installation requirementsInstallingVerifying Docker imagesUninstalling
IntroductionPre-installation requirementsInstallingVerifying Docker imagesUninstalling
IntroductionPre-installation requirementsInstallingVerifying Docker imagesUninstalling
IntroductionSystem requirementsVerifying Docker imagesInstalling operations centerInstalling client controllersVerifying build componentsVerifying WAR files
IntroductionHA (active/active) fundamentalsInstallation on modern cloud platforms (active/active)Installation on traditional platforms (active/active)HA (active/active) considerationsSpecific High Availability (active/passive) installation for CloudBees CI on traditional platforms
IntroductionWhat is FIPS and FIPS 140 compliance?Install CloudBees CI on modern cloud platforms in FIPS modeCAP plugin support in a FIPS 140-2 environmentConfigure the Apache™ Ant plugin for FIPS complianceConfigure the Pipeline Maven API plugin for FIPS complianceKnown FIPS incompatibilities with CloudBees CI on modern cloud platformsJenkins core: FIPS 140-2 compliant artifacts with caveatsJenkins core: Non-compliant classes and libraries
Introduction
IntroductionPipeline termsPipeline project typesCloudBees Pipeline benefits
IntroductionUsing Pipeline development utilitiesDetermining plugin compatibilityPipeline best practices
IntroductionPrerequisitesCreating your first PipelineSelecting agentsCreating Pipelines in SCMCreating Pipelines in Web UIUsing Pipeline as Code
IntroductionConfig Adv ScriptedConfig Build StageConfig Deploy StageConfig Optional Step ArgsConfig Test StageCreating JenkinsfileCustomizing ParametersHandling FailuresString InterpolationUsing Multiple AgentsWorking With The EnvReusing Configuration Files
IntroductionManaging artifactsTracing artifactsTriggering jobs with a simple webhookRestoring filesVisualizing PipelineInserting checkpointsSecuring PipelinesConfiguring Pipelines with user-scoped credentialsUsing Pipeline PoliciesSpecifying a matrix of one or more dimensionsConverting a Freestyle project to a Declarative PipelinePipeline builds and HA (active/active)
IntroductionRestarting aborted buildsLong-running buildsSkip next buildConsolidated Build View pluginCloudBees Quiet Start pluginCloudBees Template pluginCloudBees Workspace Caching
IntroductionTrigger a job with a notification event using Cross Team CollaborationEnable external notification events with external HTTP endpointsCluster-wide copy artifactsCluster-wide job triggers
IntroductionSetting up a Pipeline Template CatalogDefining Pipeline Template CatalogsSetting Up A Pipeline TemplateUsing parameters in template.yamlManaging multibranch Pipeline options in template.yamlManaging Pipeline Template Catalogs in bulkExample full Maven/Java app Jenkinsfile
IntroductionUsing Declarative Pipeline syntaxUsing Scripted Pipeline syntax
IntroductionBranch SourceBitbucketGitBranch Property StrategyExamples
CloudBees Docker Build and Publish pluginCloudBees Docker TraceabilityDocker Pipeline pluginCloudBees Docker Hub/Registry Notification plugin
Introduction
Introduction
IntroductionGetting startedNavigating the operations centerProvisioning managed controllers in multiple Kubernetes clustersProvisioning agents in a separate Kubernetes cluster from a managed controllerProvisioning a controller in a different namespace than the operations centerProvisioning a controller in a different OpenShift project than the operations centerManaging controllersManage controllers in specific Kubernetes namespacesMigrating an existing managed controller to High Availability (HA)Managing agentsShared agentsShared configurationShared cloud configurationTrigger restrictionsChanging NFS storage locationQuiet startMove/Copy/PromoteCluster operationsInbound agentsUsing KanikoUsing Buildkit (docker buildx)Sidecar injector for self-signed certificates on KubernetesSidecar injector for self-signed certificates on OpenShiftUsing auto-scaling nodes on EKSUsing auto-scaling nodes on GKECloudBees Amazon Web Services Deploy EngineAmazon Web Services CLI PluginCloud Foundry CLI PluginIntegrate OpenShift CLIServiceNow integrationCreating projects based on GitHub repository structureUsing GitHub App authenticationCreate Multibranch Projects and Organization Folders with large repositoriesWikiText pluginController Lifecycle Notifications Plugin
IntroductionGetting startedNavigating the operations centerManaging client controllersMigrating from High Availability (active/passive) to High Availability (active/active) on CloudBees CI on traditional platformsManaging agentsShared agentsShared configurationShared cloud configurationTrigger restrictionsQuiet startMove/Copy/PromoteCluster operationsJava web start agentsServiceNow integrationCreating projects based on GitHub repository structureUsing GitHub App authenticationCreate Multibranch Projects and Organization Folders with large repositoriesWikiText plugin
Introduction
Trust model
Pod Security Admission
Centrally managing security for controllers
Cyberark Credential Provider Plugin
HashiCorp Vault Plugin
Enabling advanced use cases: cross controller triggers and bulk operations
Restricting access and delegating administration with Role-Based Access Control
Creating secure folders with Role-Based Access Control Auto Configurer
Restricting job triggers
Setting up operations center access controls
Setting up access controls on connected controllers
Testing the SSH connection to an agent
Configuring restricted credentials with the CloudBees Restricted Credentials plugin
Folders
Folders Plus
Injecting secrets into builds
Managing build agents with Nodes Plus plugin
Extended security settings
Enhanced credentials masking
Understanding Beekeeper security warnings
Preventing unauthorized interaction between builds
Security recommendations
Using single sign-on (SSO)
CloudBees CI integration with Microsoft Entra ID
operations center specific permissions
Authentication mapping
Example configurations
Delegating administration
Data collection for the CloudBees Analytics Plugin
External secrets management
Replacing an expired certificate
List of URLs that need access
Blocking access to URL patterns using the CloudBees Request Filter Plugin
Serving resources from Jenkins
Verifying Helm Charts Published with a Signature
Introduction
Introduction$JENKINS_HOME directoryBest practices for backup and restoreBack up $JENKINS_HOME manuallyRestore $JENKINS_HOME manuallyRestore credentialsConfigure backups using the CloudBees Backup pluginSchedule backups in the CloudBees Backup pluginRestore backups created with the CloudBees Backup pluginBackup and restore on KubernetesBackup and restore on AWSBackup and restore Kubernetes clusters using VeleroRun backups using cluster operations
IntroductionConfiguring multiple client controllers with the Jenkins CLI toolConfigure an alias for the Jenkins CLI toolConfiguring Jenkins CLI tool with non-TrustStore TLS certificates
CloudBees Inactive Items Plugin
Jenkins Health Advisor by CloudBees
CloudBees Pull Request Builder for GitHub plugin
Count and monitor user licenses with the CloudBees User Activity Monitoring plugin
CloudBees CI Catalog Plugin - Catalog tool
Introduction
CasC fundamentals
CasC requirements
CasC permissions
IntroductionGetting startedCreating a bundleConfiguring the operations center on modern platformsConfiguring the operations center on traditional platformsRetrieving bundles using SCMUpdating a bundleBundle update timing for the operations centerViewing the operations center update logCreating itemsConfiguring RBACDetermining plugin compatibilityTroubleshooting
IntroductionGetting startedCreating a bundleAdding controller bundles to the operations centerUpdating a bundleBundle update timing for controllersViewing the controller update logConfiguring bundle availabilitySetting up a managed controllerSetting up a client controllerCreating itemsConfiguring RBACDetermining plugin compatibilityAdvanced topicsTroubleshooting
Plugin management with CasC
CasC CLI commands
CasC HTTP API
Support policies

Shared cloud configuration

3 minute read

The operations center enables the sharing of cloud configuration across the controllers in the operations center cluster.

The sharing model used for shared cloud configuration is similar to the shared configuration propagation.

Unlike shared clouds or shared agents, shared cloud configuration replicates the configuration of the cloud provider to the specified controllers such that each controller has separate control of the cloud rather than leasing agents from the operations center server.

Shared cloud configuration can also be accomplished via Configuration as Code (CasC).

Supported cloud providers

Amazon Elastic Compute Cloud (EC2) from Amazon EC2 Plugin is supported for shared cloud configuration.

The shared cloud configuration is licensed individually for each cloud type.

Limitations

  1. The plugin defining the configuration must be installed on the controllers to which the configuration will be propagated.

  2. The plugin versions on the controller(s) and the operations center server must be compatible in terms of configuration data model.

Violations of the requirements above may have a serious impact on cloud provisioners on controllers.

Shared configuration setup

Shared configurations should be created as Jenkins items like controllers, folders and templates using the New Item action on the left hand menu in operations center. Items can be created at the root of the instance or within a folder.

  • If you create in the root of operations center, the cloud will be available to all controllers

  • If you create a shared cloud configuration item in a folder, the cloud will be available only to controllers within the folder or within the folder’s sub-folders.

Step 1. Create a new configuration item

  1. Click on the "New Item" action in Jenkins root or a folder. In both cases you will be presented with the standard new item screen.

  2. Provide a configuration name.

  3. Select the Cloud Configuration type that you wish to create.

  4. Click on OK button. A new configuration window will appear.

Step 2. Enter the required configuration for the selected cloud

Options are similar to the standard Jenkins cloud configuration options.

If a cloud provider requires configuration of native tools or libraries, then this location must be the same on all controllers that receive this configuration in order to operate correctly.

Step 3. Apply changes

When the shared cloud configuration is complete, save or apply the configuration.

The cloud configuration will be pushed to all online controllers that have not opted out of receiving the shared configuration. If a controller is offline, the new configuration will be applied when this controller connects to operations center.

Supported configurations

Below you can find configuration examples for the supported clouds.

As mentioned earlier, prior to configuring a shared-cloud ensure that the plugin defining the launcher is installed on all the controllers within scope for using the shared cloud.

Amazon Elastic Compute Cloud (EC2)

This Shared cloud configuration allows you to share settings for Amazon EC2 cloud, which is the part of Amazon Web Services platform (AWS).

Please refer to the Amazon EC2 plugin Wiki page to find setup guidelines and information about supported configurations. This section describes the operations center specifics only.

The following apply to both CloudBees CI on modern cloud platforms and CloudBees CI on traditional platforms:

  • Instance caps are being managed individually for each controller, there is no global limitation for the entire operations center cluster.

  • If you use Access Key ID and Secret Access Key to define EC2 credentials, these credentials will be shared across all CloudBees CI instances. EC2 must allow multiple logins from different places if you have multiple controllers.

The following apply to CloudBees CI on traditional platforms only:

  • If all target CloudBees CI instances are running on EC2 instances, you can use EC2 instance profile to obtain credentials from the instance’s metadata.

  • Currently, there is no opportunity to set up different Regions for CloudBees CI instances in AWS EC2 Shared Cloud Configuration. In such cases, use individual setups of EC2 Cloud on each controller.

    ec2 top configuration
    Figure 1. AWS EC2 shared cloud configuration setup

Testing the configuration

  • If you click on the Test Connection button in the configuration, the test will be launched on operations center. Make sure that the AWS EC2 cloud is available to operations center.

  • If the instance is configured to obtain credentials from EC2 instance profile, operations center must be running on a properly configured Amazon Machine Image

  • You can also test the connection from one of Jenkins controllers when the configuration gets synchronized. It’s highly recommended if your AWS EC2 Shared Cloud Configuration uses EC2 instance profile to obtain credentials

Shared configuration
Trigger restrictions