Upgrade to Aternity on-premise 12.1

Update your Aternity on-premise for a significant step forward in new features and resolved issues.

Always check the sizing before updating. This version uses different database sizes, dashboard requirements and new servers. Learn more.

Update the Aternity components in the prescribed order.

Update Aternity in the correct order

Before you begin

Before upgrading Aternity on-premise:

  • You must start with a fully functioning deployment of Aternity on-premise 11.0.3 or later. If you have an older version, we recommend performing a fresh deployment or upgrading first to Aternity 11.0.3.

  • Check the correct sizing for your deployment before updating any of your Aternity servers. Learn more.

  • All devices must already report using a compatible version of the Agent for End User Devices. Learn more about deploying the Agent.

    Important

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

    Product Supported Agent for End User Devices
    Aternity 12.x

    Agent 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

  • For a complete list of files to download ahead of time (especially important for air-gapped networks), learn more.

    File Name Description Link for download

    Aternity OnPremise <version> (64-bit).zip

    Download the package that includes the setup of the following Aternity servers: Management Server, Aggregation Server, Data Warehouse Server. Vertica Database Server, Dashboard Gateway, Aternity Docker Components Server, TableauServer-2019-3-10-Aternity-64bit.exe for the Aternity Dashboard Server

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

    TableauServer-2019-3-10-Aternity-64bit.exe

    The Aternity Dashboard Server uses Tableau, a third party product, as its main engine. Only this exact version of Tableau works with Aternity 12.1.

    Tableau setup and administration require a user with administrator rights on the host Windows machine.

    Tip

    Air-gapped networks make offline Tableau setup very lengthy. You must upload and download several files in sequence as a challenge response. Tableau does not allow this in one action. We do not control their setup procedures.

    Additional Packages page of the Aternity Support Site

    Microsoft .NET for Dashboard Server

    Ensure this server has Microsoft .NET 3.5 (exactly) required for the database drivers, and .NET 4.5 or later, required for driver setup (both in parallel). To add .NET to a Windows Server, learn more.

    Search for these versions on the Microsoft Download Center.

    Chrony

    Synchronizes time and time zones between the Aternity components.

    If not included in your version of CentOS/RHEL, search for Chrony, and download the version for your Linux OS.

Procedure

  1. Step 1 Plan the strategy of your Aternity on-premise upgrade
    Considerations when planning your upgrade 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.

      For example, if the updated requirements for your sizing state you must have a new standalone Aggregation Server, you must use the custom update to remove the legacy embedded Aggregation Server from within the Management Server, then run the setup again on a standalone server to a fresh setup of a new Aggregation Server there.

      Remove an embedded component during upgrade, then run setup on a standalone server
    • Ensure you have an existing fully functional Aternity 11.0.3 or later before starting your upgrade.

      All devices MUST be reporting to Aternity using a supported Agent (11.0.x, 12.0.x or 12.1.x)

  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
  3. Step 3 Perform an upgrade to Vertica 10.0.1-9. Learn more.

    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.

  4. Step 4 (One week before upgrading Aternity) Prepare the Aternity Oracle Database Server for Aternity by verifying its configuration. Learn more.

    You must run the Aternity Database Verification Utility several times before and after updating the database (learn more).

    The verification may return a fatal error if the Aternity schema user does not have the MANAGE SCHEDULER privilege. To resolve, as the database's SYSTEM level user (who created the schema in the Aternity database), connect to Oracle Database and run the command: GRANT MANAGE SCHEDULER TO <db_aternity_user> This is mandatory for upgrading the Aternity Management Server. You can remove this privilege once the upgrade is completed.

  5. Step 5 Log in to the Aternity Docker Components Server and stop it before proceeding with update by entering the command from the aternity-docker-admin directory:
    $ sudo ./aternity-docker-admin stop
  6. Step 6 (For updates from 11.0.3 ) Update the Dashboard Server by removing the previous version of Tableau and then running the setup of the new version. Learn more.

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

    Update the Dashboard Server component (Tableau Server)
  7. Step 7 On the Dashboard Server, update the Dashboard Gateway component. Learn more.

    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.

    Update the Dashboard Gateway on the same computer as the Dashboard Server
  8. Step 8 Update the Aternity Management Server by running its express setup or custom setup over the previous version.

    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).

    If you previously had several Aternity components on this server, recheck the sizing, as you may need to create new standalone servers and remove legacy embedded components in this server.

    • If you are keeping the same topology or security, choose the express update, which keeps your legacy settings in the updated servers.

    • If you are changing your topology or security, choose the custom update.

    Remove an embedded component during upgrade, then run setup on a standalone server

    For example, if the updated requirements for your sizing state you must have a new standalone Aggregation Server, you must use the custom update to remove the legacy embedded Aggregation Server from within the Management Server, then run the setup again on a standalone server to a fresh setup of a new Aggregation Server there.

    Use the updated sizing to determine whether a component is embedded or standalone
  9. Step 9 Update the Aternity dashboard layouts from the Management Server. Learn more.

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

    Important

    Add the dashboard layouts ONLY from the Management Server.

    Add the layouts from the Management Server into the Dashboard Server via Dashboard Gateway
  10. Step 10 Update the 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.

    (Optional) Open the System Health dashboard and check the state of all Docker Components.

    The System Health dashboard displays the overall topology and health of your Aternity deployment.

  11. Step 11 (For deployments above 30,000 devices only) Run the express update or the custom update of a standalone Data Warehouse Server on its own computer, or create a new one.

    Create a new server only if changing the deployment size and the new size requires several servers that did not previously exist.

    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 only) Run the express update or the custom update of a standalone Aggregation Server on its own computer, or create a new one.

    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
  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 (Optional) Import the legacy translated MS Office activities from the backup file.

    Aternity on-premise version 11.x update rewrites the OOTB MS Office activities. As a result, if you localized them to your language, once version 11.x is up and running, you need to merge the translations into the updated OOTB MS Office activities. Prior to upgrade, the translated activities were automatically backed up to <Aternity_Home_folder>/monitorsBackup folder in the Management Server. The file name is Export_Microsoft_Monitors_{dd-MMM-yyyy-_HH_mm_ss}.zip where the date changes with the actual date and time of the backup.