Managing Devo Relay using the command line

[ 1 Introduction ] [ 2 Start the relay ] [ 3 Stop the relay ] [ 4 Restart the relay ] [ 5 Check the status of the relay service ] [ 6 Check the relay logs ] [ 7 Upgrade the relay ] [ 8 Post-upgrade procedure ] [ 9 Uninstall the relay ]

Introduction

Ubuntu / Red Hat / CentOS	The relay is a Java process that runs as a service in the machine and is managed by the system manager `systemd`.
docker-compose	The provided docker-compose file contains two services (devo-ng-relay and devo-ng-relay-cli). Note that the CLI service does not need to be running all the time - it will just run while the CLI is in use. Find below the commands that can be used to perform the most common operations. You must be in the same folder where the .yml file is located to run these commands.

Start the relay

To start your relay, use the required command according to your OS:

Ubuntu / Red Hat / CentOS	`sudo systemctl start devo-ng-relay`
docker-compose	`docker-compose run --rm devo-ng-relay-cli`

Stop the relay

You can stop your relay process using these commands:

Ubuntu / Red Hat / CentOS	`sudo systemctl stop devo-ng-relay`
docker-compose

Restart the relay

Restart a relay process using these commands:

Ubuntu / Red Hat / CentOS
docker-compose

Check the status of the relay service

You can check the status of the relay Java service using this command:

Ubuntu / Red Hat / CentOS	Note that this command checks the status of the service that runs the relay, not the relay itself. To check the status of your current relay, you must use the relay CLI. Learn more in Working with the Devo Relay CLI.

Check the relay logs

As the relay runs as a systemd service, the logs can be consulted using the following commands:

Ubuntu / Red Hat / CentOS	You can use the -f flag to actively follow the logs as they are being written
docker-compose	You can use the -f flag to actively follow the logs as they are being written

Upgrade the relay

Use the following commands to update your relay and CLI to the last version available:

Ubuntu
Red Hat / CentOS
docker-compose	Open the docker-compose.yml file and update the image version to be used for each service (relay and CLI), or just one if you want to upgrade one of the services only. devo-ng-relay service: devo-ng-relay-cli service: Then, run the required command to perform the upgrade: If you want to upgrade the devo-ng-relay service, run the following command. The old devo-ng-relay container will be stopped and a new one will be created based on the new image selected. If you want to update the devo-ng-relay-cli service, use the command below. The CLI will download the new image and use it the next time it is executed.

Post-upgrade procedure

The following procedure is intended to apply the effective configuration in Devo Relay when using the docker version. Due to a limitation in the product, the configuration is not propagated properly to the docker volume and it needs to be recreated.

Uninstall the relay

Use the following commands to uninstall the relay from your machine:

Ubuntu
Red Hat / CentOS
docker-compose