Page Comparison

Overview

After installing Devo Relay on your machine, you must set up your relay and then activate it in your Devo domain. There are 2 different setup processes you can follow:

• Interactive relay setup - The Devo Relay CLI offers an interactive process that guides you through the required configuration of your new relay.

• Non-interactive relay setup - Alternatively, you can define a .properties file including the required relay settings and use it to set it up.

Before you begin

You should have the API Key and API Secret for your Devo domain handy when you start this process. To copy the API Key and API Secret, log in to your domain using the Devo web application, then go to the Access keys tab in Administration → Credentials. Learn more about this in Security credentials.

When using ELB, you also need to have the type and endpoint for a successful configuration. Learn more about ELB in Event Load Balancers. If you are not sure about how to determine this, contact the Devo support team.

Interactive relay setup

Follow these steps to set up a new relay through the interactive process of the Devo Relay CLI:

Rw ui steps macro

Rw step First, access the Devo Relay CLI using the required command according to your OS: Ubuntu / Red Hat / CentOS Code Block devo-ng-relay-cli Info Type devo and press the  Status title TAB ↹ key and the command will be automatically completed. docker-compose Code Block sudo docker-compose run devo-ng-relay-cli Rw step Then, enter setup to start the relay setup process. Rw step The configuration process will start, which takes you through the steps required to set up a secure connection with the Devo cloud for your region. 1 First, select the cloud region your Devo domain resides in by typing the required value shown between brackets. If you enter Manual to configure a private cloud location, additional steps request the following information before proceeding: The Devo ELB endpoint corresponding to your region (for example, collector-us.devo.io if you're in the USA) The Devo ELB port to be used (443 or your dedicated one) The Relay API URL corresponding to your region (for example, https://api-us.devo.com/maduro if you're in the USA) The Devo Query API URL corresponding to your region (for example, https://apiv2-us.devo.com/search if you're in the USA) Info Check the required ELB endpoint and URLs according to your platform deployment in the requirements table of the Planning Devo Relay deployment article. 2 If you select one of the available clouds, you'll be asked if you're using a dedicated ELB or not. Type Y if you're using a dedicated ELB (in this case, you'll need to enter the ELB endpoint and port), or n if you're not. If you are not sure about this choice, contact the Devo support team. 3 Next, enter a name for the new relay. Note that this is not the hostname; it's the relay name that will appear in the Devo web application in Administration → Relays and ELBs → Relays. The relay name can contain a maximum of 100 characters and must not contain periods. You can use underscores and hyphens but other special characters are not allowed. 4 Now enter the API Key and API Secret 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 and API Secret. 5 You'll be asked if the relay will use an HTTP proxy server. If it will, type Y. You'll be prompted to indicate the following values if required: The HTTP proxy address. The HTTP proxy port. You'll be asked if your proxy is authenticated. Type Y or n as required. In case it is authenticated, you'll need to enter the HTTP proxy username and password. If you're not using a proxy server, type n 6 Finally, a summary of the details of your new relay will be shown. Type Y if the configuration is correct in order to end the setup process. If you type n, you'll be taken to the first step of the process. Note If a relay with the same name already exists in the same domain, you'll be asked if you want to override it. The process will be canceled if you decide not to override it. Rw step Now you must activate the relay in the Devo app. Go to Administration → Relays and ELBs → Relays, find your relay on the list and click the Activate option in the ellipsis menu at the right side of the table.

After activating the relay, it will stay in Applying config status for some time. The relay should turn to Active status in a few seconds. Learn more about the Devo Relay status workflow here.

Non-interactive relay setup

Instead of following the steps described above, you can define a file that includes all the required settings of your relay and use it to create it in the required domain. To do it:

devo-ng-relay-cli --autosetup <relayConfig.properties>

devo-ng-relay-cli -a <relayConfig.properties>

Reconfigure your relay

You can always edit the settings of an already existing relay following these instructions:

Interactive setup

To reconfigure an existing relay through the Devo Relay CLI interactive process, repeat the setup process described above and enter the name of the relay you want to modify. At the end of the process, you'll be asked if you want to override the current relay with the new settings. Enter Y to do it.

Image Removed

Image Added

If everything goes OK, you'll receive a confirmation message. Now you must activate the relay in the Devo app. Go to Administration → Relays and ELBs → Relays, find your relay on the list and click the Activate option in the ellipsis menu on the right side of the table.

Non-interactive setup

You can use a configuration file as described above to modify the settings of an already existing relay. To do it, enter the name of the relay you want to modify and the new settings, and save the file. Then, run one of the following commands in your machine (where <relayConfig.properties> is the name of the file including the relay settings):

devo-ng-relay-cli --force -autosetup <relayConfig.properties>

or

devo-ng-relay-cli --f -autosetup <relayConfig.properties>

If everything is properly set in your file, you'll receive a confirmation message. Now you must activate the reconfigured relay in the Devo app. Go to Administration → Relays and ELBs → Relays, find your relay on the list and click the Activate option in the ellipsis menu on the right side of the table.