Documentation is now available for the Fall 2020 Update release!

Deploying Gateways on GCP

Describes how to deploy the gateway on Google for Google Cloud Platform (GCP) by configuring GCP and OpsRamp.

Leave Feedback

Introduction

The gateway is deployed in Google Cloud environment to monitor and manage your resources.

Prerequisites

A Google URL is provided by OpsRamp Support to download a gateway image file. The image file is required when creating a storage bucket.

GCP configuration

In GCP, configuration includes the following:

  1. Creating a storage bucket.
  2. Creating an image.
  3. Creating a VM instance.

Step 1: Create a storage bucket

Buckets are the basic containers that hold your data. Everything that is stored in Cloud Storage must be contained in a bucket.

To create a new storage bucket:

  1. Log into GCP with your credentials.
  2. From Projects drop-down list, select the desired project to deploy the gateway.
  3. On the left pane, from Storage menu, click Storage and then 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 now appears in the Buckets list.
  8. Click name of the bucket. The Bucket details screen appears.
  9. From the Objects tab, click Upload Files and select the gateway image file. Gateway image file gets uploaded to the bucket.
Bucket Details

Bucket Details

Step 2: Create an image

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

To create a new image for the gateway:

  1. On the left pane, from Compute Engine menu, click Images. Images list is displayed.
  2. Click Create Image. Create an image screen appears.
  3. Provide 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 appears in the images list.
Create an Image

Create an Image

Step 3: Create a VM instance

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

To create a new VM instance:

  1. On the left pane, from Compute Engine menu, click VM Instances.
  2. Click Create Instance. Create an instance screen appears.
  3. Provide the following details and click Create.
    • Name: Enter a unique name for the gateway instance.
    • Region: Select US-central1 from the drop-down options.
    • Machine Type: Minimum requirement is 2 vCPU, 4GB.
    • Access scopes: Allow default access is selected by default.
    • Firewall: Ensure that port 22 and port 5480 are allowed on the gateway to access the Web and Serial user interface.
  4. Verify if the gateway is installed in Google Cloud Platform (GCP).
Gateway Installed

Gateway Installed

Gateway registration

Gateway registration includes the following steps:

  1. Creating a management profile
  2. Configuring the gateway registration

Step 1: Create a management profile

To create a management profile:

  1. Select Setup > Device Management > Management Profile.
  2. Select the client with which you want to register the gateway.
  3. Click +Add to create a profile.
  4. From the Management Profile page, select Profile type as OpsRamp Gateway.
  5. Enter Profile Name and click Submit. The activation token is automatically generated.
  6. Copy the Activation token.
Management Profile - Register Gateway

Management Profile - Register Gateway

Step 2: Configure the gateway registration

After creating a management profile, configure the gateway registration using one of the following methods:

  • Gateway administration console
  • Gateway web user interface

Configuring with the administration console

To configure the gateway using the administration console:

  1. Log into the Gateway VM with the provided username and password.
    For default login credentials to log into the administration console, contact OpsRamp Support.
  2. From the left pane, click General.
  3. Verify if the Registration Status is Not Registered and the Tunnel Status is Not Established.
    • During the installation of the gateway, the first screen prompts you to set a hostname for the gateway.
    • If the hostname is not provided, the gateway is identified based on the MAC Address that is displayed across the user interface.
  4. Click Network, select Use Static IP address and then click Save.
  5. To configure gateway to use Proxy, use CTRL+P to navigate to Proxy Settings. By default, Direct connection to the Internet is selected. You can configure manual proxy if required.
  6. Provide details of OpsRamp Server (api.opsramp.com) and enter Activation Token as per topic Profile in OpsRamp and get activation token.
  7. Click Update Now to register the gateway to OpsRamp.
  8. Verify if the gateway is registered with OpsRamp.
Gateway Registration Success

Gateway Registration Success

Configuring with the web user interface

To configure the gateway using the web user interface:

  1. On the web browser, type the URL as https://<enter Gateway IP address>:5480.
  2. From the gateway login screen, provide a default Username and password.
  3. Click Network. If required, clear the Obtain an IP Address from DHCP selection and provide the static address.
  4. (Optional) Enter VLAN, Static Routing, Proxy details.
  5. From the Administration menu, click Registration.
  6. From the Registration screen, provide the activation token that you copied while creating the management profile.
  7. Enter OpsRamp SaaS Endpoint details (app.opsramp.com) and click Activate.
  8. Verify if the Registration Status appears as Registered.
  9. Verify if the status appears as success in OpsRamp.
Registration URL

Registration URL