Set Up a New Aternity Docker Components Server in v11.0.0 and 11.0.1

Note

This article provides instructions for Aternityon-premise 11.0.0 and 11.0.1

The Aternity Docker Components Server is the on-premise server that hosts all Aternity Docker services which provide multiple different functionalities to Aternity. Most components are mandatory, but you can choose to add or omit some of the optional components and their associated functionality. Learn more about other Aternity components.

The Aternity Docker Components Server includes the following components:

Component Description

Aternity Agent Management

The Agent Management is responsible for displaying and operating the Agents Administration page in the Aternity console. It allows Aternity admins to start/stop Agents, analyze status, upload logs, and more. To access the Agents Administration, login to Aternity, select the Gear Icon > Agents > Agents Administration.

Vertica Writer

The Vertica Writer component is responsible for aggregating, indexing and summarizing the analytic data that arrives from various Aternity servers and writing it into the Vertica Database Server.

Vertica Scheduler

The Vertica Scheduler is responsible for creating the time-sensitive rollup aggregations in Vertica Database Server. As data gets older, hourly and daily aggregations are being created storing the RAW data and more compact structures. When using the Aternity dashboards, depending on the time range selection, Aternity will automatically route you to the relevant aggregation. Vertica Scheduler runs periodical tasks, such as hourly and daily aggregation, installed app snapshot calculation, and statistic computation.

Aternity Data Source for Portal

Configure the SteelCentral Portal™ to connect to your Aternity Data Source to view Aternity data in the Portal alongside data from other products in the SteelCentral Suite.

Learn more

SDA Server (Service Desk Alerts) (Optional)

A service desk alert (SDA) defines email or ServiceNow alerts on top of Aternity health events.

A service desk alert (SDA) indicates that the same health event occurred several times on the same device within a certain time. Aternity sends SDAs to draw attention to devices which suffer repeated application errors, system crashes or hardware issues. For example, you can receive an SDA whenever a device suffers from the same crash more than twice a week.

Learn more.

Aternity REST API Server(Optional)

The Aternity REST API Server is a docker component in Aternity on-premise which allows authorized users to send REST API queries to directly extract and analyze Aternity's data without Aternity's dashboards. You can combine the data with other data sources if needed, or transform it as required, then view it in Microsoft Excel, Power BI, or your own data application.

Learn more.

DPS (Installed Software)

The DPS is the data processing component. This DPS (Installed Software) is responsible for parsing and aggregating the Installed Software measurements, enabling analysis tasks, such as “who does not have the latest version installed” or “who already installed the latest OS patch”.

DPS (Device Resources)

The DPS is the data processing component. This DPS (Device Resource) is responsible for parsing and aggregating the device resource measurements, such as CPU, Memory, Disk usage and WiFi measurements. This data is later stored to Vertica Database Server for use in the Analyze dashboards and REST APIs.

Aternity Raw Data Docker Component (Cassandra)

The Raw Data Component houses the Cassandra Database and stores the detailed information and measurements for monitored devices for a maximum of 7 days. You view this data in the Troubleshoot Device and in the Installed Software dashboards.

Aternity Messaging Broker Docker Component (Kafka)

The Messaging Broker component is built on top of the Kafka infrastructure and serves as the messaging system between various Aternity components responsible for collecting, analyzing, aggregating and storing the collected data.

Aternity Remediation Docker

The Remediation component serves for managing remediation actions that IT people run on end user devices in order to remotely and automatically fix issues on those devices.

It receives remediation action commands from the Management Server and sends them to the Agent; it also manages remediation actions (add, edit, delete).

Before you begin

  • Download the latest Aternity on-premise's main setup package from the Aternity Support Site (learn more).

  • The Docker Components setup package (aternity-docker-components-<version>.tgz file) is part of the main setup package.

    Tip

    The Docker setup files must remain on the Linux host machine as an administrative tool, so location should be a permanent location with a sufficient disk space for the tool (about 8 GB).

  • Complete setting up the Aternity Oracle Database Server.

  • Complete setting up one or more Aternity Vertica Database Servers.

  • Complete setting up the Aternity Dashboard Server and the set up of the Dashboard Gateway.

  • Complete setting up the Aternity Management Server.

  • Configure the connection of your Aternity on-premise to your enterprise email server, as the route to send automatic email notifications.

  • Complete the setup (publishing) of the Aternity dashboard layouts.

  • Check that the Docker Components server conforms to the minimum system requirements:

    Attribute Requirement

    Hardware

    Hardware specifications depend on the size of your Aternity on-premise deployment. Choose the sizing and hardware specifications for your deployment size.

    Network

    Ensure this server has a static IP v4 address, and that you open the required ports.

    Operating system for Aternity Docker Components Server

    • Linux CentOS 7.4 or 7.5 or 7.6 or 7.7 or 7.8. To verify your version of CentOS, enter cat /etc/centos-release

    • Red Hat Enterprise Linux (RHEL) 7.4 or 7.5 or 7.6 or 7.7 or 7.8. To verify the RHEL version, enter cat /etc/redhat-release

    Docker version for Aternity Docker Components Server

    Aternity does not supply the Docker engine. Customers are responsible for its installation. It is required for the Aternity Docker Components Server, regardless of operating system.

    • On CentOS, Aternity supports Docker for CentOS 17.x or 18.x. Learn more. Use either the Community Edition (CE) or the Enterprise Edition (EE). EE requires subscription, while CE is free.

    • On Red Hat Enterprise Linux (RHEL), Aternity supports Docker 1.13, 17.x, and 18.x, but only 1.13 version is free. RHEL Docker 17.x and 18.x (Enterprise Edition) are only available for RHEL with a paid subscription to Docker.

    • After you set up the Docker engine and run it, you can set up the Docker Components from a Docker image file.

    If you do not have an internet access, follow the procedure explained here. You can always go to the Docker website to learn more.

    Partitions

    Divide free disk space into several partitions where each partition is dedicated to the data directory of a different component: Messaging Broker(Kafka), and Raw Data Component (Cassandra). Allocate disk space to each partition according to hardware requirements of the relevant sizing model. The rest free disk space is dedicated to log files and REST APIs. Learn more.

    (Aternity on-premise 11.0.0 and 11.0.1 only) Setup Permissions

    Run the setup as a user with root or sudo root privileges on the computer. To verify, enter sudo id.

    If you run the setup as a user with sudo permissions that requires a password, setup will prompt you for the password. If the sudo user does not require a password, the setup does not interrupt the process with those prompts.

    (Aternity on-premise 11.0.0 and 11.0.1 only) Docker commands permissions (other than setup).

    In addition to a user with root or sudo root privileges, a user who is a member of the group docker can run Docker commands, like Start/Stop/Restart, and more (except for initial setup). Learn more.

    Email server

    Verify the Aternity Management Server is configured to work with an email server. Learn more.

Procedure

  1. Step 1 Access the Docker Components computer.
    Log in as a user with root or sudo root privileges on the computer. To verify, enter sudo id.
  2. Step 2 Locate the Docker Components setup package, aternity-docker-components.tgz which you downloaded as part of the Aternity on-premise setup package.
    Copy it to a permanent destination folder on this computer, and ensure to keep it there.
    Important

    Make sure to place the aternity-docker-components in a dedicated directory, and NOT inside any of the data or logs directories of other components, including /data/cassandra, /data/kafka, /data/rest_api, or /data/logs). If it is located in any of those default locations, it may harm the component operation.

  3. Step 3 Extract the contents of the .tgz file by entering:
    tar -xvf aternity-docker-components-<version>.tgz
    Field Description
    -x

    Use -x to unzip the contents of the package.

    -v

    Use -v to output all messages (verbose).

    -f

    Use -f to specify the filename.

    Once extracted, the .tgz file created in the same location a new directory called aternity-docker-components with all the files and folders described in the below table.

    The downloaded package contains a number of files and folders, including:

    File/Folder Description

    aternity-docker-admin

    This script sets up a single Aternity Docker Components Server. In addition, it can also run different commands. Do not edit this file.

    properties.ini

    This file contains the properties used by the setup script. You must edit this file before running the setup, so that the script will know how and where to set up the Aternity Docker Components Server.

    versions.ini

    This file contains the version identifiers of all Docker Components.

    Utilities

    This folder contains all possible commands that you can carry out using the tool.

  4. Step 4 Ensure you are in the directory with all unpacked files.
  5. Step 5 Edit the properties.ini
    Edit the setup parameters in the properties.ini file
    Parameter Description

    installation_size in the [General] section.

    Enter the size of your Aternity deployment:

    Learn more.

    management_url in the [General] section.

    Enter the Aternity Management Server hostname or FQDN (recommended) or IP v4 address, including protocol prefix. For example, https://aternity.mycompany.com.

    FQDN in the [General] section.

    Specify a fully qualified domain name for the Docker Components host. If empty, the hostname of the Docker Components host will be used.

    logs_dir

    in the [General] section.

    Define the directory for the log files location (absolute path).

    deploy in the [SDA] section.

    (Optional) Enter yes to deploy the SDA Server (Service Desk Alerts).

    Enter no if you do not use this optional component. The component will not be installed.

    data_dir in the [SDA] section.

    Define the directory for the SDA Server (Service Desk Alerts) files (absolute path).

    deploy in the [portal_ds] section.

    (Optional) Enter yes to deploy the Aternity Data Source for Portal.

    Enter no if you do not use this optional component. The component will not be installed.

    external_url in the [portal_ds] section.

    If no value is given, then the FQDN will be used. If no value was given for the FQDN either, then the hostname will be used. Additionally, define the external URL to the Aternity Data Source for Portal if a load balancer or proxy are to be used, and user requests will be made to an address other than that of the Docker Components host.

    deploy in the [rest_api] section.

    (Optional) Enter yes to deploy REST API.

    Enter no if you do not use this optional component. The component will not be installed.

    data_dir in the [rest_api] section.

    Define the directory for the Aternity REST API Server files (absolute path).

    external_url in the [rest_api] section.

    If no value is given, then the FQDN will be used. If no value was given for the FQDN either, then the hostname will be used. Additionally, define the external URL to the Aternity REST API Server if a load balancer or proxy are to be used, and user requests will be made to an address other than that of the Docker Components host.

    data_dir in the [cassandra] section.

    Define the directory for the Raw Data Component files (absolute path), for example data_dir = /data/cassandra.

    data_dir in the [kafka] section.

    Define the directory for the Messaging Broker files (absolute path), for example data_dir = /data/kafka.

    truststore in the [ssl] section.

    (Optional) Truststore that holds SSL certificates.

    Provide an absolute path to the truststore file. Save the file in a permanent location on the Aternity Docker Components Server.

    Learn more

    truststore_password in the [ssl] section.

    (Optional) Password used to access the truststore.

    Learn more

    keystore in the [ssl] section.

    (Optional) Path to the keystore.

    Provide an absolute path to the keystore that holds the SSL certificate (typically a .jks file). Save the file in a permanent location on the Aternity Docker Components Server.

    The keystore is used to secure the Aternity REST API Server, Aternity Data Source for Portal, Raw Data Component, and Messaging Broker and must contain the appropriate certificate(s) for that. Providing a path to the keystore automatically sets the Aternity REST API Server and Aternity Data Source for Portal to work with HTTPS (SSL).

    Learn more

    keystore_password in the [ssl] section.

    (Optional) Password used to access the keystore.

    Learn more

    key_alias in the [ssl] section.

    (Optional) Alias that identifies the key in the keystore.

    key-password in the [ssl] section.

    (Optional) Password used to access the key in the keystore.

    cassandra_certificate_file in the [ssl] section.

    Provide the path to a .pem file that contains a certificate (no key), and is used to secure (SSL) connection to the Raw Data Component.

  6. Step 6 Once you defined all the parameters, save the properties.ini file.
  7. Step 7 (Optional) To verify that all prerequisites are properly installed, run the command sudo ./aternity-docker-admin verify-prerequisites
    Note that this command will automatically run during the installation, even you you skip the manual step.
  8. Step 8 (Optional) To verify that the Docker Components server can access other Aternity servers in your deployment, run the command sudo ./aternity-docker-admin verify-external-server-access
    Note that this command will automatically run during the installation, even you skip the manual step.
  9. Step 9 Navigate to the installer folder and run the installation command as root or sudo root: sudo ./aternity-docker-admin install

    This may take several minutes to complete. Wait for the setup to complete, with the status 100%.

    Check the status of the installation and wait until it completes
  10. Step 10 To verify that all components are up and running, view their status by entering the command sudo ./aternity-docker-admin status all

    It may take up to 30 seconds.

  11. Step 11 To troubleshoot and verify the state of the components, open in Aternity the System Health dashboard by going to the Gear Icon > Tools > Settings > System Health. Learn more.
  12. Step 12 To troubleshoot, stop all or some components by entering the command sudo ./aternity-docker-admin stop or sudo ./aternity-docker-admin stop <component name>
    Note

    Use additional commands of the Docker administration tool for troubleshooting and security deployment. You can see the full list of available commands and their usage by entering the command sudo ./aternity-docker-admin --help

    Command Usage Description

    start

    sudo ./aternity-docker-admin start

    sudo ./aternity-docker-admin start <component name>

    Starts the component.

    stop

    sudo ./aternity-docker-admin stop

    sudo ./aternity-docker-admin stop <component name>

    Stops the component.

    status

    sudo ./aternity-docker-admin status

    Shows the status for all components.

    restart

    sudo ./aternity-docker-admin restart

    sudo ./aternity-docker-admin restart <component name>

    Restarts the components.

    properties [show] or [reset-advanced]

    sudo ./aternity-docker-admin properties show

    sudo ./aternity-docker-admin properties reset-advanced

    Shows the properties of the installed components.

    Resets the properties of the installed components.

  13. Step 13 To secure access to the Docker Components, see Security in Aternity SaaS.
  14. Step 14 (Optional) To set passwords for the Docker Components, specifically for Raw Data Component, see Update Passwords in your Aternity Deployment.