Upgrade to Aternity on-premise 11

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 in this procedure.

Update Aternity in the correct order
Note

If you performed the data migration from your older (existing) version deployment, then you have already completed some of the instructions in this article. If so, ignore them and continue with those you still need to perform. If you decided not to migrate the stored data from the currently installed version, then perform all steps described in this article.

Before you begin

Before upgrading Aternity on-premise:

  • Before upgrading Aternity to version 11.x, we recommend migrating the data stored in the currently installed version. In this case, when you open Aternity version 11.x for the first time, your historical data will show in the dashboards. Without data migration, all dashboards that use a new data schema will be empty after the upgrade. They will be fully populated with data in a month after upgrading to Aternity 11.x (the default retention of hourly aggregated data in Vertica is 31 days). Learn how to migrate the data from version 9.x or from version 10.x, depending on your original version from which you upgrade to version 11.x

  • You must start with a fully functioning deployment of Aternity on-premise 9.x or 10.x. If you have an older version, we recommend performing a fresh deployment.

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

  • Ensure that the Aternity user has the MANAGE SCHEDULER privilege in the Oracle database. Learn more.

  • Before starting the upgrade, stop the migration tool (ETL). On the data migration Linux host, execute the following command to delete the migration cron jobs: crontab -r -u <dedicated_linux_user>. Not stopping the migration tool may prevent the upgrade from completing successfully.

  • 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 11.x requires that devices ONLY run Agent for End User Devices 9.0, 9.1.7, 9.2.x, or Agent 11.0.

    Product Supported Agent for End User Devices
    Aternity 11.x

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

    Aternity 10.x

    Agent 9.0.x, 9.1.7 or 9.2.5 ONLY.

    Aternity 9.x

    Agent 9.0.x ONLY.

  • 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-10-4-9-Aternity-64bit.exe for the Aternity Dashboard Server

    Download the latest Aternity on-premise's main setup package from the Riverbed support site by selecting Software (size) (learn more).

    TableauServer-10-4-9-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 11.x.

    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.

    Useful Links section of the Riverbed 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
    • Aternity 11.x arranges its servers in a slightly different way, with smaller requirements for most legacy components and a new server for Docker components.

    • Since all components in v11 reside in the new Docker Components server, several servers for standalone components used in v10 have been removed from v11, such as ETL, standalone Aternity REST API Server and Aternity Data Source for Portal.

    • Ensure you have an existing fully functional Aternity 9.x or 10.x before starting your upgrade.

      All devices MUST be reporting to Aternity using Agent 9.x or 11.

  2. Step 2 Download the latest Aternity on-premise's main setup package from the Riverbed support site by selecting Software (size) (learn more).

    The setup package is for all Aternity servers.

    Download Aternity on-premise from the website

    There are also entries in the Useful Links section which are required for database setup.

  3. Step 3 (For updates from Aternity 9.x only) Set up a single new Aternity Vertica Database Server or a cluster of Vertica Database Servers.

    (For updates from Aternity 10.x only) Perform an upgrade to Vertica 9.1.1. Learn more.

    Note

    (For updates from Aternity 11.0.0 and 11.0.1 only) Do NOT make any change to Vertica 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. (If you performed the data migration process, then your Vertica Database Server is already up and running.)

  4. Step 4 Perform data migration procedure before upgrading Aternity servers. Learn how to migrate the data from version 9.x or from version 10.x.

    For updates from Aternity 11.0.0 and 11.0.1, data migration is NOT required.

    Migrate database from older version to version 11.x
  5. Step 5 (One week before upgrading Aternity) Prepare the Aternity Oracle Database Server for Aternity by verifying its schema. Learn more.

    Aternity 11.x requirements for the version of Oracle are the same as Aternity 9 and 10. Therefore it is not necessary to change the Oracle version for this upgrade. In addition, Aternity 11.0.0/11.0.1 support Oracle version 12.2.0.1 and Aternity 11.0.2 supports also Oracle version 18c.

    Use the Aternity Database Verification Utility to prepare for Aternity 10

    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.

  6. Step 6 (For updates from Aternity 10.x only) Remove version 10.x Aternity ETL Server (it is not part of version 11 architecture, learn more).
    Connect to the Aternity ETL Server as a user with root or sudo root privileges. To verify, enter sudo id. Execute the following command to delete all cron jobs:
    crontab -r -u <dedicated_linux_user>
    Note

    Note that this command deletes all cron jobs associated with the dedicated user.

  7. Step 7 Remove the migration ETL tool.
    Connect to the server as a user with root or sudo root privileges. To verify, enter sudo id. Execute the following command to delete all cron jobs:
    crontab -r -u <dedicated_linux_user>
    Note

    Note that this command deletes all cron jobs associated with the dedicated user.

  8. Step 8 (For updates from Aternity 10.x only) Remove version 10.x Aternity REST API Server and Aternity Data Source for Portal, either by removing the machines completely or just shutting down the Docker containers that run them.

    Stop and remove Aternity REST API Server by running the command docker stop AOdata and then docker rm AOdata.

    Stop and remove Aternity Data Source for Portal by running the command docker stop AternityDataSource and then docker rm AternityDataSource.

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

    For updates from Aternity 11.0.0 and 11.0.1, do NOT make any change to the Tableau server.

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

    Update the Dashboard Server component (Tableau Server)
  11. Step 11 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
  12. Step 12 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 keep 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
  13. Step 13 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
  14. Step 14 Access Aternity to add your new serial number and purchased licenses.
    Enter your new serial number and license volume

    Select the Gear Icon > License Provisioning > Edit Licenses.

    If it displays an existing serial number, select it. Otherwise select Add License. Enter your new number and license volume.

  15. Step 15 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.

    (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. Learn more.

  16. Step 16 (For deployments above 40,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.

    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.

  17. Step 17 (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
  18. Step 18 (For updates from Aternity 10.x only) Once the Aternity Docker Components Server is installed, update the base URL to use to access those servers that ran on the dedicated computers in old versions, but in version 11.x they run on the Aternity Docker Components Server (such as Aternity Data Source and Aternity REST API Server).
    For example, login to Portal and update the base URL to use to access the Aternity Data Source because it now resides on a different host computer.
  19. Step 19 (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.

  20. Step 20 (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.

  21. Step 21 Browse the Aternity dashboards.
    Dashboards Description

    Existing dashboards with data from the old version

    Following data migration, when you open Aternity version 11.x for the first time, your historical data will show on dashboards.

    Existing dashboards without data from the old version

    Without data migration, the dashboards that use a new data schema will open empty. They will be fully populated with data in a month after installing Aternity 11.x.

    New dashboards that did not exist in old versions at all

    New dashboards that did not exist in previous versions initially appear empty and will be fully populated with data in a month as new data flows in from devices.