Installing a default configuration

4 minute readReference

This section details how to install a default configuration, which includes the CloudBees CD/RO server, the web server, built-in database, agent (for running jobs), and CloudBees CD/RO tools. Review Before you install CloudBees CD/RO before performing this procedure.

The built-in database is not supported in a clustered CloudBees CD/RO 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, enter:

      ./CloudBeesFlow-<version> --nonRoot

      For this installation type, a warning about automatic server start-up with non-root/non- sudo installations.

  3. For non-root/non- sudo installations, click Yes to dismiss the warning.

  4. Select the Install CloudBees CD/RO with built-in database and default configuration installation option, and then click Next to continue.

  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 CD/RO server, web server, and repository server services.

      • Password —Enter the password of the user who will run the CloudBees CD/RO server, web server, and repository server services.

      • 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 CD/RO server, repository server, and web server services to run as the local Windows system account.

        The Windows local system account cannot access network resources such as shared file systems used for plugins or workspaces. Therefore, do not use this option for a clustered server deployment, which requires a shared file system for plugins. This option is typically used only for installing agents on numerous machines, which would otherwise require that you create a new account on each of those machines.
      • Use the same account for the agent service —Select this check box if you want the agent on the CloudBees CD/RO server machine to run as the same account.

        For security reasons in production environments, you should use a separate account for the agent service because the server account has permission to read the key file.

    • Linux: installation-directory/conf/passkey

    • Windows: installation-directory\conf\passkey The key file is used to decrypt passwords stored in CloudBees CD/RO. 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 CD/RO server, repository server, and web server processes.

      • Group Name —Enter the name of the group who owns the CloudBees CD/RO server, repository server, and web server processes.

      • Use the same account for the agent service —Select this check box if you want the same user and group to own the agent process on the CloudBees CD/RO server machine.

        For security reasons in production environments, you should use a separate user and group for the agent service because the server service has permission to read the key file

    • Linux: installation-directory/conf/passkey

    • Windows: installation-directory\conf\passkey The key file is used to decrypt passwords stored in CloudBees CD/RO. Using a different user and group for the agent service ensures that a process running on the agent cannot gain access to the key file.

      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 CD/RO 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 CD/RO 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 CD/RO 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 CD/RO 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 CD/RO agent process.

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

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

    • Review information about usage data. Uncheck the Send usage data checkbox if you do not wish to participate.

      CloudBees Software Delivery Automation server has the ability to send information about its use, which helps to make CloudBees Software Delivery Automation better and more intuitive. Telemetry collects anonymized aggregated information and does not collect any identifying information like user names. For privacy reasons, you can turn off the ability to send telemetry data to CloudBees.
      The Send usage data option appears for new installations or upgrades from versions that didn’t have the ability to send usage data (v10.0 and earlier).
    • 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 CD/RO server automatically starts when the installation is complete.
  8. Select the Launch a web browser to login to CloudBees CD/RO check box if you want CloudBees CD/RO to open the sign-in screen when you exit the wizard.

  9. Click Finish to close the wizard.

  10. For non-root/non-sudo Linux installations, configure autostart for the CloudBees CD/RO services.