Install or upgrade products in an existing Orion deployment

Complete the following tasks as needed to install additional Orion Platform products into an existing Orion deployment, or to upgrade existing products.

When you install new products in an existing Orion Platform deployment, you might also need to upgrade existing products.

Use this procedure if any of the following conditions apply to your environment:

  • You are installing additional products into an existing Orion deployment.
  • You are upgrading products that run on Orion Platform 2018.4 or earlier.
  • You are upgrading products in an offline environment.

If your products run on Orion Platform 2019.2 or later in an online environment, you can perform a centralized upgrade of your entire Orion deployment.

If you do not have existing Orion Platform products installed, see Install Orion Platform products in a new environment

If you are upgrading, SolarWinds recommends testing the upgrade in a test or staging environment. You cannot roll back an upgrade after it is complete.

Before you start

Use the information in this topic to prepare for your installation or upgrade. Use the checklists to prepare your environment, and review the list of "gotchas".

Task 1: If you are upgrading with HA, disable the HA pool

The HA pool must be disabled to upgrade. If you upgrade without disabling it, the pool is automatically disabled.

  1. In the Orion Web Console, click Settings > All Settings.
  2. Under Product Specific Settings, click High Availability Deployment Summary.
  3. Select the pool you want to disable.

  4. Toggle High Availability to Off.

Do not modify the VIP, IP address, or virtual host settings for the servers.

Task 2: If you are upgrading, stop services

If the required SolarWinds services are not stopped before the upgrade, the Orion Installer attempts to stop them. To ensure a smooth upgrade, SolarWinds recommends that you stop the required services before upgrading.

  1. In the Orion Web Console, click Settings > All Settings.
  2. Under Product Specific Settings, click Orion Service Manager.
  3. Stop all services listed in the Orion Service Manager on the main polling engine, all additional polling engines, and all web servers.

If you use the Windows Control Panel to stop services, do not stop the SolarWinds Administration Service on your scalability engines. If you stop the SolarWinds Administration Service, the installer cannot reach the scalability engines to upgrade them in parallel.

Services are restarted automatically when the upgrade is complete.

Task 3: Get the installer

  1. Log in to the Customer Portal.

  2. Under Latest Downloads for Your Products, locate one of your Orion Platform products and click Choose.

    In most cases, you need to download only one product module, even if you plan to install or upgrade multiple products.

    To install the DPA Integration Module without SolarWinds SAM, you must download the DPAIM installer. Other product installers do not include DPAIM in the list of products. See DPAIM installation options.

  3. Click Download to download either the online or offline installer:
    • Online: Use this option if your Orion server has internet access. This option guarantees that you have an up-to-date installer with the latest optimizations and fixes. It is the most efficient option, because it downloads only what it needs and nothing more.

      Also use online installation to install a scalability engine, even in environments without Internet access. Installing a scalability engine doesn't require Internet access. See Install an Additional Polling Engine, Additional Web Server, or HA server for details.

    • Offline:  Use this option for installations without Internet access. The offline installer is a prepackaged file that includes everything you need for a large combination of dependencies and products.
  4. Save the installer on your Orion server.

Task 4: Run the installer on the primary Orion server

Some third-party software, such as .NET 4.8, is required. If it is not found on the server, it is downloaded and installed when you run the installer.

  1. Run the installer .exe file on your primary Orion server as Administrator.

    The Select Products page lists the products that you can install and any existing products that will be upgraded.

    Not sure what these release acronyms mean?

    • HF = Hotfix
    • RC = Release Candidate
  2. Select the products to install, and click Next.

    Existing products that will be upgraded are also listed. You cannot deselect items from this list. The installer must ensure all versions of your products are compatible.

    The System Check page asks you to confirm that you backed up your database.

  3. Under System Check Confirmations, click Choose how to proceed. If you have backed up your database, select Confirm and then click Confirm.

    If not, you should back up now. New products and versions can modify your database tables. Click here for information about SolarWinds Backup.

  4. On the System Check page, review the information under System Check Results.

    The installer runs a series of checks per product to verify that your server meets system requirements and recommendations. If your environment does not meet specifications, the installer displays one or more messages:

    • Informational and warning messages recommend actions and best practices to optimize performance. These do not block the installation.
    • Critical issues describe changes that are required to support the products. These block the installation until they are resolved.
    1. Investigate and resolve any issues:

      • Click the details link to display additional information and suggested resolutions.

      • Optionally, click Save Report to save the list of issues.
      • After resolving any blocking issues, click Run Checks Again.
    2. Click Next.
  5. Review the EULA. If you agree, click I accept, and then click Next to begin the installation.

    The Installation page displays progress messages. If the installer encounters any issues, the installation stops so you can resolve them. The installer might run multiple product installations before running the Configuration wizard.

    If a reboot is required as part of the installation, a message is displayed.

Task 5: Complete the Configuration wizard

If database configuration is required, the Configuration wizard automatically opens. Depending on your products, the wizard might include options and pages not described here.

  1. On the Welcome page, click Next.
  2. If prompted to stop services, click Yes.
  3. If you performed a Standard installation with an existing SQL Server database, select one of the following for authentication:
    • Authenticate as currently logged in user: Pass through authentication to the database server using the account currently logged in for installing the Orion Platform product.

    • Switch user: Provide credentials automatically detected as either SQL or Windows credentials, allowing Windows authentication for the initial setup even if the Orion server is not joined to a domain or the current account does not have permissions to the database server.

    If you intend to use Windows authentication for the Orion Platform, remember to exempt that user account from any password change policies. An expired password will cause the Orion Platform to stop data collection and interrupt Orion Web Console access.

  4. On the Database Settings page, select your existing Orion database, or create a new database for a new installation, and click Next.
  5. On the Database Account page, create an account or specify an existing account that the polling engine and Orion Web Console will use to access the database. The account can be a Windows or SQL Server account.

  6. On the Website Settings page:
    1. Select All Unassigned unless your environment requires a specific IP address for the Orion website. If SSL is selected, port 443 is used. Otherwise, port 80 is used.
    2. Specify the Port and the Website Root Directory where the system installs the web console files.

      If you specify any port other than 80, include that port in the URL used to access the Orion Web Console.

    3. To configure SSL, click Enable HTTPS and select your SSL certificate.

      If a certificate is not available, select the option to Generate Self-Signed Certificate. The Configuration wizard automatically generates a self-signed certificate issued to the hostname or FQDN and adds it to the trusted certificate store.

      If you select Skip website binding, the Configuration wizard does not make changes within the website configuration in your IIS. This option prevents IP address, port, and SSL certificate options.

  7. If prompted to create a directory or website, click Yes.
  8. Review the list of services to install, and click Next.
  9. Click Yes if prompted to disable the SNMP Trap Service and enable the SolarWinds Trap Service.
  10. On the Completing the Orion Configuration Wizard page, click Next.
  11. When the configuration is complete, click Finish to launch the Orion Web Console.

    If the Orion Web Console doesn't open automatically (for example, if it times out before opening), do one of the following to open it manually:

    • Click Start > All Programs > SolarWinds > Orion Web Console.

    • Open a web browser on your Orion server and enter http://ipAddress or http://hostname, where ipAddress is the IP address of your server and hostname is the host name of your server. This is https:// if SSL was selected.

Task 6: Upgrade scalability engines

If you don't have any scalability engines (additional polling engines, additional Web servers, or high availability backup servers), skip this section.

If you have scalability engines, complete the following steps to perform a centralized upgrade, which upgrades all reachable scalability engines in parallel. If you cannot upgrade one or more scalability engines through a centralized upgrade, you can upgrade them individually.

Do not stop the SolarWinds Administration Service on your scalability engines before the centralized upgrade. If you stop this service, the scalability engines are not reachable.

  1. Access the Orion Upgrade Wizard:

    • If you left the Launch Orion Web Console option selected on the last step of the Configuration Wizard, the My Orion Deployment page opens and launches the Orion Upgrade Wizard.

    • If you deselected Launch Orion Web Console:

      1. Log in to the Orion Web Console.

      2. Click Settings > My Orion Deployment.

      3. Click the Updates Available tab.

        The Orion Upgrade Wizard opens.

  2. Review the information on the Welcome page, and click Check Readiness.

    The wizard attempts to contact all scalability engines, and determines whether updates are needed.

    If any scalability engines are unavailable, a message tells you which server cannot be reached. Click Start Preflight Checks for additional information about the issue. You can either:

    • Fix the issue now and restart the wizard.
    • Continue upgrading other scalability engines now and upgrade that scalability engine later.
  3. If scalability engines are reachable and need updates, click Start Preflight Checks.

    As on the main server, the installer runs a series of system checks to verify that each scalability engine meets the system requirements.

  4. If any issues are found:
    1. Click the details link to display additional information and suggested resolutions.
    2. Optionally, click Save System Check Results to save the list of issues.
    3. Resolve any blocking issues.
    4. Click the Back button, and then click Start Preflight Checks to run the system checks again.
  5. When you are ready to upgrade, click Start Upgrade.

    The Orion Installer copies the installation file to all scalability engines, and then upgrades and configures them.

    The RDP link is available in case you need to connect to the scalability engine and correct an issue.

    After each successful upgrade, the Orion Upgrade wizard on your main server displays the message Upgrade complete.

  6. When all upgrades are complete, click Finish.

Task 7: Upgrade Orion Agents

If the Allow automatic agent updates setting is enabled (default option), the Orion Agents are automatically upgraded in the background. Agents are tied to their release version. You can skip manually upgrading agents if the option is enabled.

To enable the option to allow automatic agent updates:

  1. Click Settings > All Settings.
  2. Under Product Specific Settings, click Agent Settings.
  3. Click Define Global Agent Settings, and select Allow automatic agent updates.

The upgrades take some time to complete but do not require any actions. Agents are upgraded at a throttled number of 10 at a time to limit the impact on the polling engine. As soon as one agent upgrade is complete, another agent takes its place so there are always 10 active threads until all agents are upgraded.

If automatic upgrades are disabled, upgrade the Orion Agents:

  1. Open the Manage Agents page. Orion Agents requiring upgrades display the message Update Required.
  2. Select all agents needing updates and click More Actions > Update. The agents are upgraded in the background.

Task 8: If you are upgrading with HA, enable the HA pool

When the installation is complete, enable the HA pool using the following instructions. You might need to recreate the HA pool.

  1. In the Orion Web Console, click Settings > All Settings > High Availability Deployment Summary.
  2. Select the pool you want to enable.
  3. Toggle High Availability to On.

The Orion Web Console verifies all SolarWinds product versions match across the HA pair before enabling. If you receive errors, check your product versions.

Task 9: For new installations, activate licenses

If you have installed new products, activate your licenses.

Get the license key for your product from the Customer Portal. You might need multiple licenses: one for each product, HA, Additional Polling Engine, and Additional Web Server.

  1. In the Customer Portal, select License Management.
  2. Select the product.
  3. Copy the license key.

Add and activate the license key using the web-based License Manager in the Orion Web Console.

  1. Open the Orion Web Console in a web browser.
  2. Click Settings > All Settings > License Manager.
  3. Click Add/Upgrade License.
  4. Enter the Activation Key and Registration Information, and click Activate.

To activate an offline license, see Activate licenses offline.