Gateway Application Upgrade involves updating the Gateway software along with applying necessary OS patches and security updates without replacing the underlying appliance or server. This method retains your current infrastructure while bringing the application environment up to date.
Note
Gateway Application Upgrades are only supported for existing OpsRamp users and must be performed from a Gateway that is on version N-2 or later.
Users running versions older than N-2 must perform a Gateway Appliance Upgrade instead.
For example, if the current version (N) is 19.x.x:
N-1 = 18.x.x
N-2 = 17.x.x
Versions earlier than 17.x.x are not eligible for application upgrades and require a full appliance replacement.
Important Note
If you are not using the OpsRamp-provided ISO or OVA, the application upgrade will only update the Gateway application itself. It will not upgrade the Kubernetes cluster, apply OS-level package updates, or address security vulnerabilities related to the operating system or Kubernetes environment.Types of Gateway Application Upgrades
OpsRamp classifies Gateway application upgrades into two categories: Minor Upgrades and Major Upgrades, depending on the scope and impact of the changes.
- Minor Gateway Upgrade
A Minor Gateway Upgrade includes lightweight updates that typically involve:- Bug fixes
- Performance optimizations
- Security patches
- Minor enhancements
These updates are designed to improve the stability and efficiency of the Gateway without requiring significant changes to configuration or functionality. Minor upgrades are low-risk and can usually be performed without downtime or system reconfiguration.
- Major Gateway Upgrade
A Major Gateway Upgrade introduces substantial changes that may include:- New features and capabilities
- Structural or architectural changes
- Support for new integrations or technologies
- Core system and configuration updates
These upgrades may impact the Gateway’s behavior, requiring additional testing, reconfiguration, or validation. OpsRamp provides all necessary installation files, ISO, OVA, and Bootstrap Tool to facilitate major upgrades.
Note
Major upgrades often include kernel-level and OS library patches, particularly when using OpsRamp-supplied ISO or OVA packages.Accessing Upgrade Files
To download upgrade files such as ISO, OVA, and the Bootstrap Tool, refer to the respective download documentation.
- ISO
- OVA
- Bootstrap Tools
Info
For the existing OpsRamp Users, both Minor and Major Gateway Upgrades can be initiated directly from the OpsRamp Web UI, providing a streamlined and centralized management experience.Prerequisites for Gateway Upgrades
Before performing any upgrade (minor or major) from OpsRamp UI, ensure the following:
- The Gateway is up and running.
- It is successfully communicating with the OpsRamp cloud.
- You have the necessary permissions to perform the upgrade.
Refer to the Permissions document for more details on obtaining the necessary permissions.
How to Perform Minor/Major Update on Existing Gateways
Step 1: Log in to the OpsRamp Portal.
Step 2: Navigate to Setup > Accounts > Collector Profiles.
Step 3: From the list of available collector profiles, select the profile you want to update.
Step 4: Click the Action button on right side top of profiles.
Step 5: From the update options, choose one of the following:
| Option | Description |
|---|---|
| Update Now | Immediately triggers a Gateway update. Select the desired profile and click Update Now. The update will begin instantly, and the Gateway will be updated within minutes. |
| Update on Schedule | Schedules the Gateway to check for updates every 6 hours. If a new version is available, it will be automatically downloaded and applied. |
| Do Not Allow | Disables updates for the selected Gateway. Use this option to prevent automatic or manual updates. |
| Reconnect Tunnel | Re-establishes the connection tunnel between the Gateway and OpsRamp. Useful for resolving connectivity issues or refreshing the connection. |
What Happens During the Update
An update request is sent to the selected Gateway based on the chosen update method.
If Update Now is selected:
- An on-demand job is triggered within the Kubernetes cluster.
- This job initiates the required pods to perform the update immediately.
- The Gateway is upgraded to the latest available version.
If Update on Schedule is selected:
- A scheduled job is created, which checks for available updates every 6 hours.
- Once an update is detected and successfully applied, the scheduled job is automatically removed.
- The Gateway is upgraded without manual intervention during one of these scheduled checks.
- The Gateway is upgraded to the latest available version.
Note
After upgrading the Gateway, restart the Gateway VM to ensure the new kernel is active. This step is required for kernel updates to take effect and will also resolve any kernel security vulnerabilities.Troubleshooting
Refer to the Troubleshooting guide if the Gateway version fails to update in the OpsRamp portal.