Resource Toolkit: Prepare to install or upgrade Orion Platform products
Use the following resources to plan your installation or upgrade and to prepare your environment.
Check out this 6:33 minute video, SolarWinds Lab Bits: Everything You Need to Know Before Installing Orion (published May 29, 2018).
Use this checklist to verify product requirements before you get started. The Orion Installer will alert you to warning or critical level requirement issues during the System Check.
|Installation and upgrade checklist|
Review product release notes:
Use the following links and the multi-module environments guidelines to make sure your environment has all of the required hardware and software.
See URLs used by the Orion Platform for a list of URLs to add as exceptions to your firewall.
Review licenses, gather keys, and review maintenance status.
Review your product licenses and maintenance status and determine if you need to make any changes. You can download license keys for your new Orion Platform products through the Customer Portal. Discuss license upgrades with your SolarWinds account manager or contact SolarWinds.
Make sure you have all account credentials, Orion Platform database credentials, your SolarWinds account, and local admin server credentials.
Considerations for upgrades
The following situations can affect your upgrade process.
Do you need to migrate?
If product requirements have changed, you might need to migrate products and databases to new dedicated servers before you can upgrade to the latest version. Determine whether you need to migrate by reviewing new product requirements, performance, and company needs.
Migrating adds time to your upgrade, but upgrades provide a good opportunity to update your environment. See the Migration Guide for more information.
Do you have products out of maintenance?
If you have a product that is out of maintenance (that is, the license has expired), the Orion Installer upgrades the product to the latest version that became available before maintenance expired and is compatible with other installed products.
Be aware that having an out-of-maintenance product can prevent you from upgrading products that are currently under maintenance. This occurs when the out-of-maintenance product is not compatible with the latest version of the Orion Platform.
Example: You have IPAM out of maintenance. You want to upgrade NPM to the latest version. Upgrading NPM would also upgrade the Orion Platform. However, your version of IPAM is incompatible with the latest version of the Orion Platform. The installer reports the issue and suggests resolutions, but it does not allow you to upgrade NPM until the issue is resolved.
Do you have product versions that cannot be upgraded by the Orion Installer?
If you have legacy product versions that are not supported by the Orion Installer, the installer runs a system check that provides a full upgrade path for legacy products. Use the links supplied in the system check details to download legacy installers for the versions you need. See Upgrade older versions of Orion Platform products for details.
Prepare for an upgrade
Schedule the upgrade.
Set up the maintenance window, preferably during off-peak hours. Depending on the number of products, size of database(s), and size of environment, you might need several hours to complete your installation.
If you upgrade or install new Orion Platform products into an existing Orion Platform installation, all SolarWinds services and polling must be offline for a length of time, causing you to lose a portion of polled data.
|Notify your company of the upgrade schedule and maintenance window.|
Back up your database and snapshot your VMs.
Back up your SolarWinds Orion database. If you need help, check your vendor's site for instructions. If you'd like to use SolarWinds Backup, click here for information.
If your Orion server is on a virtual machine, create a snapshot or copy of your VM.
You cannot roll back an upgrade. Always back up your database.
If you have written custom code, back it up.
Prepare the servers
Depending on your licensed Orion Platform products, you might need to prepare multiple servers and configure ports in your firewall before installation.
|Server preparation checklist|
Prepare servers for your Orion Platform products and deployment:
For upgrades, be aware of changes to server and other requirements. For example:
Run all Microsoft Windows updates.
Before installation, check for and run any Windows Updates on all servers. If a Windows update runs during the installation, your system might reboot. The installation cannot complete if your system is waiting to reboot.
Open required ports.
Open the ports required by your products and any additional features you have enabled. For example, SolarWinds High Availability has additional port requirements beyond product needs. The Orion Platform uses these ports to issue management commands and to send and receive data.
Exclude files from anti-virus scans.
To ensure a smooth installation and optimal product performance, exclude specific file paths and directories from anti-virus software scans. See Files and directories to exclude from antivirus scanning.
Gotchas for Orion Platform products
Be aware of the following changes or considerations that frequently affect installations or upgrades. For information about product-specific issues that could affect upgrades, see your product's release notes.
Installing Orion Platform products and Access Rights Manager (ARM) on the same server causes a conflict with the RabbitMQ service. To avoid this, ARM and Orion Platform products must be installed on separate servers. Note that ARM is not an Orion Platform product.
Carefully review the port requirements for your products. Incorrect ports can cause communication and polling issues. See the Port requirements for all SolarWinds products for details.
If Patch Manager is part of your environment, SolarWinds recommends upgrading to version 2.1.5 or higher before running the Orion Installer.
If you have NTA 4.2.3 or earlier, SolarWinds does not recommend performing an upgrade. Instead, uninstall the earlier version and then install the current version. Because of a change in the type of database used as the Flow Storage Database, flow data cannot be migrated during an upgrade. For more information, see this article.
If you are running NTA 4.2.3 or earlier, you cannot upgrade other Orion Platform products to the current version. You must install or upgrade to the current version of NTA with a SQL Server Flow Storage Database.
- If you do not already have Orion Platform products installed, see Install Orion Platform products in a new environment.
- To install new products into an existing Orion Platform deployment, see Install or upgrade products in an existing Orion deployment.
- To upgrade products that run on Orion Platform 2019.2 or later, see Perform a centralized upgrade of the primary Orion server and all scalability engines.
- To install additional products for evaluation without upgrading, see Install evaluation products or hotfixes without upgrading existing Orion Platform products.
- To upgrade legacy products not supported by the Orion Installer, see Upgrade older versions of Orion Platform products.