This section provides step-by-step instructions to deploy the OpsRamp Gateway VM using an Gateway image on supported public cloud. The following public cloud environments are supported:

  • AWS
  • Azure
  • GCP

Prerequisites

Before deploying the Gateway VM, ensure the following prerequisites are met:

  • Valid license and credentials to register the Gateway.
  • Access to the public cloud environments
  • VM network connectivity to the OpsRamp Cloud endpoints.
  • Refer to minimum server requirements before creating a VM.

Installation Steps

AWS
Microsoft Azure
GCP

Step 1: Request Access to the AWS Gateway Image (AMI)

To deploy the OpsRamp Classic Gateway on AWS, you need access to the Amazon Machine Image (AMI) provided by OpsRamp. This image is used to launch the Gateway as an EC2 instance in your AWS account.
Follow the steps below to request access to the AWS AMI through the OpsRamp portal.

Requirements

  • OpsRamp Portal access.
  • AWS Account ID.
  • Permissions in OpsRamp to manage Collector Profiles.

Procedure

  1. Log in to the OpsRamp Portal.
  2. Navigate to All Clients and select the client where you want to deploy the Gateway.
  3. Go to Setup > Account > Collector Profiles.
  4. Click the + ADD button to create a new Collector profile.
  5. Enter the Collector Profile Details:
    • Profile Name: Enter your profile a name (e.g., AWS-Gateway-Deployment).
    • Profile Type: Leave this as Standard (default).
    • Description: (Optional) Add a short description for reference.
  6. In the Gateway Collector (Classic) section, select the Amazon Machine Image (AMI) tile.
  7. Enter your AWS Account ID and select the AWS region (e.g., us-east-1, us-west-2, etc.) where you want to deploy the AMI.
  8. Click Request Access to request AMI Access. This sends an automated request to the OpsRamp platform support team.
    You will receive a confirmation email once access to the AMI is granted.
  9. Click Finish to complete the profile configuration.

Next Steps

  • The OpsRamp support team will share the AMI with your specified AWS account.
  • You’ll receive a confirmation once the AMI is available for use.
  • After that, you can launch the EC2 instance using the shared AMI to deploy your Gateway.

Step 2: Launch and Configure the Classic Gateway EC2 Instance on AWS

Once OpsRamp has granted access to the Classic Gateway AMI (Amazon Machine Image), the next step is to launch and configure the EC2 instance that will run the Gateway in your AWS environment. Follow the steps below to set up your instance correctly.

Requirements

  • AWS Console access with EC2 permissions.
  • OpsRamp Gateway AMI access must be granted to your AWS account (see Step 1).
  • Target AWS region for deployment is identified.

Procedure

  1. Log in to the AWS Management Console.
  2. go to Services > EC2. The EC2 Dashboard is displayed.
  3. In the left navigation pane, select Images > AMIs.
  4. Select Owned by me and then choose Private images from the filter options.
    You’ll see a list of private AMIs shared with your account. Look for the OpsRamp Gateway AMI.
  5. Select the correct AMI from the list and then click Actions > Launch to begin the EC2 instance configuration.
  6. Configure Instance Settings . - Select an instance type that meets minimum server requirements and then click Next.
  7. Configure Instance Details:
    • Set the number of instances you want to deploy (one per Gateway).
    • (Optional) Make sure Auto-assign Public IP is enabled, unless you plan to use a private IP.
    • Leave other default settings unless your architecture requires custom networking.
    • Click Next.
  8. Add Storage:
    • The root volume is added automatically.
    • Ensure the disk size to met minimum server requirements.
    • You can increase this size if needed based on data retention or expected workload.
    • Click Next.
  9. Add Tags (Optional):
    • Tags help you identify and organize AWS resources.
    • For example, you can add a tag like: Key: Name | Value: OpsRamp-Classic-Gateway
    • Click Next.
  10. Configure Security Group (Firewall Rules):
    • You can select an existing security group or create a new one.
    • Ensure the following inbound ports are allowed:
      • Refer minimum System requirements
    • Click Review and Launch.

Final Review and Launch

  1. Double-check instance type, AMI ID, storage, tags, and security group settings
  2. Click Launch.
    • When prompted for a key pair, select Launch without a key pair if you don’t need SSH access, or
    • Choose an existing key pair if you plan to connect to the instance via SSH.
  3. Click Launch Instance to finalize.

After launching,

  • Go to EC2 > Instances to monitor the instance status.
  • Wait for the Instance State to show running and the Status Checks to pass.
  • Once the instance is ready, you can access the Gateway Admin UI at: https://<Public/Private Gateway IP>:5480

Step 1: Create a Resource Group and Required Resources

Requirements

  • You have access to your Azure account.
  • You have decided on the region for deployment.

Procedure

  1. Log in to the Azure account from your browser.
  2. In the top-left corner, click the menu icon and select Resource Groups.
  3. From the Resource Groups screen, click +Create.
  4. Enter the resource group name, select the required resource group location, and click Create.
  5. Verify that the resource group is created.
  6. To create a Storage Account in the resource group, navigate back to the Menu icon in the top-left corner and click Storage Accounts.
  7. Click +Create to create a new storage account within the resource group.
  8. Open the Storage Account and click Blob Service.
  9. Click +Container to create a new container, enter a name, and select Private (no anonymous access).
  10. Click create. You need to save the gateway VHD file in this Container for later.
  11. To create a virtual network in the resource group, navigate back to the Menu icon in the top-left corner and click Virtual networks.
  12. Click +Create. You now have a resource group, storage account, and virtual network in the same resource group.

Step 2: Create the Template JSON to Launch the Gateway

  1. Log in to the Azure account from your browser.
  2. Search for Template Spec in the search area.
  3. Click + Create Template Spec to create a new template.
  4. Enter the template name, resource group, description, and version, then click the Edit Template tab.
  5. Copy the following JSON code, paste it, and click on Review + Create tab.
{
    "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "vmName": {
            "type": "string",
            "metadata": {
                "description": "Name of the VM"
            }
        },
        "osType": {
            "type": "string",
            "defaultValue": "Linux",
            "metadata": {
                "description": "Type of OS of the existing vhd"
            }
        },
        "vmSize": {
            "type": "string",
            "metadata": {
                "description": "Size of the VM"
            },
            "defaultValue": "Standard_B2s"
        },
        "storageaccountname": {
            "type": "string",
            "metadata": {
                "description": "Provide the Storage account name"
            }
        },
        "osDiskVhdUri": {
            "type": "string",
            "metadata": {
                "description": "Uri of the existing OS VHD in ARM standard or premium storage"
            }
        },
        "existingVirtualNetworkNameID": {
            "type": "string",
            "metadata": {
                "description": "Name of the existing VNET ID"
            }
        },
        "subnetName": {
            "type": "string",
            "metadata": {
                "description": "Name of the subnet in the virtual network you want to use"
            }
        },
        "enablePublicIP": {
            "type": "bool",
            "defaultValue": true,
            "metadata": {
                "description": "Enable/Disable Public IP"
            }
        }
    },
    "variables": {
        "diagStorageAccountName": "[parameters('storageaccountname')]",
        "publicIPAddressType": "Dynamic",
        "vnetID": "[parameters('existingVirtualNetworkNameID')]",
        "subnetRef": "[concat(variables('vnetID'),'/subnets/', parameters('subnetName'))]",
        "nicName": "[concat(parameters('vmName'), '-nic1')]",
        "publicIPAddressName": "[concat(parameters('vmName'), '-pip')]"
    },
    "resources": [
        {
            "condition": "[parameters('enablePublicIP')]",
            "apiVersion": "2023-05-01",
            "type": "Microsoft.Network/publicIPAddresses",
            "name": "[variables('publicIPAddressName')]",
            "location": "[resourceGroup().location]",
            "tags": {
                "displayName": "PublicIPAddress"
            },
            "properties": {
                "publicIPAllocationMethod": "[variables('publicIPAddressType')]"
            }
        },
        {
            "apiVersion": "2023-05-01",
            "type": "Microsoft.Network/networkSecurityGroups",
            "name": "VistaraNSG",
            "location": "[resourceGroup().location]",
            "tags": {
                "displayName": "VistaraVM-NSG"
            },
            "properties": {
                "securityRules": [
                    {
                        "name": "SSH",
                        "properties": {
                            "description": "Allow SSH",
                            "protocol": "Tcp",
                            "sourcePortRange": "*",
                            "destinationPortRange": "22",
                            "sourceAddressPrefix": "Internet",
                            "destinationAddressPrefix": "*",
                            "access": "Allow",
                            "priority": 100,
                            "direction": "Outbound"
                        }
                    },
                    {
                        "name": "HTTPS",
                        "properties": {
                            "description": "Allow HTTPS",
                            "protocol": "Tcp",
                            "sourcePortRange": "*",
                            "destinationPortRange": "443",
                            "sourceAddressPrefix": "Internet",
                            "destinationAddressPrefix": "*",
                            "access": "Allow",
                            "priority": 101,
                            "direction": "Outbound"
                        }
                    }
                ]
            }
        },
        {
            "condition": "[parameters('enablePublicIP')]",
            "apiVersion": "2023-05-01",
            "type": "Microsoft.Network/networkInterfaces",
            "name": "[variables('nicName')]",
            "location": "[resourceGroup().location]",
            "dependsOn": [
                "[concat('Microsoft.Network/publicIPAddresses/', variables('publicIPAddressName'))]",
                "[concat('Microsoft.Network/networkSecurityGroups/', 'VistaraNSG')]"
            ],
            "tags": {
                "displayName": "NetworkInterface"
            },
            "properties": {
                "ipConfigurations": [
                    {
                        "name": "ipconfig1",
                        "properties": {
                            "privateIPAllocationMethod": "Dynamic",
                            "publicIPAddress": {
                                "id": "[resourceId('Microsoft.Network/publicIPAddresses',variables('publicIPAddressName'))]"
                            },
                            "subnet": {
                                "id": "[variables('subnetRef')]"
                            }
                        }
                    }
                ],
                "networkSecurityGroup": {
                    "id": "[resourceId('Microsoft.Network/networkSecurityGroups', 'VistaraNSG')]"
                }
            }
        },
        {
            "condition": "[not(parameters('enablePublicIP'))]",
            "apiVersion": "2023-05-01",
            "type": "Microsoft.Network/networkInterfaces",
            "name": "[variables('nicName')]",
            "location": "[resourceGroup().location]",
            "dependsOn": [
                "[concat('Microsoft.Network/networkSecurityGroups/', 'VistaraNSG')]"
            ],
            "tags": {
                "displayName": "NetworkInterface"
            },
            "properties": {
                "ipConfigurations": [
                    {
                        "name": "ipconfig1",
                        "properties": {
                            "privateIPAllocationMethod": "Dynamic",
                            "subnet": {
                                "id": "[variables('subnetRef')]"
                            }
                        }
                    }
                ],
                "networkSecurityGroup": {
                    "id": "[resourceId('Microsoft.Network/networkSecurityGroups', 'VistaraNSG')]"
                }
            }
        },
        {
            "apiVersion": "2023-07-01",
            "type": "Microsoft.Compute/virtualMachines",
            "name": "[parameters('vmName')]",
            "location": "[resourceGroup().location]",
            "tags": {
                "displayName": "VirtualMachine"
            },
            "dependsOn": [
                "[concat('Microsoft.Network/networkInterfaces/', variables('nicName'))]"
            ],
            "properties": {
                "hardwareProfile": {
                    "vmSize": "[parameters('vmSize')]"
                },
                "storageProfile": {
                    "osDisk": {
                        "name": "[concat(parameters('vmName'),'-osDisk')]",
                        "osType": "[parameters('osType')]",
                        "caching": "ReadWrite",
                        "vhd": {
                            "uri": "[parameters('osDiskVhdUri')]"
                        },
                        "createOption": "Attach"
                    }
                },
                "networkProfile": {
                    "networkInterfaces": [
                        {
                            "id": "[resourceId('Microsoft.Network/networkInterfaces',variables('nicName'))]"
                        }
                    ]
                },
                "diagnosticsProfile": {
                    "bootDiagnostics": {
                        "enabled": "true",
                        "storageUri": "[concat(reference(concat('Microsoft.Storage/storageAccounts/', parameters('storageaccountname')), '2016-01-01').primaryEndpoints.blob)]"
                    }
                }
            }
        }
    ]
}

Step 3: Download the Azure Blob Container

To download the Azure Blob Container from OpsRamp portal, 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.
ISO download
  1. Enter the following details on the configuration page:
    • Profile Name: Provide a name for the profile you are creating.
    • Profile Type: By default, the Standard profile type is selected.
    • Description: (Optional) Add a short description for the profile.
    • Gateway Collector (Classic): Select the Azure Blob Container tile.
ISO download
  1. Click NEXT to proceed.
  2. On the Azure widget, click Copy Link icon to copy the Azure blob container link.
  3. Use this link to download the Azure Gateway VHD file using Microsoft Azure Storage Explorer. You can download and install Microsoft Azure Storage Explorer on your machine if needed.

OVA download
8. Finally, Click to Finish to complete the configuration.

Step 4: Setup a Gateway with Storage Explorer

  1. Open MS Azure Storage Explorer and click the User icon on the left side panel. Add your account by clicking “Add an account link”, which displays a pop-up window.
  2. Click Subscription and log in to your Azure account to access your storage.
  3. After logging into the account, click the Connect icon, which displays a pop-up window
  4. Click Blob Container.
  5. Select the Shared access signature URL (SAS) radio button.
  6. Paste the link that you copied from the OpsRamp Gateway download page and click Next.
  7. Click Connect. The Gateway VHD file is available in your Azure storage explorer at Local & Attached > Storage Accounts > Blob Containers.
  8. Right-click the OpsRamp gateway VHD file and copy it.
  9. Navigate to the storage container you created in the steps and paste the Gateway VHD file. This process takes some time so make sure you wait until the file download process completes.

Step 5: Deploy a Gateway using the Template JSON

  1. In the browser, log in to your Azure account and navigate to the templates page.
  2. Click your previously created template.
  3. Click Deploy and enter the following required information in the gateway deployment form:
PropertyDescription
Resource GroupSelect the resource group you created for gateway deployment.
VM NameEnter a user-defined gateway VM name.
OS TypeLinux
VM SizeThe minimum size is Standard_B2s. You can increase the size according to your requirements.
Storage Account Name
  1. Go to Storage accounts in a new browser tab.
  2. Select the storage account.
  3. Make a note of the storage account name and paste it into the gateway deployment form.
OS Disk VHD URI
  1. Go to Storage accounts in a new browser tab.
  2. Click the storage account.
  3. Click Blob service
  4. Click the container
  5. Click the gateway VHD file you downloaded
  6. In the Overview tab, copy the URL and paste it into the Gateway deployment form.

You can deploy only one gateway per VHD file. If you want to deploy more than one gateway, make a copy of the VHD file before deploying another gateway.
Existing Virtual Network Name ID
  1. Go to Virtual networks in a new browser tab.
  2. Select the virtual network.
  3. Click Properties in the left-side menu.
  4. Copy the Resource ID and paste it into the gateway deployment form.
Subnet Name
  1. Go to Virtual networks in a new browser tab.
  2. Select the virtual network.
  3. Click Subnets in the left-side menu.
  4. Copy the Name and paste it into the gateway deployment form.
  1. Accept the terms and conditions and click the Purchase button to deploy the gateway. Deployment takes a couple of minutes. You can check the progress on the Notification page.
  2. After deployment, go to Virtual Machines and select the gateway.
  3. In the left-hand side menu, choose the Networking option.
  4. Select Add inbound port rule and allow ports 22 and 5480 according to your requirement to access the gateway using SSH or WebUI.
  5. You can access the gateway by using the public IP address assigned to it.

Step 6: Change Password

  1. Open the Gateway Admin UI at: https://<Gateway IP>:5480.
  2. From the Administration Menu, go to Password and change the password.
    ISO download

Step 7: Update Hostname and IP Address

  1. Open the Gateway Admin UI at: https://<Gateway IP>:5480.
  2. From the Administration Menu, go to Network and update the Hostname and IP Address.
    ISO download

Step 8: Register the Gateway

Refer to the Register the Gateway document to activate the Gateway collector. This guide provides step-by-step instructions for completing the Gateway installation.

Step 1: Download the Google Image

To download the Google Image from OpsRamp Portal, 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.
ISO download
  1. Enter the following details on the configuration page:
    • Profile Name: Provide a name for the profile you are creating.
    • Profile Type: By default, the Standard profile type is selected.
    • Description: (Optional) Add a short description for the profile.
    • Gateway Collector (Classic): Select the Google Image tile.
ISO download
  1. Click NEXT to proceed.
  2. Click the download button in the Google Cloud Image widget to download the file.

OVA download
9. Finally, Click to Finish to complete the configuration.

Step 2: Create a Storage Bucket

Buckets are the basic containers that hold your data. Everything stored in cloud storage must be contained in a bucket.

  1. Log into GCP with your credentials.
  2. From the Projects list, select the project to deploy the gateway.
  3. On the left pane, from Storage menu, click Storage and click Create Bucket.
  4. From Create a bucket, enter a bucket name (Example: opsramp-gateway) and click Continue.
  5. From the available default storage class options, select Multi-Regional and click Continue.
  6. (Optional) Configure Control access to objects and Advanced settings.
  7. Click Create. The bucket you created is in the Buckets list.
  8. Click the name of the bucket in the Buckets list.
  9. From the Objects tab, click Upload Files and select the gateway image file. The gateway image file is uploaded to the bucket.

Step 3: Create an Image

A virtual machine image is a single file that has a virtual disk with a bootable operating system. Google permits you to define virtual machine images or use pre-defined images that are used to create one or more virtual machine instances that look alike.

  1. On the left pane, from the Compute Engine menu, click Images. Images list is displayed.
  2. Click Create Image.
  3. Enter the following details:
    • Name: Enter a unique name for the gateway image.
    • Source: Select Cloud Storage file from the drop-down options.
    • Cloud Storage file: Select the gateway image file that is attached to the storage bucket.
    • Encryption: Google-managed key is selected by default.
  4. Click Create. The new image displays in the images list.

Step 4: Create a VM Instance

An instance is a virtual machine hosted on the Google infrastructure. A virtual machine instance is created for the gateway using the gateway image.

  1. On the left pane, from Compute Engine menu, click VM Instances.
  2. Click Create Instance.
  3. Enter the following information:
FieldDescription
NameUnique gateway instance name
RegionSelect US-central1
Machine TypeMinimum requirement is two vCPU, 4GB
Access scopesDefault: Allow default access
FirewallEnsure port 22 and port 5480 are permitted on the gateway to access web and serial user interfaces
  1. Click Create.
  2. Verify if the gateway is installed in Google Cloud Platform (GCP).

Step 5: Change Password

  1. Open the Gateway Admin UI at: https://<Gateway IP>:5480.
  2. From the Administration Menu, go to Password and change the password.
    ISO download

Step 6: Update Hostname and IP Address

  1. Open the Gateway Admin UI at: https://<Gateway IP>:5480.
  2. From the Administration Menu, go to Network and update the Hostname and IP Address.
    ISO download

Step 7: Register the Gateway

Refer to the Register the Gateway document to activate the Gateway collector. This guide provides step-by-step instructions for completing the Gateway installation.

Tabbed Interface with Table