This page provides step-by-step instructions for deploying the OpsRamp NextGen Gateway as a virtual machine (VM) on supported hypervisors using the OpsRamp-provided OVA.

About OpsRamp NextGen Gateway OVA

The OpsRamp NextGen Gateway OVA is a pre-configured, bootable image based on Ubuntu/Linux. It includes:

• A lightweight Kubernetes distribution (K3s) for orchestrating Gateway components.
• The OpsRamp Collector Bootstrap Tool, which automates the installation and registration of the Gateway.
• Pre-packaged scripts and configuration utilities to streamline setup.

Prerequisites

Before deploying the NextGen Gateway virtual machine using the OpsRamp-provided OVA, ensure that your environment meets all the necessary requirements to support a successful installation and connection to the OpsRamp Cloud platform.

1. Supported Hypervisor and Helm Versions
   For detailed information, refer to the Support Matrix document.
   
   
2. System and Server Requirements
   Verify that your infrastructure meets the minimum hardware and software specifications required to run the NextGen Gateway VM.
   For detailed information, refer to the server requirements document.
   
   
3. Network Access and Whitelisting
   To ensure seamless communication between the Gateway and the OpsRamp SaaS platform:
   • Whitelist the required IP addresses and URLs in your firewall or security group settings.
     
   • For the complete list of domains and endpoints, refer to the IP Whitelist documentation.
     
     
4. Proxy Configuration (Optional)
   If your organization uses a proxy server to control outbound traffic for security or compliance reasons:
   • You must configure proxy settings at the node level by editing the /etc/environment file on the Gateway VM.
   • This ensures that all outbound requests from the Gateway (including registration and tunnel connectivity) are routed through the proxy.
   • For detailed setup steps, see the Proxy Configuration document.

Step 1: Download the NextGen Gateway OVA

To download the NextGen Gateway OVA, follow the steps below:

1. From All Clients, select a client.
2. Go to Setup > Account > Collector Profile.
3. Click + ADD on the Collector Profiles page.

4. Enter the following details on the configuration page:
   • Profile Name: Provide a name for the profile you are creating.
   • Profile Type: Select either Standard or Elastic. By default, Standard is selected.
     To enable the Elastic option, please contact OpsRamp Support Team. For more information on this feature, refer to the Elastic Collector Profile.
   • Description (Optional): Add a short description for the profile.
   • Gateway Collector: Select the VIRTUAL APPLIANCE (OVA) NEXTGEN tile. You can also choose the desired Gateway version from the available options.

5. Click NEXT.
   

6. Click VIRTUAL APPLIANCE (OVA) in the left pane to download.
   Once the OVA is downloaded, you can proceed to the installation Step.

Step 2: Install the NextGen Gateway OVA as a Virtual Machine

Refer to the Configure the Gateway VM using OVA document for step-by-step instructions to deploy the NextGen Gateway as a virtual machine using an OVA image.

Step 3: Change Password

For enhanced security, you should change the default system password immediately after provisioning the Gateway. Updating your password reduces the risk of unauthorized access and helps maintain a secure environment.

passwd gateway-admin

Step 4: Update Hostname and IP Address

Refer to the Update Hostname and IP Address document for step-by-step instructions.

Step 5: Install Kubernetes

For detailed, step-by-step instructions on installing Kubernetes, refer to the Install K3s on ISO/OVA documentation.

Step 6: Register the Gateway

Refer to the Install Gateway Using OpsRamp Bootstrap Tool document to activate the Gateway collector. This document will guide you through the process of using the bootstrap tool to complete the NextGen Gateway installation.

×