Getting started

4 minute read
CloudBees will no longer be supporting CloudBees Jenkins Enterprise 1.x after July 30, 2020. This end-of-life announcement allows CloudBees to focus on driving new technology and product innovation for CloudBees CI. For information on moving to CloudBees CI, please refer to CloudBees Jenkins Enterprise 1.x to CloudBees CI on modern cloud platforms migration guide which has been created to help you with the migration process. Existing customers can also contact their CSM to help ensure a smooth transition.

CloudBees Jenkins Enterprise provides a number of enterprise-grade features and capabilities which help organizations scale continuous integration and delivery (CI/CD). This "Getting Started" section assumes that: CloudBees Jenkins Enterprise is up and running within the organization, the Administrator(s) have a functional CloudBees Jenkins Enterprise project configured, and have downloaded/installed the cje tool.

When new teams join an organization, or existing teams start a new project, CloudBees Jenkins Enterprise makes it easy to provision a fully managed and access controlled Jenkins master per team. In CloudBees Jenkins Enterprise, a Jenkins master is referred to as a Managed Master.

Administrators can provision Managed Masters, or they can allow team leads to provision their own Managed Masters "on-demand." The only limitation to the number of masters a CloudBees Jenkins Enterprise environment can handle is based on how much capacity the Administrator has added to the cluster.

By adding capacity, administrators can support more Managed Masters, Jenkins agents, or improve cluster performance and resiliency.

Provisioning Managed Masters

CloudBees Jenkins Enterprise allows administrators to standardize their organization’s Jenkins masters using Docker. Standardizing masters with containers makes it easy to ensure compliance with the organization’s security, audibility, and high availability requirements.

Out of the box, CloudBees Jenkins Enterprise includes some pre-made Docker master images that administrators can leverage to provision Managed Masters for their teams.

The full list of images can be found in the CloudBees Jenkins Enterprise global configuration under Manage Jenkins ⇒ Configure System. Navigate to the Mesos Master Provisioning section, and click on Show docker images…​ to review the available master images. The first entry in this list will be used as the default when creating a new master.

Manage Docker images for masters

Whether an administrator wants to pre-provision masters, or a project lead wants to provision masters on-demand, the process for provisioning Managed Masters resembles the process for creating a new job in Jenkins.

After logging into CloudBees Jenkins Enterprise, navigate to the operations center dashboard, click the New Item option in the left-hand menu, and provide the following information:

  • Item name: the name of the new master to be provisioned for a team

  • Select Managed Master.

After clicking OK, CloudBees Jenkins Enterprise will present the Managed Master’s configuration page, where administrators can further customize the provisioned master’s settings.

  • Hardware settings: number of CPUs and amount of memory to allocate for the Managed Master

  • Docker image: custom containerized master image, instead of the image specified by the administrator in the Global System Configuration

JVM Resources and Configuration

After finalizing any configuration changes, click "Save" to provision the master.

Managed Masters are most efficiently monitored and modified through the operations center dashboard. Communication between operations center and Managed Masters is established automatically.

To view the newly provisioned master, click Back to Dashboard to return to the operations center dashboard. While provisioning, the operations center dashboard will display the new master as a pending state - indicated by thunder cloud health icons until the Managed Master ready. When ready, the weather icon will change into a cloud icon to indicate the master is ready to use.

Master Ready

To start a Managed Master, use operations center to browse to that master on the network and select Start from the sidebar. If the selected master is already running, then the operations center sidebar displays a Stop option.

Once the master is provisioned, administrators should configure security and access controls for the master.

Adding Client Masters

CloudBees Jenkins Enterprise administrators may need to connect existing Jenkins masters to the CloudBees Jenkins Enterprise environment. While CloudBees Jenkins Enterprise supports this concept, called "Client Masters", the Client Masters lack some key benefits compared to Managed Masters, such as high availability.

Occasionally administrators will need to connect teams' existing masters to a CloudBees Jenkins Enterprise cluster, such as in the case of a team requiring a non-Linux operating system for their Jenkins master. Such existing masters cannot be fully managed by CloudBees Jenkins Enterprise and lack key benefits of Managed Masters like high availability. Whenever possible, administrators should encourage teams to instead upgrade to a Managed Master that is fully-managed by CloudBees Jenkins Enterprise.

Manually connected "Client Masters" can use the shared agents hosted in the cluster, offloading the burden of agent management from teams, and will still report their health to cluster administrators.

For more details on adding a "Client Master", refer to the CD as a Service section of this guide.

Adding capacity to a CloudBees Jenkins Enterprise cluster

In order to provide teams with faster build times and minimize the times builds spending waiting for resources, administrators can add capacity to their cluster by configuring more workers for their cluster.

For more details on adding workers, refer to the "Operating" section of this guide.