Versions Compared

Old Version 19

changes.mady.by.user Juan Tomás Alonso Nieto

Saved on

compared with

New Version Current

changes.mady.by.user Juan Tomás Alonso Nieto

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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
titleTAB ↹
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.

image-20240418-082044.png
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.

Image Removedimage-20240418-082401.pngImage Added
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.

Image Removedimage-20240418-082714.pngImage Added
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.

Image Removedimage-20240418-083204.pngImage Added
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

Image Removedimage-20240418-085449.pngImage Added
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.

Image Removedimage-20240418-090411.pngImage Added
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.

...