Installing CloudBees Analytics to an existing CloudBees CI on modern cloud platforms environment

3 minute read

Installations of CloudBees CI on modern cloud platforms can take advantage of the analytics capabilities of CloudBees Software Delivery Automation.

CloudBees provides a Helm chart to install the components required to enable end-to-end data flow from CloudBees CI to the analytics dashboards in CloudBees Software Delivery Automation.

The Helm chart:

  • Includes the CloudBees CI on modern cloud platforms and CloudBees CD Helm charts.

  • Preconfigures the URL for the server to which analytics events will be sent.

  • Installs the components needed for analytics: the CloudBees Analytics server, the webserver, the bound agent, and a MariaDB.

  • Automatically creates the Ingresses required to access CloudBees CI and CloudBees Software Delivery Automation analytics.

Important information

Before you install CloudBees Software Delivery Automation analytics, review the following important information:

  • The Helm chart installs the CloudBees CI Operations Center and the CloudBees Analytics components on the same Kubernetes cluster and in the same namespace.

  • Three new required plugins are installed: CloudBees Unified Data Plugin, CloudBees Unified UI Plugin, and CloudBees Platform Common Plugin.

  • CloudBees CD plugins are not installed.

  • The CloudBees CD artifact repository is not installed.

  • The required plugins for CloudBees Analytics are in the CloudBees Assurance Program. The plugins are installed when managed controllers or team controllers are provisioned.

  • The CloudBees Unified Data Plugin is installed only on controllers. The CloudBees Unified UI Plugin and the CloudBees Platform Common Plugin are installed on both controllers and the Operations Center. There is no need to configure the CloudBees Platform Common Plugin on a controller. The plugin’s configuration in the Operations Center is automatically propagated to all connected controllers.

  • After installation, the credential needed to enable communication from CloudBees CI to CloudBees Analytics is configured automatically.

  • The Helm chart is located in the same repository as the CloudBees CI Helm chart: https://charts.cloudbees.com/public/cloudbees

  • CloudBees recommends backing up your instance before performing these procedures.

Adding CloudBees Analytics

Before you proceed with this procedure, ensure you are using CloudBees CI version 2.263.4.2 or later.

To add CloudBees Analytics:

  1. Add CloudBees Software Delivery Automation to your CloudBees CI installation:

    In your existing versioned value-overrides.yaml file, do the following:

    • Move the existing values under a ci: subsection.

    • Create a cd: subsection, and then duplicate the ci.OperationsCenter.HostName to cd.ingress.host and duplicate the ci.OperationsCenter.Ingress.tls.SecretName to cd.ingress.certificate.existingSecret.

  2. Upgrade your installation:

    helm upgrade -f /path/to/edited/value-overrides.yaml your-release-name cloudbees/cloudbees-sda

The Operations Center is restarted, but managed controllers are not restarted.

Verifying the installation

  1. Type the following command:

    kubectl get po
  2. Verify that items with the following prefixes appear:

    • cjoc

    • flow-bound-agent

    • flow-devopsinsight

    • flow-server

    • flow-web

    • mariadb

    • managed controller names

Verifying the connection to CloudBees Software Delivery Automation

  1. From your CloudBees CI Operations Center, go to Manage Jenkins Configure System, and then scroll down to Connection to CloudBees Software Delivery Automation.

  2. In URL of the CloudBees Software Delivery Automation server, verify that the URL for the CloudBees Software Delivery Automation server has been configured. For example, `https://your.hostname/`. This should be the same as the CloudBees CI Operations Center URL minus the cjoc/ suffix.

  3. Check that Connected successfully is displayed.

Do not change the Allow analytics events to be sent and Send analytics events to this URL fields. These fields are populated automatically to enable analytics events to flow from CloudBees CI to CloudBees Software Delivery Automation.

Upgrading managed controllers

managed controllers need to be upgraded to use the latest Docker image.

To upgrade managed controllers:

  1. From your CloudBees CI Operations Center, select the drop-down menu next to the name of the controller, and then select Configure.

  2. Select the latest version.

  3. Select Save.

  4. Restart.

Signing in to CloudBees Software Delivery Automation

  1. Follow the instructions in the Helm chart to obtain the password.

  2. Go to https://your.host/flow/, replacing "your.host" with your host name, and sign in using the user name admin and the password obtained from step 1.

  3. On the You do not have a license to CloudBees Analytics screen, click If you have a license add it here.

  4. On the Licenses screen, click There are no licenses.

  5. On the Import License screen, enter your license data. The license will be processed.

  6. In the left pane, select CI configurations.

  7. In the left pane, select Administration ConfigurationsCI Configurations and verify that there is an entry for the CloudBees CI Operations Center URL.