DevOps Insight Server

4 minute read

The graphical user interface installation method is supported by Windows platforms and Linux platforms running the X Window System. The following procedure includes instructions for adding a system to a DevOps Insight cluster during installation.

For details about the overall steps for installing DevOps Insight on a group of servers to create a DevOps Insight server cluster, see Installing the DevOps Insight Server in Cluster Mode .

Install with other CloudBees CD components

For a production environment, CloudBees recommends that you install the DevOps Insight server on a system other than systems running other CloudBees CD components (such as the CloudBees CD server, web server, repository server, or agent). If you must install it on the same system (such as for testing or other non-production or trial-basis situations) see DevOps Insight server with other components for details.

Installation instructions

  1. (Linux only) Enter the following command to make the installer file executable:

    chmod +x CloudBeesFlowDevOpsInsightServer-x64-
  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:

      ./CloudBeesFlowDevOpsInsightServer-x64- --nonRoot

      For this installation type, a warning appears.

  3. For non-root/non-sudo installations, click Yes to dismiss the warning. The Welcome to the CloudBees CD DevOps Insight Server Install Wizard screen appears.

  4. Click Next to continue. The Directories screen appears. The installer uses the default directories to install files and components.

  5. Click Next to continue, or click Browse to specify different directory locations. The Service Account screen appears.

  6. If you have a Windows system, complete the information on the Service Account screen as follows:

    • User Name —Name of the user who will run the CloudBees CD DevOps Insight server services.

    • Password —Password of the user who will run the CloudBees CD DevOps Insight server services.

    • Domain —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 —Determines if the CloudBees CD DevOps Insight server services will run as the local Windows system account.

  7. If you have a Linux system, complete the information on the Service Account screen as follows:

    • User Name—Name of the user who owns the CloudBees CD DevOps Insight server processes.

    • Group Name—Name of the group who owns the CloudBees CD DevOps Insight server processes.

  8. include::partial$guiinstall-and-upgrade-dois-steps-in-common.adoc[]

  9. Complete the information on the Security Settings screen, and click Next to continue. The Advanced Settings screen appears.

    • Use a different directory for data stored by Elasticsearch —Check this checkbox if you want to use a non-default directory for Elasticsearch index data. If you do so, the Elasticsearch data directory field appears to let you enter that directory.

    • Specify the certificate file containing a CA-signed certificate retrieved from the first node at the PKCS#12 file containing a CA-signed certificate for the CloudBees CD DevOps Insight Server prompt.

      You can leave this entry blank for a new installation in non-clustered mode or for the first node in clustered mode. In this case, the installer will generate a new self-signed certificate and will use it to sign other TLS certificates.
  10. Complete the information on the Advanced Settings screen, and click Next to continue.

  11. The Remote CloudBees CD Server screen appears. Complete the information as follows:

    • Skip CloudBees CD server configuration —Determines whether to skip the automatic configuration of the remote CloudBees CD server with the services being installed. If you choose this option, continue to the next step. Otherwise, fill in the fields in the screen as follows:

    • Server host name —Name of the CloudBees CD server that will communicate with this DevOps Insight server. If the remote server is using a non-default HTTPS port, you must enter <host>:<port>.

    • CloudBees CD User Name —Name of a CloudBees CD user on the CloudBees CD server who has sufficient privileges to edit server settings. This field defaults to the CloudBees CD-supplied admin user.

    • Password —Password for the CloudBees CD user. The default password for the admin user is changeme.

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

  13. Review this screen to verify your selections. Use the Back button to change any of your settings if needed.

  14. Click Begin Install.

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

  16. Click Finish to close the wizard.

Autostart for Non-Root/Non-sudo Linux Installations

For non-root/non-sudo Linux installations, you must configure autostart for the DevOps Insight services. For instructions, see Configuring Services Autostart for Non-Root/Non-sudo Linux Installations .

Configuration

If you chose to skip the option to configure the remote CloudBees CD server during the installation or upgrade of the DevOps Insight server, you must do so afterward to ensure connectivity and authentication between the DevOps Insight server and the CloudBees CD server. To do this, you use the Administration > DevOps Insight Server tab in the Automation Platform. For details, see Configuring the DevOps Insight Server.

Checking the configuration

You can confirm the correct DevOps Insight Server settings by entering the following ectool command on the CloudBees CD server:

ectool getDevOpsInsightServerConfiguration

Following is sample output:

  12642169-71c4-11e7-8a08-0050568f29b02017-07-26T05:34:19.404Zhttps://192.168.5.54:92001adminhttps://192.168.5.54:95002017-07-26T05:40:13.458Zadminreportuser

For details about the getDevOpsInsightServerConfiguration options, enter

ectool getDevOpsInsightServerConfiguration --help

Testing Connectivity and Authentication

After you enable connectivity and authentication between the DevOps Insight server and the CloudBees CD server, you can perform a test by using one of the following methods:

  • Check the Test Connection checkbox in the Administration > DevOps Insight Server subtab of the Administration Platform web UI on the CloudBees CD server and click OK.

  • Enter the following ectool command on the CloudBees CD server:

    ectool setDevOpsInsightServerConfiguration --testConnection 1

    For details about the setDevOpsInsightServerConfiguration options, enter

    ectool setDevOpsInsightServerConfiguration --help

    For example, the following response appears if the user name or password is incorrect:

    ectool error [InvalidCredentials]: HTTP/1.1 401 Unauthorized: Access to
      'https://192.168.5.54:9500' is denied due to invalid credentials.

    Also, for example, the following response appears if you specify an invalid elasticSearchUrl or logstashUrl :

    ectool error [InvalidUrl]: The url 'https://192.168.5.54:9500' is invalid

    The following example shows the response when a valid elasticSearchUrl is used:

    /opt/electriccloud/electriccommander/bin$ ./ectool setDevOpsInsightServerConfiguration
      --elasticSearchUrl https://192.168.5.54:9200 --testConnection 1