Installing CloudBees CI on traditional platforms and CloudBees Analytics for the first time

5 minute read

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

Follow these steps in the order listed to complete the installation:

Pre-installation requirements

Before starting the installation process, do the following:

  • Contact CloudBees Support to obtain the executable files for the CloudBees Software Delivery Automation and CloudBees Analytics installers.

  • Review the CloudBees CI on traditional platforms + CloudBees Analytics details to become familiar with how CloudBees CI and CloudBees Software Delivery Automation work together.

Installing CloudBees CI on traditional platforms

The first step is to install the CloudBees CI on traditional platforms Operations Center and client controller version 2.263.4.2 or later. This step is required to obtain the CloudBees Software Delivery Automation plugins, which are included in CloudBees Assurance Program (CAP) and bundled in the Operations Center and controller .war files.

After you install CloudBees CI on traditional platforms Operations Center and client controller, come back to this page to continue with the installation.

Installing CloudBees Analytics prerequisites

The next step is to install the prerequisites for CloudBees Analytics, which include the CloudBees CD/RO server, a webserver, the local agent, and an CloudBees Analytics server including ElasticSearch and a MariaDB database.

Be sure that you have obtained the executable files for the CloudBees Software Delivery Automation and CloudBees Analytics installers from CloudBees Support.

The artifact repository and CloudBees CD plugins are not installed.

Use the steps in this section to install the prerequisite CloudBees Software Delivery Automation components needed for CloudBees Analytics. Review Before You Install CloudBees Software Delivery Automation before performing this procedure.

The built-in database is not supported in a clustered CloudBees Software Delivery Automation configuration.
  1. (Linux only) Enter the following command to make the installer file executable:

    chmod +x ./CloudBeesFlow-<version>
  2. Do one of the following to start the installation:

    • For Linux with root or sudo privileges or for Windows installations, double-click the installer file.

    • For Linux non-root/non-sudo installations, on a command line enter:

      ./CloudBeesFlow-<version> --nonRoot

      For this installation type, a warning about automatic server start-up with non-root/non-sudo installations appears. Click Yes to dismiss the warning.

    The install wizard welcome screen displays.

  3. Select one of the following

    • Install CloudBees Analytics prerequisites with built-in database: this option installs the built-in database, MariaDB, for use by the CloudBees Software Delivery Automation server.

    • Install CloudBees Analytics prerequisites without built-in database: this option does not install a database. After installation and during CloudBees Software Delivery Automation server startup, you are asked to configure a database.

    Select Next to continue. The Directories screen appears.

  4. Review Install directory and Data directory default locations; select Browse to specify different directory locations. Click Next to continue. The Server service account screen appears.

  5. Select the appropriate step for your platform and complete the information for the server service account.

    • Windows:

      • User Name: Enter the name of the user who will run the CloudBees Software Delivery Automation server, web server, and repository server services.

      • Password: Enter the password of the user who will run the CloudBees Software Delivery Automation server, web server, and repository server services.

      • Domain: Enter the domain name information for the user. Leave this field blank if this is a local user.

      • Use the local system account: Select this check box if you want the CloudBees Software Delivery Automation server, repository server, and web server services to run as the local Windows system account.

      • Use the same account for the agent service: Select this check box if you want the agent on the CloudBees Software Delivery Automation server machine to run as the same account.

        For security reasons in production environments, CloudBees recommends using a separate account for the agent service because the server account has permission to read the key file located here:

    • Linux: installation-directory/conf/passkey

    • Windows: installation-directory\conf\passkey

      The key file is used to decrypt passwords stored in CloudBees Software Delivery Automation. Using a different account for the agent service ensures that a process running on the agent cannot gain access to the key file.

    • Linux:

      • User Name: Enter the name of the user who owns the CloudBees Software Delivery Automation server, repository server, and web server processes.

      • Group Name: Enter the name of the group who owns the CloudBees Software Delivery Automation server, repository server, and web server processes.

      • Use the same account for the agent service: Select this check box if you want the agent on the CloudBees Software Delivery Automation server machine to run as the same account.

      Click Next to continue. The Agent Service Account screen appears.

    If you selected the Use the same account for the agent service check box on the previous screen, you will not see this screen.
  6. Select the appropriate step for your platform and complete the information for the agent service account.

    • Windows:

      • User Name: Enter the name of the user who will run the CloudBees Software Delivery Automation agent service.

        The user that the agent runs as must have permission to write to the $INSTALL_DIRECTORY/log directory.

      • Password: Enter the password of the user who will run the CloudBees Software Delivery Automation agent service.

      • Domain: Enter the domain name information for the user. For example, electric-cloud.com. Leave this field blank if this is a local user.

      • Use the local system account: Select this check box if you want the CloudBees Software Delivery Automation agent service to run as the local Windows system account.

        The local system account does not have access to network shares.
    • Linux:

      • User Name: Use this field to enter the name of the user who owns the CloudBees Software Delivery Automation agent process.

        The user/group that the agent runs as must have permission to write to the $INSTALL_DIRECTORY/log directory. If you specify root, click Yes when the following confirmation appears:

      • Group Name: Use this field to enter the name of the group that owns the CloudBees Software Delivery Automation agent process.

    Click Next to continue. The Ready to Install screen appears.

  7. Review the default settings and your service account selections. Use the Back button to change your service account selections if necessary.

  8. Review Send user data information. When checked, anonymized, aggregated usage information is sent to CloudBees. Uncheck if you do not want to participate. Click Next to continue.

    The installer displays a status bar to show the progress of the installation, which can take fifteen minutes. When the install process is complete, the Install Wizard Complete screen appears.

    The CloudBees Software Delivery Automation server automatically starts when the installation is complete.
  9. Select the Launch a web browser to login to CloudBees Software Delivery Automation check box if you want CloudBees Software Delivery Automation to open the login screen after installation is complete.

  10. Click Finish to close the wizard.

  11. For non-root/non-sudo Linux installations, configure autostart for the CloudBees Software Delivery Automation services.

If you opted for installation without the built-in database, you are prompted on the sign-in page to configure an external database during CloudBees CD/RO server startup. See External database configuration for further information.

After the installation of the prerequisites is complete, install CloudBees Analytics.

Installing CloudBees Analytics

Start the installation by following the steps for the CloudBees Analytics UI installer.

After the installation is complete, you must set up the analytics server. See Configuring the CloudBees Software Delivery Automation analytics server.