Register a Device#

Device registration is performed via OctaiPipe’s online interface:

Steps#

  1. Login: Access the online portal using your credentials.

  2. Navigate to Device Management:

    • Select “Device Management” from the main menu.

    • Choose “Devices”.

    • Click on the “Import Devices” button in the top-right corner.

Import devices interface

  1. Import Devices:

    • Drag your devices CSV file into the designated upload area.

    • Click on the “Import” button to start the registration process.

  2. Device validation:

    • If any devices failed to register, an error message will be displayed.

    • To view errors per device, click on export to download a CSV with detailed info.

Import device failures

  1. Download docker compose files:

    • Successful device registration will generate docker compose files which provide the configuration to pull and spin up OctaiPipe Edge Client containers on your devices.

    • If all devices can be successfully registered, you will be provided with a zip file containing the docker compose files.

    • Click on the download docker compose files device initialization button.

Import devices success

Device registration CSV format#

The device registration CSV must be formatted as follows, note that these are in camel case and case sensitive:

Field

Description

Notes

deviceId

Your unique device id, you should choose this to ensure you can identify your device

Required

deviceDescription

Further description here can be added here. We recommend being as descriptive as possible.

Optional

os

Operating System of the edge device.

Optional

architecture

Hardware architecture such as AMD or ARM on this edge device.

Optional

influxUrl

If using InfluxDB, provide your InfluxDB URL. If one InfluxDB field is provided then all InfluxDB fields must be provided

Optional

influxToken

Your InfluxDB token

Optional

influxOrg

Your InfluxDB org name

Optional

influxOrgId

Your Influx org id

Optional

grafanaUrl

If usingGrafana deployed by Octaipipe, provide your URL

Optional

Starting OctaiPipe Edge Client#

Once you have downloaded the zip file with docker compose files, transfer the docker compose file to the matching device, e.g. the file “device-1-octaipipe.yml” to device-1

To ensure smooth communication between all OctaiPipe services, please create a docker network on each of your devices:

docker network create octaipipe

After creating the network, you are ready to start the OctaiPipe Edge Client. Run the following from the same directory containing the docker compose file:

docker-compose -f {compose_file_name} up -d

In case you need to see Edge Client logs, run the following:

docker-compose logs -f

Finally to stop the OctaiPipe Edge Client, run:

docker-compose -f {compose_file_name} down