Connecting a client controller to operations center

Connecting a client controller to operations center is a process that includes the following steps (Watch the ):

Setting up your new operations center
Creating a Folder item to organize your client controllers
Creating a new client controller object
Setting up your new client controller

Prerequisites

The following instructions assume you have completed the steps for Installing the operations center and Installing the client controller, and have an operations center and client controller instance accessible via a web browser at the following URLs:

Operations center: http://<server-name>:8888
Client controller: http://<server-name>:8080

Prior to beginning the following instructions, the operations center and client controller should be waiting to be unlocked with an initial admin password.

Setting up your new operations center

To set up your new operations center:

Navigate to your new operations center.

For example, http://<operations center name>:8888
Copy the file location of the initial admin password on the Getting Started window.
Enter the following command in your terminal:

sudo cat + the file location you copied from step 2
Copy the password value outputted from your terminal command.
Paste the password value into the Administrator password box in the Getting Started window.
Select Continue.

Select Use a license key.

If you have not yet purchased a CloudBees license, copy the Jenkins Instance ID and send it in an email to csm-help@cloudbees.com requesting a trial. Afterwards, a CloudBees Customer Success Manager (CSM) will create a license key and certificate for you to apply. The expected return is within 24 hours.

Copy and paste the operations center License Key and Certificate into the respective boxes in the Enter your license key window.

You must include the -----BEGIN RSA PRIVATE KEY----- and -----END RSA PRIVATE KEY----- sections.

You must include the -----BEGIN CERTIFICATE----- and -----END CERTIFICATE----- sections.
Check the box next to I accept the evaluation or standard license.
Select Submit.
Select Install suggested plugins.

You must install the suggested plugins. Do NOT choose Select plugins to install.
Enter details for Create First Admin User.
Select Save and Continue.
Examine the Instance Configuration and if it looks right, select Save and Finish.
Select Start using CloudBees CI Operations Center.
Restart the CloudBees CI client controller. Example URL: http://<Operations Center name>:8888/restart
Select Yes.
Sign in using the Admin Credentials you entered.

Creating a Folder item to organize your client controllers

It is considered a best practice to organize your client controllers in a Folder item because it helps align your controllers with teams or organizations and it can keep the operations center screen from becoming too crowded, requiring a lot of unnecessary scrolling.

To create a Folder item to hold your client controller objects:

Select New Item.
Select Folder and name the folder.

This folder will be used to organize all of the client controller objects connected to your operations center.
Select OK.
Select the Restrict the kind of children in this folder checkbox under Properties.
Select the Client controller checkbox.
Select Save.

Creating a Folder to hold your client controller objects is not a requirement, but CloudBees highly recommends it as a best practice.

Creating a new client controller object

To create a client controller:

From the Folder you created to hold your client controller objects, select New Client controller.
Enter a name for your client controller.
Select Client controller.
Select OK.
Select Save.

Setting up your new client controller

To set up your new client controller:

Navigate to your new client controller in a new tab or window. For example, http://<server-name>.local:8080/
Copy the file location of the initial admin password on the Getting Started window.
Open a terminal and enter the following command:

sudo cat + the file location you copied from step 2.
Copy the password value outputted from your terminal command.
Paste the password value into the Administrator password box in the Getting Started window.
Select Continue.
Select Join a CloudBees Jenkins operations center controller.
Navigate to your CloudBees CI operations center dashboard and select the client controller you recently created and want to connect.
Copy the Connection Details.

You must include the ----- BEGIN CONNECTION DETAILS ----- and ----- END CONNECTION DETAILS ----- sections.
Paste the Connection Details into the Connection details box in the Joining a CloudBees Jenkins operations center is easy window.
Select Submit.
Select Install suggested plugins.

You must install the suggested plugins. Do NOT choose Select plugins to install.
Enter details for Create First Admin User.
Select Save and Continue.
Select Start using CloudBees CI client controller.
Restart the CloudBees CI client controller. Example URL: http://<server-name>.local:8080/restart
Select Yes.
Sign in using the Admin credentials you entered.

To verify, return to the browser tab or window of your operations center. You should see your new controller under the folder name that was previously created. If you select the name of the client controller, you should be redirected to the console of that client controller. From one console you can now navigate between your operations center and client controller.