Knowledge library

ScienceLogic SL1 / Historical reference

Installing SL1 and SL1 Extended on Hardware Appliances and Virtual Appliances

An archived technical reference covering Installing SL1 and SL1 Extended on Hardware Appliances and Virtual Appliances. Retained from the Dynecon knowledge library for engineering context.

This reference preserves the original technical material. Its procedures and screenshots reflect the original product version, not necessarily your installed release. Consult the ScienceLogic documentation for current guidance. Some original vendor images and links are no longer available; missing figures are identified in the text.

Download this manual as a PDF file

This section describes how to install SL1 on hardware Appliances or on virtual machines.

Use the following menu options to navigate the SL1 user interface:

  • To view a pop-out list of menu options, click the menu icon ([Original reference image unavailable: menu icon]).
  • To view a page containing all the menu options, click the Advanced menu icon ([Original reference image unavailable: AdvancedMenu]).

This section includes the following topics:

Overview

Prerequisites

Upgrading

Installing the the Database Server

Installing the Administration Portal, Data Collector and Message Collector

Adding SL1 Extended to an Existing SL1 Distributed System

Part 1: Installing the Management Node, the Compute Node, the Storage Node, and the Load Balancer

Part 2: Installing the Management Node, the Compute Node, the Storage Node, and the Load Balancer

Testing the Compute Node

Managing the Compute Node

Licensing the SL1 and SL1 Extended Appliances

Enabling Collector Pipeline in SL1 Extended Architecture

Prerequisites

To perform the steps in this section:

  • You must have already performed the prerequisites for all the ScienceLogic Hardware Appliances in your SL1 stack or for all the Virtual Appliances in your SL1 stack.
  • You must have a valid customer account that allows you to download the SL1 ISO. For details, contact your Customer Success Manager.
  • You must download the SL1 ISO.
  • Mount the SL1 ISO on each virtual appliance.
  • You must have access to the files for your SSL certificate.
  • You must have a valid customer account that allows you to access the Artifactory page on the ScienceLogic Customer Portal. For details, contact your Customer Success Manager.

Upgrading

For upgrade instructions, see the release notes for the current release.

Installing the Database Server

The Database Server should be the first appliance you install. To do so:

  1. Boot the appliance from the SL1 ISO.

NOTE: If you are using Hyper-V, check that the ScienceLogic installation ISO mounted correctly and that the Virtual Machine displays the install screen. To do this, right-click the Virtual Machine in inventory and select Connect or View and then Connect via Console.

  1. The following window appears:

[Original reference image unavailable: iso boot install options 576x432]

  1. Select Install EM7. The Model Type window appears.

[Original reference image unavailable: appliance type 384x338]

  • Select the Database. Select Continue.
  • The Military Unique Deployment window appears. Do not select if you are not using a Military Unique Deployment.

[Original reference image unavailable: iso boot military unique deployment 384x178]

  • Select Continue. The Database window appears:

[Original reference image unavailable: iso boot db location 384x274]

  1. In the Database window, select Local Database and select Continue.
  2. After the installer for the selected appliance type is loaded, the Network Configuration window appears.

[Original reference image unavailable: setup wizard new 384x328]

  1. Enter the following information:
  • IP Address. Type the primary IP address of the appliance.
  • Netmask. Type the netmask for the primary IP address of the appliance.
  • Gateway. Type the IP address for the network gateway.
  • DNS Server. Type the IP address for the primary Nameserver.
  • Hostname. Type the hostname for the appliance.
  1. Select Continue.
  2. The System Password window appears:

[Original reference image unavailable: system password 384x322]

  1. Type the password for the em7admin user on the operating system and select Continue.
  2. Type the password for the em7admin user again and select Continue.
  3. The appliance installer runs, and the virtual machine reboots automatically.
  4. If you are using a VMware instance, after the appliance reboots, follow the instructions to install VMware tools.
  5. Follow the instructions to license the appliance.

Installing the Administration Portal, Data Collector and/or Message Collector

After installing the Database Server, you can next install

  1. The Administration Portal (if applicable)
  2. The Data Collectors
  3. The Message Collectors (if applicable)

You can use the following instructions to build the Administration Portal, and one or more Data Collectors and Message Collectors.

  1. Boot the appliance from the SL1 ISO
  2. Select Install EM7. The Model Type window appears.

[Original reference image unavailable: appliance type 384x338]

  • Select the appropriate appliance type. Select Continue.
  • The Military Unique Deployment window appears. Do not select if you are not using a Military Unique Deployment.

[Original reference image unavailable: iso boot military unique deployment 384x178]

  1. After the installer for the selected appliance type is loaded, the Network Configuration window appears.

[Original reference image unavailable: setup wizard new 384x328]

  1. Enter the following information:
  • IP Address. Type the primary IP address of the appliance.
  • Netmask. Type the netmask for the primary IP address of the appliance.
  • Gateway. Type the IP address for the network gateway.
  • DNS Server. Type the IP address for the primary Nameserver.
  • Hostname. Type the hostname for the appliance.
  1. Select Continue.
  2. The System Password window appears:

[Original reference image unavailable: system password 384x322]

  1. Type the password for the em7admin user on the operating system and select Continue.
  2. Type the password for the em7admin user again and select Continue.
  3. If you are using a VMware instance, after the appliance reboots, follow the instructions to install VMware tools.
  4. Follow the instructions to configure the appliance in the Web Configuration Tool.

Adding SL1 Extended to an Existing SL1 Distributed System

You can add the SL1 Extended system to an existing SL1 Distributed system. To do so:

  1. Update the SL1 Distributed System to 8.14.0 or later. For details on updating SL1, see the System Administration manual.
  2. Follow the steps in the section Part 1: Installing the Management Node, the Compute Node, the Storage Node, and the Load Balancer from the ISO
  3. Follow the steps in the section Part 2: Installing the Management Node, the Compute Node, the Storage Node, and the Load Balancer from Artifactory

Part 1: Installing the Management Node, the Compute Node, the Storage Node, the Storage Manager, and the Load Balancer from the ISO

If you are installing an SL1 Extended system, you must build the following appliances:

  • One (1) Management Node
  • Three (3) appliances for a Storage Node cluster
  • One (1) Storage Manager
  • Six (6) appliances for a Compute Node cluster. For product environment, ScienceLogic recommends six appliances in a Compute Node cluster. For stging or development environments, you can optionally use only three appliances in a a Compute Node cluster.
  • One (1) Load Balancer. Optionally, you can create two Load Balancers if you want disaster recovery for this appliance.

You will perform the steps in this section for each node list above.

To build the appliances for SL1 Extended:

  1. Boot the appliance from the SL1 ISO
  2. Select Install EM7. The Model Type window appears.

[Original reference image unavailable: appliance type 384x338]

  • Select the appliance type Platform Node. Select Continue.
  1. After the installer for the selected appliance type is loaded, the Network Configuration window appears.

[Original reference image unavailable: setup wizard new 384x328]

  1. Enter the following information:
  • IP Address. Type the primary IP address of the appliance. Each appliance must have a unique IP address. That is, the Management Node, Storage Nodes, Storage Manager node, Compute Nodes, and optional Load Balancer must each have a unique IP address.
  • Netmask. Type the netmask for the primary IP address of the appliance.
  • Gateway. Type the IP address for the network gateway.
  • DNS Server. Type the IP address for the primary Nameserver.
  • Hostname. Type the hostname for the appliance.
  1. Select Continue.
  2. The System Password window appears:

[Original reference image unavailable: system password 384x322]

  1. Type the password for the em7admin user on the operating system and select Continue.

The system password must be the same for all appliances in SL1 Extended. The Management Node, all the appliances in the Compute Node cluster, the Load Balancer, all appliances in the Storage Node cluster, and the Storage Manager must use the identical System Password.

  1. Type the password for the em7admin user again and select Continue.
  2. If you are using a VMware instance, after the appliance reboots, follow the instructions to install VMware tools.
  3. Perform these steps for each SL1 Extended appliance.
  4. Follow the instructions to continue building the appliances for SL1 Extended.

Part 2: Installing the Management Node, the Compute Node, the Storage Node, the Storage Manager, and the Load Balancer from Artifactory

To perform the steps in this section:

  • You must have a valid customer account that allows you to access the Artifactory page on the ScienceLogic Customer Portal. For details, contact your Customer Success Manager.
  • On each appliance for SL1 Extended, you must have performed the steps in the previous section.
  • All SL1 Extended appliances must be online and accessible via SSH

NOTE: These instructions include commands with arguments. The arguments appear as <argument name>. Do not include the "<" and ">" characters in the command. Instead, replace the italicized text with appropriate argument, without the "<" and ">" characters.

Connect to the ScienceLogic Repository

To download files for deploying the Extended Architecture, you must access the ScienceLogic Repository. to do this:

  1. Open a browser session. Go to the following URL:

https://sciencelogic.jfrog.io/sciencelogic/webapp/#/profile

[Original reference image unavailable: generate api key 576x281]

  1. In the API Key field, click the gear icon to generate an API Key.
  2. Click the eye icon to view the key. Copy and save the key for use later.

Transform the Management Node

To transform the Management Node from a generic Platform Node to a working Management Node:

  1. Either go to the console of the Management Node or use SSH to access the Management Node. Open a shell session on the server. Log in with the System Password you defined in the ISO menu.
  2. The steps in this section require super-user privileges. At the shell, prompt, enter the following:

sudo su -

  1. Next, enter the following:

curl –u https://sciencelogic.jfrog.io/sciencelogic/script-store/management-node/mn-transformation.sh | bash

When prompted, enter the API key you saved earlier.

  1. To apply the changes from the "mn-transformation.sh" script, exit the sudo session :

exit

  1. To apply the changes from the "mn-transformation.sh" script, exit the SSH session:

exit

Transforming the Compute Nodes, Storage Nodes, Storage Manager, and Load Balancer

From the Management Node, you download and edit an inventory file, sl1x-inv.yml, that transforms the remaining nodes from generic Platform Nodes to specific nodes in the Extended Architecture.

  1. Either go to the console of the Management Node or use SSH to access the Management Node. Open a shell session on the server. Log in with the System Password you defined in the ISO menu.
  2. At the shell prompt, enter the following:

docker login -u <user name> sciencelogic-docker.jfrog.io

where:

  1. You will be prompted to enter the password that allows access to Artifactory.
  2. Enter the following to create the sl1x-deploy directory. This directory will store the files required for deployment.

mkdir sl1x-deploy

  1. Navigate to the sl1x-deploy directory and then download and extract k8s-deploy.tar.gz. To do this, enter the following at the shell prompt:

cd sl1x-deploy

curl -u https://sciencelogic.jfrog.io/sciencelogic/docker-compose-local/sl1x-deploy.tar.gz | tar zxv

When prompted, enter the API key you saved earlier.

  1. SL1 Extended requires that you use your organization's SSL certifications for HTTPs. You must copy your SSL certificate, a chained certificate, and the key file to the directory /sl1x-deploy/input-files.
  2. To copy the SSL certificate to the Management Node, login to the server where you store the certificate. Go to the directory that contains the certificate. Enter the following at the command line:

scp <name of the certificate>* em7admin@<IP address of the Management Node>:sl1x-deploy/input-files/

where:

  • name of the certificate is name of the certificate.
  • IP address of the Management Node is the IP address of the Management Node.
  1. To create the chained certificate:

cat <your domain>.crt intermediate.crt > <your domain>.chained.crt

where:

  • your domain is the domain name associated with your SSL certificate.
  1. Copy the template for the inventory file to the name sl1x-inv.yml. To do this:

cp sl1x-inv-template.yml sl1x-inv.yml

  1. Edit the file sl1x-inv.yml to match your SL1 Extended system. At the shell prompt, enter:

vi sl1x-inv.yml

:  Do not remove colons when editing this file.

The file looks like this:

---
all:
  vars:
    ansible_become_password: # sudo password goes here

    dns_domain: # domain you want to use

    sl1_version: # the version of sl1 that you have installed

    # roles/ba-common
    em7_mc_destination: # ip of message collector
    em7_network_range: # network cidr

    # roles/cn-helm
    artifactory_username:
    artifactory_password:
cn:
  children:
    master:
      hosts:
        1.2.3.4: # ip of compute node 1
        1.2.3.4: # ip of compute node 2
        1.2.3.4: # ip of compute node 3
    worker:
      hosts:
        #1.2.3.4: # ip of compute node 4
        #1.2.3.4: # ip of compute node 5
        #1.2.3.4: # ip of compute node 6
  vars:
    # roles/cn-rke
    cert_setup: secret # this option allows you to provide an existing ssl cert
    cert_file: "{{ input_directory }}/name-of-file.crt"
    key_file: "{{ input_directory }}/name-of-file.key"
    # roles/cn-deploy-charts
    mdb_ips: # mariadb nodes, most likely your cdb
      -  #1.2.3.4 # ip(s) of mariadb node(s)
    mdb_user: # mariadb username
    mdb_key: # mariadb password
    gql_ips: # gql nodes, usually the same as mdb_ips
      -  #1.2.3.4 # ip(s) of gql node(s)
    gql_user: # gql username
    gql_key: # gql password

lb:
  hosts:
    #1.2.3.4: # ip of load balancer 1
    #1.2.3.4: # ip of load balancer 2
  vars:
    # roles/cn-load-balancer
    load_balancer_vip: #1.2.3.4 # virtual ip for ha load balancing, requires two load balancer hosts

cdb:
  hosts:
    1.2.3.4: # ip of cdb 1
    # 1.2.3.4: # ip of cdb 2
  vars:
    cdb_vip: # ip of cdb virtual ip, requires two cdb’s

sn:
  hosts:
    #1.2.3.4: # ip of storage node 1
    #1.2.3.4: # ip of storage node 2
    #1.2.3.4: # ip of storage node 3
  vars:
    # roles/sn-scylla
    scylla_admin_username: # scylla admin username
    scylla_admin_password: # scylla admin password
  1. Supply values in the following fields:
  • ansible_become_password: Enter the System Password you specified in the ISO menu. Do not delete the colon character.
  • cluster_name: Enter a unique name for your cluster. Do not delete the colon character.
  • dns_domain: Remove the leading "#" character and after the colon, specify the DNS domain. This must match the domain specified in your SSL certificate. Do not delete the colon character.
  • sl1_version: Specify the SL1 version. For example, 10.1.0.
  • em7_mc_destination: If applicable, enter the IP address of the Message Collector.
  • em7_network_range: Enter the network CIDR
  • artifactory_username: Customer name that allows access to Artifactory. Do not delete the colon character.
  • artifactory_password: Eenter the API key you saved earlier. Do not delete the colon character.
  • cn: > children: > master:> hosts: (required)
  • #1.2.3.4: Remove the leading "#" character and replace "1.2.3.4" with the IP address of the first Compute Node. Do not delete the colon character.
  • #1.2.3.4: Remove the leading "#" character and replace "1.2.3.4" with the IP address of the second Compute Node. Do not delete the colon character.
  • #1.2.3.4: Remove the leading "#" character and replace "1.2.3.4" with the IP address of the third Compute Node. Do not delete the colon character.
  • cn: > children: > worker:> hosts: (recommended for product environments)
  • #1.2.3.4: Remove the leading "#" character and replace "1.2.3.4" with the IP address of the fourth Compute Node. Do not delete the colon character.
  • #1.2.3.4: Remove the leading "#" character and replace "1.2.3.4" with the IP address of the fifth Compute Node. Do not delete the colon character.
  • #1.2.3.4: Remove the leading "#" character and replace "1.2.3.4" with the IP address of the sixth Compute Node. Do not delete the colon character.
  • cn: > vars:
  • cert_file: "{{ input_directory }}/name-of-file-.crt" Replace "name-of-file.crt" with the name of your chained SSL certificate. Do not delete the colon character.
  • key_file: "{{ input_directory }}/name-of-file.key" Replace "name-of-file.crt" with the name of your SSL key file. Do not delete the colon character.
  • cn: > vars: > mdb_ips:
  • - #1.2.3.4 Remove the leading "#" character and replace "1.2.3.4" with the IP address for each Database Server. Do not delete the colon character.
  • If you are using a High Availability or Disaster Recovery configuration, specify the virtual IP address of the Database Server.
  • cn: > vars: gql_ips: >
  • - #1.2.3.4 Remove the leading "#" character and replace "1.2.3.4" with the IP address of your Database Server. Do not delete the colon character.
  • If you are using a High Availability or Disaster Recovery configuration, specify the virtual IP address of the Database Server.
  • lb: > hosts:
  • #1.2.3.4: Remove the leading "#" character and replace "1.2.3.4" with the IP address of the first Load Balancer. Do not delete the colon character.
  • #1.2.3.4: If applicable, remove the leading "#" character and replace "1.2.3.4" with the IP address of the second Load Balancer. Do not delete the colon character.
  • lb: > vars: > load_balancer_vip:
  • #1.2.3.4: If you are using two Load Balancers, and replace "1.2.3.4" with an available IP address that will server as the virtual IP for the active Load Balancer. Do not delete the colon character.
  • cdb: > hosts:
  • #1.2.3.4: Remove the leading "#" character and replace "1.2.3.4" with the IP address of the Database Server. Do not delete the colon character. This entry does not create the Database Server but instead updates the user interface during installations and upgrades.
  • #1.2.3.4: If you are using a High Availability or Disaster Recovery configuration, remove the leading "#" character and replace "1.2.3.4" with the IP address of the second Database Server. Do not delete the colon character. This entry does not create the Database Server but instead updates the user interface during installations and upgrades.
  • cdb: > vars:
  • cdb_vip:If you are using a High Availability or Disaster Recovery configuration, specify the virtual IP address of the Database Server. Do not delete the colon character
  • sn: > hosts:
  • #1.2.3.4: Remove the leading "#" character and replace "1.2.3.4" with the IP address of the first Storage Node. Do not delete the colon character.
  • #1.2.3.4: Remove the leading "#" character and replace "1.2.3.4" with the IP address of the second Storage Node. Do not delete the colon character.
  • #1.2.3.4: Remove the leading "#" character and replace "1.2.3.4" with the IP address of the third Storage Node. Do not delete the colon character.
  • sn: > vars:
  • scylla_admin_username: Enter the user name for Scylla. When you finish the SL1 Extended Deployment, Scylla will use this user name. Do not delete the colon character.
  • scylla_admin_password: Enter the password for Scylla. When you finish the SL1 Extended Deployment, Scylla will use this user name. Do not delete the colon character.
  • sm: > hosts:
  • #1.2.3.4: Remove the leading "#" character and replace "1.2.3.4" with the IP address of the first Storage Node. Do not delete the colon character.
  • sm: > vars:
  • scylla__manager_db_username: Enter the user name for Scylla manager. When you finish the SL1 Extended Deployment, Scylla manager will use this user name. Do not delete the colon character.
  • scylla_manager_db_password: Enter the password for Scylla manager. When you finish the SL1 Extended Deployment, Scylla manager will use this user name. Do not delete the colon character.
  1. In 10.1.0, Publisher is a beta feature. If you want to include Publisher in your SL1 Extended Architecture, include the following line at the top of the file, under the all > vars section

all:

vars:

install_publisher: true

  1. SL1 Extended includes an SSH key. SL1 processes (specifically RKE) use SSH to communicate with the Compute Nodes. To define an SSH key, enter the following at the shell prompt:

docker-compose -f docker-compose.external.yml run --rm deploy ssh-keys --ask-pass

When prompted, enter the System Password that you entered in the ISO menu.

  1. To deploy the SL1 Extended system, enter the following at the shell prompt:

docker-compose -f docker-compose.external.yml run --rm deploy sl1x

  1. You must create "A" records in your DNS system for the SL1 streamer process and the responder process:
  • streamer.<cluster_name>.<dns_domain>
  • responder.<cluster_name>.<dns_domain>

where:

cluster_name is the name you specified at the top of the sl1x-inv.yml file.

dns_domain is the domain specified in your SSL certificate.

  • If you are using a single Load Balancer node, assign the IP address of the Load Balancer node.
  • If you are using two Load Balancer nodes, assign the virtual IP (VIP) that you defined for the Load Balancers.
  1. In the classic UI, you should now see the new appliances in the Appliance Manager page (System > Settings > Appliances).
  2. You can view log messages about the installatin of the new appliances in the System Logs page (System > Monitor > System Logs.

Testing the Compute Node Cluster

To test the Compute Node cluster (a Kubernetes cluster):

  1. Either go to the console of the Management Node or use SSH to access the Management Node. Open a shell session on the server. Login with the system password you defined in the ISO menu.
  2. Edit the file hello-world.yml. To do this, enter the following at the shell prompt:

vi /sl1x-deploy/hello-world.yml

  1. Find this section of the file and enter a value for your domain:

spec:

tls:

- hosts:

- hello.<your domain>

where:

  • your domain is the same domain you specified in your SSL certificate.
  1. Save your changes.
  2. Run the following command to enter the docker container:

docker-compose -f docker-compose.external.yml run --rm deploy shell

  1. Run the following command to build the hello-world service:

kubectl apply -f hello-world.yml

  1. Return to the shell and add an entry to the /etc/hosts file for the new hello-world service. Add the following line:

<IP address of Load Balancer or VIP or Load Balancer> hello.<your domain>

where:

  • IP address of Load Balancer or VIP or Load Balancer is the IP address of the Load Balancer or the VIP for the Load Balancer (if you have configured two Load Balancers).
  • your domain is the same domain you specified in your SSL certificate.

For example:

10.2.200.104 hello.test.sciencelogic.com

  1. To test the "hello world" program, enter the following:

curl –L hello.<your domain>

where:

  • your domain is the same domain you specified in your SSL certificate.
  1. The output should look like this::

Hello, world!

Version: 1.0.0

Hostname: hello-app-<string>

where:

  • string is a string of characters that is unique for each version of SL1.

Managing the Compute Node Cluster

SL1 Extended includes tools to manage the Computer Node Cluster.

To access these tools:

  1. Either go to the console of the Management Node or use SSH to access the Management Node. Open a shell session on the server. Login with the system password you defined in the ISO menu
  2. Run the following command to enter the docker container:

docker-compose -f docker-compose.external.yml run --rm deploy shell

  1. You can now access the following tools:
  • kubectl
  • helm
  • k9s

Licensing the SL1 and SL1 Extended Appliances

For details on licensing the SL1 and SL1 Extended Appliances, see the section Licensing and Configuring an Appliance.

Enabling Collector Pipeline in SL1 Extended Architecture

Collector Pipeline is a platform feature that allows horizontal scaling (adding more Data Collectors and Agent installations) without data loss or performance loss.

Collector Pipeline also supports the new beta feature, Publisher, and the new beta feature, Anomaly Detection.

Currently, Collector Pipeline supports availability data, interface data, and data from Performance Dynamic Applications. SL1 will add more data types in future releases.

NOTE: If you want to use Anomaly Detection, enable Collector Pipeline with data from Performance Dynamic Applications.

To enable Collector Pipeline for availability data, interface data, and anomaly detection:

  1. Either go to the console of the Database Server or use SSH to access the Database Server. Open a shell session on the server. Log in with the system password you defined in the ISO menu.
  2. To view information about the command, enter the following at the shell prompt:

/opt/em7/backend/set_cpl.py -help

  1. To enable Collector Pipeline for availability data, interface data, and anomaly detection, enter the following at the shell prompt:

/opt/em7/backend/set_cpl.py -d availability ENABLE

/opt/em7/backend/set_cpl.py -d interface ENABLE

/opt/em7/backend/set_cpl.py -d da_perf ENABLE

  1. To disable Collector Pipeline for availability data, interface data, and anomaly detection, enter the following at the shell prompt:

/opt/em7/backend/set_cpl.py -d availability DISABLE

/opt/em7/backend/set_cpl.py -d interface DISABLE

/opt/em7/backend/set_cpl.py -d da_perf DISABLE