Developer Portal
Gateway Setup & Administration
API ReferenceConsole

Virtual Machine Gateway Installation Guide

As an alternative to a hardware option, the UG-CLOUD Gateway can also be installed utilizing a Virtual Machine. We support these platforms:

The platform must be identified prior to the generation of the VM, as conversion between the types is not well supported.

System Requirements

The Mapped UG-CLOUD software was designed to be very lightweight, however every deployment environment is different. In order to avoid surprises, it is recommended that you have the following minimum system resources available:

  • 1 CPU with 2 cores / 2 CPUs with 1 core each
  • 2 gigs of storage
  • 8 gigs of memory; for multi-building campus deployments with a single gateway, 16gb or more may be required
  • No specific OS needs to be defined (it will be included in the image we send)
  • Must have UEFI support for boot

Network Access

The VM will need to preconfigured before being sent; configuration after installation is not supported at this time. If DHCP can be enabled, allowing the gateway to reach the Internet as needed, that is the easiest route. If that isn't possible, we will need the following information:

  • Assigned IP address
  • Subnet
  • Gateway IP(s)
  • DNS Servers IP(s)

Please also confirm with your network team that port 443 to the following FQDNs is accessible from the host machine:

Legacy FQDNs for existing gateway installations

  • datadog-api.mapped.com
  • datadog-process.mapped.com
  • datadog-logs.mapped.com
  • hosted.mender.io
  • hosted-mender-artifacts.s3.amazonaws.com
  • mapped-iot-prod.azure-devices.net
  • global.azure-devices-provisioning.net
  • *.balena-cloud.com

Current FQDNs for new gateway installations

  • api.mgmt.edge.mapped.com
  • api.telemetry.edge.mapped.com
  • cloudlink.mgmt.edge.mapped.com
  • d2c.edge.mapped.com
  • logs.mgmt.edge.mapped.com
  • logs.telemetry.edge.mapped.com
  • api.mapped.com
  • c2d.edge.mapped.com
  • process.telemetry.edge.mapped.com
  • registry.mgmt.edge.mapped.com
  • s3.mgmt.edge.mapped.com
  • delta.mgmt.edge.mapped.com
  • mapped-iot-prod.azure-devices.net
  • global.azure-devices-provisioning.net

Deploying the VM

Each platform has their own process for deploying VM images, and those steps also vary depending on the version of the platform in use. As a result, Mapped cannot provide guided support for the VM deployment. Instructions provided by the supported VM platforms are linked below, but despite best efforts to remain up to date, they may become outdated. We recommend verifying the instructions apply to your platform and version prior to beginning the deployment.