Overview

This document provides a step-by-step guide to help you deploy the OpsRamp NextGen Gateway on cloud-managed Kubernetes platforms such as AKS (Azure Kubernetes Service), EKS (Elastic Kubernetes Service), and GKE (Google Kubernetes Engine) using Helm.

Even if you are new to Kubernetes or Helm, this guide will walk you through the entire process from preparing your environment to successfully installing the OpsRamp NextGen gateway. Each step includes detailed instructions and helpful tips to make the deployment as simple and straightforward as possible.

Installation Steps

Below are step-by-step instructions for installing the OpsRamp Gateway on supported Cloud Managed Kubernetes platforms:

AKS
EKS
GKE

Prerequisites

Before you begin deploying the OpsRamp NextGen Gateway, ensure that your AKS cluster meets the following minimum requirements:

  1. Common Prerequisites for Managed Kubernetes

    • Ensure that your AKS cluster meets the requirements outlined in the Prerequisites document for Managed Kubernetes to avoid deployment and networking issues.

  2. Provisioning an AKS Cluster
    To deploy the OpsRamp NextGen Gateway, you must have a fully operational Azure Kubernetes Service (AKS) cluster.

  • If you do not already have an AKS cluster, refer the official Microsoft Azure Documentation. This guide walks you through each step of the setup process, including resource group creation, cluster configuration, and connectivity setup.
  1. IAM Roles & Permissions for AKS
    To successfully deploy and run the Gateway, the AKS cluster’s Managed Identity or Service Principal must have the appropriate permissions. Required IAM Roles You can assign either broad or granular permissions, depending on your organization’s security policies:
RolePurpose
Contributor (Recommended for full control)Grants full access to manage Azure resources including PVC (Persistent Volume Claim) creation, service deployments, and networking components.
Storage Account Contributor (For limited storage access). Allows the cluster to create and manage Azure Disks and File Shares required for Gateway volumes.
Managed Identity Operator (Optional)Enables the AKS cluster to assign and manage user-assigned managed identities. Required only if your Gateway configuration uses custom identities.

To assign roles, navigate to the Azure Portal → your AKS Resource Group → Access Control (IAM).

Installation Steps

Step 1: Create Collector Profile to Register gateway

To create Gateway Collector Profile:
In OpsRamp Portal, navigate to Setup > Account > Collector Profiles, click +ADD and then select Cloud‑Native Application (Installer).

Step 2: Connect to AKS Cluster

Connect to any node in the cluster via SSH, Cloud Shell etc.

Step 3: Create Namespace (Optional)

kubectl create namespace <namespace>

Step 4: Deploy Gateway using Helm

Refer the Install Gateway Using Helm on Kubernetes document to deploy gateway via helm.

Step 5: Verify Deployment

  • Check pods:
    kubectl get pods -n <namespace>
    You should see pods like nextgen-gw-0, nextgen-gw-redis-master-0
    Sample Output
    $ kubectl get pods
NAME                       READY   STATUS    RESTARTS   AGE
nextgen-gw-0               0/3     Running   0          80s
nextgen-gw-redis-master-0  1/1     Running   0          80s
$ kubectl get pods
NAME                       READY   STATUS    RESTARTS   AGE
nextgen-gw-0               0/3     Running   0          82s
nextgen-gw-redis-master-0  1/1     Running   0          82s
$ kubectl get pods
NAME                       READY   STATUS    RESTARTS   AGE
nextgen-gw-0               3/3     Running   0          6m53s
nextgen-gw-redis-master-0  1/1     Running   0          6m53s

On successful deployment, Confirm gateway registration and connectivity status via OpsRamp portal at Setup > Account > Collector Profiles.

Step 6: Check logs (Optional)

Check the logs if any issue with gateway connectivity.

kubectl logs <pod-name> -n <namespace>

Prerequisites

Before you begin deploying the OpsRamp NextGen Gateway, ensure that your EKS cluster meets the following minimum requirements:

  1. Common Prerequisites for Managed Kubernetes

    • Ensure that your EKS cluster meets the requirements outlined in the Prerequisites document for Managed Kubernetes to avoid deployment and networking issues.

  2. Provisioning an EKS Cluster
    To deploy the OpsRamp NextGen Gateway on AWS, you need a fully functional Amazon Elastic Kubernetes Service (EKS) cluster.

  • If an EKS cluster is not already available in your environment, refer to the official Amazon Documentation for detailed, step-by-step guidance on how to create and configure one.
  • This includes setting up IAM roles, configuring networking, and launching the cluster using the AWS Management Console, AWS CLI, or Infrastructure-as-Code tools like Terraform or AWS CloudFormation.
  1. IAM Roles & Permissions for EKS
    1. Attach Node IAM Role with AmazonEKSBlockStoragePolicy and necessary EBS permissions.
    2. Ensure that the trust relationship of the node IAM role allows EKS to assume the role.

Installation Steps

Step 1: Create Collector Profile to Register gateway

To create Gateway Collector Profile:
In OpsRamp Portal, navigate to Setup > Account > Collector Profiles, click +ADD and then select Cloud‑Native Application (Installer).

Step 2: Connect to EKS Cluster

Connect to any node in the cluster via SSH, Cloud Shell etc.

Step 3: Create Namespace (Optional)

kubectl create namespace <namespace>

Step 4: Deploy Gateway using Helm

Refer the Install Gateway Using Helm on Kubernetes document to deploy gateway via helm.

Step 5: Verify Deployment

  • Check pods:
    kubectl get pods -n <namespace>
    You should see pods like nextgen-gw-0, nextgen-gw-redis-master-0
    Sample Output
    $ kubectl get pods
NAME                       READY   STATUS    RESTARTS   AGE
nextgen-gw-0               0/3     Running   0          80s
nextgen-gw-redis-master-0  1/1     Running   0          80s

$ kubectl get pods
NAME                       READY   STATUS    RESTARTS   AGE
nextgen-gw-0               0/3     Running   0          82s
nextgen-gw-redis-master-0  1/1     Running   0          82s

$ kubectl get pods
NAME                       READY   STATUS    RESTARTS   AGE
nextgen-gw-0               3/3     Running   0          6m53s
nextgen-gw-redis-master-0  1/1     Running   0          6m53s
  • On successful deployment, Confirm gateway registration and connectivity status via OpsRamp portal at Setup > Account > Collector Profiles.

Step 6: Check logs (Optional)

Check the logs if any issue with gateway connectivity.

kubectl logs <pod-name> -n <namespace>

Prerequisites

Before you begin deploying the OpsRamp NextGen Gateway, ensure that your GKE cluster meets the following minimum requirements:

  1. Common Prerequisites for Managed Kubernetes

    • Ensure that your GKE cluster meets the requirements outlined in the Prerequisites document for Managed Kubernetes to avoid deployment and networking issues.

  2. Provisioning an GKE Cluster
    To deploy the OpsRamp NextGen Gateway on Google Cloud Platform (GCP), you will need a properly configured Google Kubernetes Engine (GKE) cluster.

  • If you do not already have a GKE cluster, refer to the official Google Cloud Documentation documentation to help you create one using the Google Cloud Console, gcloud CLI, or Terraform.
  • The setup process includes configuring your Google Cloud project, enabling necessary APIs, setting up IAM permissions, and provisioning the cluster with appropriate node pools and networking.
  1. IAM Roles & Permissions for GKE
    1. For Developer Access - Assign roles/container.developer (Kubernetes Engine Developer), this grants essential GKE permissions including working with PVCs/PVs, deployments, statefulsets, etc.
    2. For Broader Control (e.g. cluster and node pool operations) - Assign roles/container.admin (Kubernetes Engine Admin)

Installation Steps

Step 1: Create Collector Profile to Register gateway

To create Gateway Collector Profile:
In OpsRamp Portal, navigate to Setup > Account > Collector Profiles, click +ADD and then select Cloud‑Native Application (Installer).

Step 2: Connect to GKE Cluster

Connect to any node in the cluster via SSH, Cloud Shell etc.

Step 3: Create Namespace (Optional)

kubectl create namespace <namespace>

Step 4: Deploy Gateway using Helm

Refer the Install Gateway Using Helm on Kubernetes document to deploy gateway via helm.

Step 5: Verify Deployment

  • Check pods:
    kubectl get pods -n <namespace>
    You should see pods like nextgen-gw-0, nextgen-gw-redis-master-0
    Sample Output
    $ kubectl get pods
NAME                       READY   STATUS    RESTARTS   AGE
nextgen-gw-0               0/3     Running   0          80s
nextgen-gw-redis-master-0  1/1     Running   0          80s

$ kubectl get pods
NAME                       READY   STATUS    RESTARTS   AGE
nextgen-gw-0               0/3     Running   0          82s
nextgen-gw-redis-master-0  1/1     Running   0          82s

$ kubectl get pods
NAME                       READY   STATUS    RESTARTS   AGE
nextgen-gw-0               3/3     Running   0          6m53s
nextgen-gw-redis-master-0  1/1     Running   0          6m53s
  • On successful deployment, Confirm gateway registration and connectivity status via OpsRamp portal at Setup > Account > Collector Profiles.

Step 6: Check logs (Optional)

Check the logs if any issue with gateway connectivity.

kubectl logs <pod-name> -n <namespace>

Tabbed Interface with Table