Install Aternity on-premise 12.0

This article provides a general and complete workflow for installing a fresh Aternity on-premise. Each step includes a link to the detailed procedure of that step.

Perform the server install of a fresh Aternity on-premise deployment where each component has its own dedicated computer in larger deployments, or you can combine several components on the same computer for smaller deployments. The components of the Aternity on-premise solution are:

Order for installing Aternity on-premise components
Field Description
Aternity Oracle Database Server

The Aternity Oracle Database Server is an Oracle database which hosts the Aternity system settings, data model and performance data.

Aternity Vertica Database Server

The Aternity Vertica Database Server stores the performance data in the Vertica format, which is most efficient for displaying in Aternity dashboards.

Aternity Dashboard Server

The Dashboard Server displays Aternity's intuitive dashboards using Tableau as its engine.

Aternity Dashboard Gateway Server

The Dashboard Gateway acts as the interface between the Dashboard Server and the Aternity Management Server, performing background tasks like preprocessing the data for display in the dashboards, and maintaining logs, audits and cleanup. It must be on the same computer as the Dashboard Server. While it has no user interface of its own, it is crucial to the proper functioning of Aternity.

Aternity Management Server

The Aternity Management Server acts as Aternity's central server, which manages and integrates all the components. When users access Aternity to view the dashboards or configure it, they access this server via a browser.

Aternity Data Warehouse Server

The Data Warehouse Server stores the raw data gathered from the Aggregation Servers, and aggregates (summarizes) it for the Oracle Database Server and the Aternity Vertica Database Server. It constantly aggregates and re-summarizes data in the main database in the background, replacing older, more detailed data with summary data as it ages. Therefore older data typically has limited drill-down capabilities.

Aternity Aggregation Server

An Aggregation Server gathers (aggregates) the data directly from Agent for End User Devices on monitored devices, and passes it on to the Management Server.

Aternity Docker Components Server

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.

Agent for End User Devices

The Agent for End User Devices monitors end user experience by measuring device and application performance. It is a small background utility which runs on each monitored device, and reports its data to the Aternity Aggregation Server.

You must install the Aternity components in the prescribed order in this procedure.

Tip

See the new features of Aternity.

Procedure

  1. Step 1 Plan the strategy of your new Aternity on-premise installation:
    Considerations when planning your installation of Aternity on-premise
    • Decide on the size of your deployment, based on the number of devices to monitor. This directly determines the number of servers you need, and their hardware specifications.

      Important

      If your sizing requires that you deploy more than one dedicated Aternity Aggregation Server, you must deploy a third party load balancer (LB). Then configure the Agent for End User Devices of all devices to point to the LB's virtual IP address (learn more). Configure the LB with persistent (sticky) sessions to ensure the Agent maintains its connection with the same server. Aternity also supports sticky sessions when the LB implements stickiness via cookies.

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

    Sign in to Aternity Support Site, then go to Product Downloads > Aternity Server > Version and select the required version to download. Note that only logged in users with certain permissions can see the download option.

    The setup package is for all Aternity servers.

    Download Aternity on-premise from the website
    There are also entries in the Additional Packages which are required for database setup and others:
    • Tableau Package

    • Oracle Packages

    • Install Scripts

    • DB Schema Scripts

    Refer to Additional Packages for the necessary Oracle images and other setup packages.
  3. Step 3 Install the Aternity Oracle Database Server on a dedicated computer:
    Use Oracle 19.0.0.0 or 18.0.0.0 or 12.2.0.1 or 12.1.0.2 or 11.2.0.4 (including support for Oracle Data Guard), specifically:
    • Oracle Database version 11.2.0.4 Enterprise Edition 64-bit

    • Oracle Database version 12c Enterprise Edition 64-bit, 12.2.0.1 or 12.1.0.2

    • Oracle Database version 18c Enterprise Edition 64-bit, 18.0.0.0

    • Oracle Database version 19c Enterprise Edition 64-bit, 19.0.0.0

    Use the express database setup for a fast, easy, small installation
  4. Step 4 Run the Aternity Database Verification Utility for a fresh installation to ensure the database's internal structure and naming is fully compliant with Aternity's requirements.
    Use the Aternity Database Verification Utility to ensure the database is ready for Aternity 12.x
  5. Step 5 Install a single Aternity Vertica Database Server or a cluster of Vertica Database Servers.

    Vertica is a third-party column-store database optimized for large volume data analytics. The Aternity Vertica Database Server stores the performance data in the Vertica format, which is most efficient for displaying in Aternity dashboards. It receives its data from the Aternity Docker Components Server.

    The number of Vertica Database Servers and their software requirements depend on the sizing of your deployment and your level of high availability and redundancy.

    Learn more about installing a single Vertica Database Server or a cluster of servers.

  6. Step 6 On a separate computer, install the Aternity Dashboard Server.

    The Dashboard Server displays Aternity's intuitive dashboards using Tableau as its engine.

    Install the Dashboard Server and Dashboard Gateway on the same computer
  7. Step 7 On the Dashboard Server, install the Aternity Dashboard Gateway Server.

    The Dashboard Gateway acts as the interface between the Dashboard Server and the Aternity Management Server, performing background tasks like preprocessing the data for display in the dashboards, and maintaining logs, audits and cleanup. It must be on the same computer as the Dashboard Server. While it has no user interface of its own, it is crucial to the proper functioning of Aternity.

    Add the Dashboard Gateway to the Dashboard Server computer
  8. Step 8 On another computer, install the Aternity Management Server.

    To setup the Aternity Management Server, you must register with Aternity's online activation form. Enter your contact details and serial number to send an activation key to your email (learn more).

    You can add more components on the Management Server computer for smaller deployments:

    Install further components on the same Management Server computer for small or medium deployments
  9. Step 9 Install the Aternity dashboard layouts from the Management Server, which plants them in the Dashboard Server via the Dashboard Gateway.

    The Aternity dashboard layouts contain the names, calculations and layouts of the system's dashboards for this Aternity version.

    Install the layouts from the Management Server into the Dashboard Server via Dashboard Gateway
  10. Step 10 Install Aternity Docker Components Server that includes various Aternity components, mandatory and optional. Learn more.
    Secure communication between Docker Components and other Aternity servers. Learn more.
  11. Step 11 (For deployments above 30,000 devices) Install a standalone Aternity Data Warehouse Server.

    The Data Warehouse Server stores the raw data gathered from the Aggregation Servers, and aggregates (summarizes) it for the Oracle Database Server and the Aternity Vertica Database Server.

  12. Step 12 (For deployments above 1,000 devices) Install a standalone Aggregation Server.

    One Aggregation Server is required per 40,000 devices.

    An Aggregation Server gathers (aggregates) the data directly from Agent for End User Devices on monitored devices, and passes it on to the Management Server.

    As your deployment grows in size, add more identical Aggregation Servers (see deployment sizing for details). If your sizing requires that you deploy more than one dedicated Aternity Aggregation Server, you must deploy a third party load balancer (LB). Then configure the Agent for End User Devices of all devices to point to the LB's virtual IP address (learn more). Configure the LB with persistent (sticky) sessions to ensure the Agent maintains its connection with the same server. Aternity also supports sticky sessions when the LB implements stickiness via cookies.

    Aggregation Server collects and consolidates data from monitored devices

    Aternity is installed with local usernames in the format of email addresses. To verify, login to Aternity, select the Gear Icon > Settings > Advanced Settings > security > userInEmailFormat and make sure it is set to Yes. It is important to integrate an email server. Configure the connection of your Aternity on-premise to your enterprise email server, as the route to send automatic email notifications. Learn more.

  13. Step 13 (Optional) To view Aternity data in SteelCentral Portalâ„¢ connect the Aternity Data Source to 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.

  14. Step 14 To manage the number of monitored devices reporting to Aternity, configure licenses.
  15. Step 15 Add devices as monitored devices which report their performance to Aternity, by installing the Agent for End User Devices.
    Important

    Aternity on-premise 12.x requires that devices ONLY run Agent for End User Devices 9.0, 9.1.7, 9.2.x, 11.0.x, 12.0.x or Agent 12.1.x.

    Product Supported Agent for End User Devices
    Aternity 12.x

    Agent 9.0, 9.1.7, 9.2.x, 11.0.x, 12.0.x or Agent 12.1.x

    Aternity 11.x

    Agent 9.0, 9.1.7, 9.2.x, or Agent 11.0.x

    Aternity 10.x

    Agent 9.0.x, 9.1.7, 9.2.5 or 9.2.6.

    Aternity 9.x

    Agent 9.0.x ONLY.

    Add the Agent on devices to report their performance to Aternity
  16. Step 16 (Optional) Enable Product Tours in the Help menu.

    In Air-gapped networks, after installation, check the connection settings. In case there is no internet connection, the features that require internet will be disabled (Product Tours should then be set to work offline, the maps will not show). In the Help menu, check the server settings under the Gear Icon > aternity/account/hasInternetConnection/. By default, browser is set to Yes and server is set to No. Adjust the settings to the actual topology of your organization. For example, if only the browser has internet connection and the server does not have it, make sure to set browser to Yes and server to No under aternity/account/hasInternetConnection/. Note that Product Tours will work if your browser is set to Yes, and maps in dashboards will work if the server is set to Yes.