Install on a virtual machine
This article provides step-by-step instructions for installing the Devo Relay on a virtual machine and assumes that the installer is comfortable using their chosen hypervisor.
Before getting started, you might want to watch this helpful video tutorial that describes this process using the VirtualBox hypervisor.
Before you begin
Make sure you can provide a machine with the following requirements:
One of the following hypervisors:
Ensure that the Devo Relay can access the Devo platform and the Devo web application:
For USA users:
For EU users:
These are the ports used by the Devo In-house Relay:
These ports should not be used by any other services.
Install the virtual hard disk
The virtual disk deploys the Ubuntu OS and the Devo Relay.
Click to download the Devo Relay virtual appliance for your hypervisor. If you downloaded the appliance for Hyper-V, you'll have to unzip it so the VHDX file is ready to use.
- Open your hypervisor and use the OVA or VHDX file you downloaded to create the new virtual machine.
- Enter a name for the new machine. This name must not contain dots.
- Create the new machine.
Set up the Devo Relay
This procedure guides you through the relay setup utility. You can use the console or a terminal editor during this procedure.
A note about the keyboard layout
The default installation loads the US keyboard layout. To change the layout for another region, issue the loadkeys command before starting this procedure. Use the region code for your region. In this example, we are loading the Spanish keyboard layout (es).
sudo loadkeys es
Log into your new virtual machine with the user
devoand the password
changeme. Once you are logged in, you are prompted to change the password.
Run this command to launch the Devo Relay configuration utility.
First, select the cloud region your Devo domain resides in, then press Enter.
If you select Manual to configure a private cloud location, additional steps request the following information before proceeding.
- Your Devo web application URL
- IP address of your Devo endpoint
- Port to send to on your Devo endpoint
Now enter a name for the new relay. This is not the hostname; it's the relay name that will appear in the Devo web application in Administration → Relays.
The relay name can contain a maximum of 50 characters and must not contain periods. You can use underscores and hyphens but other special characters are not allowed.
Now enter the API Key for the Devo domain to which you will be forwarding events.
Go to Administration → Credentials in the Devo web application to copy the API Key.
Click Yes if the relay requires a proxy to reach the internet. If you do, you can enter the proxy address in the next screen. Otherwise, click No.
- Now you can activate the relay. Go to Administration → Relays and click the Activate button that appears in the new relay's row in the Relay list.
Enter the following command in case you want to to re-run the devo-relay configuration utility:
Making sure the relay is working correctly
To confirm that the relay is operating correctly, follow our procedure to send test events and make sure they are saved in your Devo domain.
You can now start sending information from your data sources to the new Devo Relay and create the relay rules for event processing.