Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 63 Next »

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.

Relay setup process

After installing Devo Relay in your machine, follow these steps to set up a new relay:

  1. irst, access the Devo Relay CLI using this command:


  2. Then, enter setup to start the relay setup process.

  3. 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.

    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 collector / ELB endpoint corresponding to your region (for example, us.elb.relay.logtrust.net if you're in the USA)
    • The Devo collector 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)

    Check the required collector / ELB endpoint and URLs according to your platform deployment in the requirements table of the Planning Devo Relay deployment article.





    If you select one of the available clouds, you'll be asked if you're using a dedicated collector / ELB or not. Type Y if you're using a dedicated collector (in this case, you'll need to enter the collector endpoint and port), or n if you're not.

    If you are not sure about this choice, contact the Devo support team.

     

    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.

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

    Finally, 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


     

  4. Now you must activate the relay in the Devo app. Go to Administration → Relays, find your relay on the list and click the Activate button that appears next to its name.

After activating the relay, it will stay in Applying config status for some time. This status is represented with the color yellow in the application. The relay should turn to Active status in a few seconds, and its status color will change to green. Learn more about the Devo Relay status workflow here.

Check the status of your relay

You can check your relay status anytime by using the status command on the CLI. Learn more about working on the CLI in this article.

Reconfigure your relay

To relaunch the configuration process at any time after the installation, simply repeat the setup process again.

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.

Relay setup process

After installing Devo Relay in your machine, follow these steps to set up a new relay:

  1. First, access the Devo Relay CLI using this command:

    Ubuntu / CentOS

    devo-ng-relay-cli

    Tip

    Type devo and press the TAB ↹ key and the command will be automatically completed.

    docker-compose

    sudo docker-compose run devo-ng-relay-cli

  2. Then, enter setup to start the relay setup process.

  3. 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.

    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 collector / ELB endpoint corresponding to your region (for example, us.elb.relay.logtrust.net if you're in the USA)
    • The Devo collector 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)

    Check the required collector / ELB endpoint and URLs according to your platform deployment in the requirements table of the Planning Devo Relay deployment article.





    If you select one of the available clouds, you'll be asked if you're using a dedicated collector / ELB or not. Type Y if you're using a dedicated collector (in this case, you'll need to enter the collector endpoint and port), or n if you're not.

    If you are not sure about this choice, contact the Devo support team.

     

    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.

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

    Finally, 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


     

  4. Now you must activate the relay in the Devo app. Go to Administration → Relays, find your relay on the list and click the Activate button that appears next to its name.

After activating the relay, it will stay in Applying config status for some time. This status is represented with the color yellow in the application. The relay should turn to Active status in a few seconds, and its status color will change to green. Learn more about the Devo Relay status workflow here.

Check the status of your relay

You can check your relay status anytime by using the status command on the CLI. Learn more about working on the CLI in this article.

Reconfigure your relay

To relaunch the configuration process at any time after the installation, simply repeat the setup process again.

  • No labels