Introduction
IntroductionPre-installation requirementsInstallVerify Docker imagesUninstall
IntroductionPre-installation requirementsInstallVerify Docker imagesUninstall
IntroductionPre-installation requirementsInstallVerify Docker imagesUninstall
IntroductionPre-installation requirementsInstallVerify Docker imagesUninstall
IntroductionPre-installation requirementsInstallVerify Docker imagesUninstall
IntroductionPre-installation requirementsInstallVerify Docker imagesUninstall
IntroductionSystem requirementsVerify Docker imagesInstall operations centerInstall client controllersVerify build componentsVerify WAR files
IntroductionHA fundamentalsGet ready for HAInstall HA on modern cloud platformsInstall HA on traditional platformsHA considerationsHigh 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-3 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-3 compliant artifacts with caveatsJenkins core: Non-compliant classes and libraries
Introduction
IntroductionCommon Pipeline termsPipeline project typesCloudBees proprietary features for Pipelines
IntroductionPipeline development utilitiesDetermine plugin compatibilityPipeline best practices
IntroductionUse Declarative Pipeline syntaxUse Scripted Pipeline syntax
IntroductionPipeline prerequisitesCreate your first PipelineSelect an agent for your Pipeline jobCreate a Pipeline from SCMCreate a Pipeline in the UIUnderstand and implement Pipeline as Code
IntroductionConfigure advanced Scripted PipelineConfigure the build stageConfigure the deploy stageConfigure optional step argumentsConfigure the test stageCreate a JenkinsfileCustomize parametersHandle failuresString interpolationUse multiple agentsWork with the environmentReuse configuration files
IntroductionManage artifacts with CloudBees Fast Archiving pluginEnable artifact traceability with fingerprintingTrigger jobs with a simple webhookRestore filesVisualize the PipelineInsert checkpointsSecure PipelinesConfigure Pipelines with user-scoped credentialsEnforce standards with Pipeline PoliciesSpecify a matrix of one or more dimensionsConvert a Freestyle project to a Declarative PipelinePipeline builds and High Availability (active/active)
IntroductionRestart 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
IntroductionSet up a Pipeline Template CatalogDefine Pipeline Template CatalogsSet up a Pipeline TemplateParameter types in the template.yaml fileManage Multibranch Pipeline options in the template.yaml fileManage Pipeline Template Catalogs in bulkExample full Maven/Java app Jenkinsfile
IntroductionBranch SourceBitbucketGitHubGitBranch Property StrategyExamples
CloudBees Docker Build and Publish pluginCloudBees Docker TraceabilityDocker Pipeline pluginCloudBees Docker Hub/Registry Notification plugin
Introduction
Introduction
IntroductionGet startedNavigate the operations center interfaceProvision agents in a separate Kubernetes cluster from a managed controllerProvision a controller in a different OpenShift project than the operations centerManage controllersManage controllers in specific Kubernetes namespacesMigrate an existing managed controller to High Availability (HA)Manage agentsManage SSH credentialsShared agentsShared configurationsShared cloud configurationTrigger restrictionsChange NFS storage locationQuiet startMove/Copy/PromoteCluster operationsInbound agentsUse Kaniko with CloudBees CIUse Buildkit with CloudBees CIUsing self-signed certificates in CloudBees CI on KubernetesSidecar injector for self-signed certificates on OpenShiftAuto-scale nodes on EKSEnable auto-scaling nodes on GKECloudBees Amazon Web Services Deploy EngineCloudBees Amazon AWS CLI pluginCloud Foundry CLI PluginIntegrate OpenShift CLICloudBees CI ServiceNow integrationCreate projects based on a GitHub repository structureUse GitHub App authenticationCreate Multibranch Projects and Organization Folders with large repositoriesWikiText pluginController Lifecycle Notifications plugin
IntroductionGet startedNavigate the operations center interfaceManage client controllersMigrate from High Availability (active/passive) to High Availability (active/active) on CloudBees CI on traditional platformsManaging agentsManage SSH credentialsShared agentsShared configurationsShared cloud configurationTrigger restrictionsQuiet startMove/Copy/PromoteCluster operationsInbound agentsCloudBees CI ServiceNow integrationCreate projects based on a GitHub repository structureUse GitHub App authenticationCreate Multibranch Projects and Organization Folders with large repositoriesWikiText plugin
Introduction
Trust modelCentrally manage securityPod Security Admission
Use SSOIntegrate Microsoft Entra ID
Role-based access control (RBAC)Example RBAC configurationsRBAC auto-configurer pluginRestrict job triggersAccess controls on the operations centerAccess controls on controllersOperations center specific permissionsAuthentication mappingDelegate administrationFoldersFolders Plus
Restricted credentialsInjecting secretsEnhanced credentials maskingExternal secrets managementCyberArk credential providerManage secrets with HashiCorp Vault
Cross-controller triggersTest the SSH connection to an agentManage build agents with Nodes PlusExtended security settings
Beekeeper security warningsCloudBees administrative monitorsSecurity recommendationsData collection
Replace an expired certificateList of URLs that need accessBlock access to URL patternsServe resources from JenkinsVerify Helm charts with a signature
Introduction
Introduction$JENKINS_HOME directoryBest practices for backup and restoreBack up $JENKINS_HOME manuallyBackup a Role-Based Access Control configurationRestore backup files 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 cluster resources using VeleroRun backups using cluster operations
IntroductionConfigure multiple client controllers with the Jenkins CLI toolConfigure an alias for the Jenkins CLI toolConfigure 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 fundamentalsCasC requirementsCasC permissionsRecommended workflow
IntroductionExport a CasC configurationTransform an exported bundleAdvanced CasC bundle configurationValidate a CasC bundle
CloudBees CI CasC for operations centersGet started with Configuration as Code for the operations centerConfigure the operations center on modern platforms using CasCConfigure the operations center on traditional platforms using CasCRetrieve bundles using an SCMTroubleshoot CasC
CloudBees CI CasC for controllersGet started with Configuration as Code for controllersDistribute CasC bundles to controllers from your operations centerAdd controller CasC bundles to the operations centerConfigure bundle availability for controllersSet up a client controller using CasCSet up a managed controller using CasCSet up a managed controller using the CasC Controller Bundle ServiceAdvanced topicsTroubleshoot CasC for controllers
IntroductionUpdate a CasC bundleBundle update timingReview the CasC update log
IntroductionPlugin management with CasCDetermine plugin compatibility using CasCCreate an alternate plugin download site
Create items using CasC
Configure RBAC with CasC
CasC CLI commands
CasC HTTP API
Introductionbundle.yaml file referencejenkins.yaml file referenceplugins.yaml file referenceplugin-catalog.yaml file referenceitems.yaml file referencerbac.yaml file referencevariables.yaml file reference
HA on EKS Performance Test
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 that of shared configuration propagation.

Unlike shared clouds or shared agents, shared cloud configuration replicates the configuration of the cloud provider to the specified controllers, so 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 the Amazon EC2 plugin is supported for shared cloud configuration, after installing the Operations Center Server EC2 Cloud plugin on the operations center.

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, such as controllers, folders, and templates, using the New Item action in the operations center. Items can be created either at the root of the instance or within a folder.

  • If you create it 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 its sub-folders.

Step 1. Create a new configuration item

  1. Select 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. Select OK. 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 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 the controller connects to the 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 part of the 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 applies 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 locations if you have multiple controllers.

The following applies 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 option to set up different Regions for CloudBees CI instances in an 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

Test the configuration

  • If you select Test Connection in the configuration, the test will be launched on the 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 the Jenkins controllers when the configuration gets synchronized. This is highly recommended if your AWS EC2 Shared Cloud Configuration uses EC2 instance profile to obtain credentials.

Shared configurations
Trigger restrictions