Setting up your UpGuard appliance simply involves using a hypervisor of your choice, such as VMWare virtualization tools like vSphere (ESXi). takes 10-20 minutes.

Obtaining your UpGuard appliance template file

Your UpGuard technical account manager or support engineer should provide you with a link to download your UpGuard appliance, which is usually provided as one of the following options, depending on your choice of deployment:

File format Description
.ova Open Virtualization Archive: contains a compressed installable of a VM for import
.ovf Open Virtualization Format: supported by VirtualBox, EC2, VMWare, etc.
.ami Amazon Machine Image: provides AWS with the information to launch an EC2 instance.
.vhd Virtual Hard Disk: used with Hyper-V on Windows

These appliances come prebuilt with the network configuration settings that you have provided for us in the UpGuard Appliance Pre-Requisites form, and should be ready for you to import into your virtual network environment for immediate use.

Importing the Appliance

Your appliance will be built and stored on Google Cloud Storage, a link will be provided for you to download from Google’s servers. Once you have downloaded the appliance, simply run the OVA file (or any of the formats) into your virtualization management tool to get started with the appliance.

Configuring the Appliance

The appliance has been pre-configured to work for most environments, so you should not need to change any settings.

If you have questions about a setting or would like to make modifications, please contact UpGuard support.

Troubleshooting

OVA Import Fails on ESXi

When using the free vSphere client to import our OVA appliance into ESXi, you may encounter an error stating:

The OVF package requires support for OVF Properties.
Details:  Line 172:  Unsupported element 'Property'

Pre-requisites

  1. OVFTool

  2. The command line tar utility, or any GUI archive tool that can extract tar files

Steps (on Windows)

  1. Run tar xvf on the OVA to extract OVF and VMDK files

  2. Edit the OVF (xml) and remove the whole section that contains elements.

  3. Use ovftool to import to ESXi

    .\ovftool.exe --lax --noSSLVerify --datastore=[DatastoreName]
        --skipManifestCheck '[OVF source path]' vi://[user]:[pass]@[ESXi target Address]
    
  4. Manually configure the network settings on the new VM

Notes

The OVF source path can be the unpacked OVF file you edited in Step 2, as long as the VMDK files are in the same directory. It may also be possible to package it back up as an OVA but haven’t tested.

If the import fails with a message like “transfer failed” without a specific error, just choose to ‘Try Again’ or ‘Retry’ (may only be an issue on VirtualBox).

The --lax option is spotty at best, but we include it here just in case it is able to eliminate other unrelated import errors.

Tags: appliance