This page describes how to install and configure NextGen gateway in different target environments.

Please refer OpsRamp’s Collector Bootstrap Tool for general guidelines on how to install and register NextGen gateway.

The NextGen gateway can be installed in three environments:

  1. Install NextGen gateway on docker environment
  2. Install NextGen gateway on kubernetes environment
  3. Install using ISO/OVA on a virtualized environment (VMWare ESX/KVM)

Installation of NextGen gateway on Docker environment

Pre-requisites

To deploy a NextGen Gateway using the bootstrap tool in a docker environment, make sure your environment meets these resource requirements:

  • Docker Engine version 18.06.0 and higher
  • Docker Compose 1.27.0 and higher
  • 8 GB Memory (Recommended)
  • 50 GB Disk (Recommended)
  • Windows/Linux/Mac OS
  • AMD64/ARM64 Arch

Installation steps

You are now ready to install the NextGen gateway in your docker environment using the following CLI syntax.

Use the following command to install gateway:

opsramp-collector-start install -e docker –-url {opsramp 
saas url} –-key {Gateway unique authentication token}

Get the opsramp saas url, unique authentication token:

To find the authentication token and saas url, refer to OpsRamp Collector Bootstrap Tool → Management profile.

Sample command to install gateway:

bootstrap
Containers status:
bootstrap

Successful gateway registration:

Once the CLI returns successfully, navigate to Setup > Resource > Management Profile to check if the Gateway registered successfully.

Gateway connection status:

bootstrap

Installing the gateways through proxy

To Install the gateways through proxy, refer to OpsRamp Collector Bootstrap Tool → Installing the gateways through proxy.

Uninstallation steps

Use the below command to uninstall the NextGen gateway in docker. To uninstall the gateway, this collector needs sudo privileges.

sudo opsramp-collector-start uninstall -e docker

On successful uninstallation will show the response as below:

bootstrap

Installation of NextGen gateway on Kubernetes environment

Pre-requisites

To deploy a NextGen cluster in your kubernetes environment, make sure your environment meets these requirements:

  • Helm 3.8.2 or higher
  • Kubernetes (K3S or K8S) - 1.20.x - 1.17.x or higher
  • 8 GB Memory (Recommended)
  • 50 GB Disk (Recommended)
  • Windows/Linux/Mac OS
  • AMD64/ARM64 Arch

Installation steps

You are now ready to install the NextGen gateway in your Kubernetes environment using the following CLI syntax.

Use the following command to install the gateway:

opsramp-collector-start install -e k8s –-url {OpsRamp Server URL} –-key {Gateway unique authentication token}

Installing gateway in a kubernetes environment:

bootstrap
Pod status:
bootstrap

Please follow the steps described in this section if you are unsure of how to install kubernetes in your target system. The collector bootstrap tool has the built-in capability to install the Rancher k3s and other tools needed to setup both a single and multi-node kubernetes cluster environment across a set of VMs or bare-metal machines.

Successful gateway registration

Once the CLI returns successfully, navigate to Setup > Resource > Management Profile to check if the Gateway registered successfully.

Gateway connection status:

bootstrap

Uninstallation steps

Use the below command to uninstall the NextGen gateway in docker. To uninstall the gateway, this collector needs sudo privileges.

sudo opsramp-collector-start uninstall -e kubernetes

On successful uninstallation will show the response as below:

bootstrap

Installation of NextGen gateway using ISO or OVA

ISO and OVA are only applicable for the Kubernetes environment and Ubuntu/Linux operating system.

ISO installation:

  1. Download the ISO URL: https://opsramp-gateway.s3.us-east-2.amazonaws.com/Gateway+Cluster/Nextgen-gw-202207140245.iso
  2. Install the ISO: To install the ISO on your local computer, follow the instructions in Gateway Deployment for Vmware .

OVA installation:

  1. Download the OVA URL: https://opsramp-gateway.s3.us-east-2.amazonaws.com/Gateway+Cluster/Nextgen-gw-202207140245.ova

Once the gateway is provisioned its recommended to set the hostname as a best practice to have unique hostname in the network.

Update hostname:

Use the below command to update the hostname:

opsramp-collector-start setup updatehostname <new hostname>

On successful hostname update, will show the response as below:

bootstrap

Gateway initialization:

Run the following command to install the k3s environment in the gateway:

opsramp-collector-start setup --help

Single-node deployment:

Run the following command to install the k3s for single node gateway:

opsramp-collector-start setup init

On successful k3s installed, will show the response as below:

bootstrap

Check k3s status:

bootstrap

Follow the instructions in OpsRamp Collector Bootstrap Tool for NextGen Gateway registration.