Edge Tutorial

Create

  1. On your ClearBlade Platform, Click on the + Add Edge button which is highlighted below.

  2. Give a name to your edge with a suitable description

  3. Finally, click on the Create button to create the edge.

  4. The edge should appear in the list.

  5. You can view the settings for an edge by clicking on the gear icon button to the right of a particular Edge and clicking ‘Settings’.

Install and Start

  1. Click on the Set up instructions icon button for the Edge that was created in the previous step

  2. Select the operating system the Edge will be installed on from the Target dropdown in the set up dialog If the target operating system you wish to install the edge on is not listed, we recommend you install VirtualBox (or any other virtualizer) and create a virtual machine with one of the target operating systems listed in the dropdown.

  3. Once the operating system has been selected, a install command will be displayed for you to copy and paste in a terminal. Open a terminal prompt on the target operating system and run the command. You will have the option whether to just want to run the edge or run the edge with the console

  4. In the ‘Start’ section, enter the IP address of the machine the Edge was installed on into the Edge IP field (see parameters). This will also be use to access the edge console.

  5. Copy and paste the startup command (also use the Console command if you ran the console)

Your edge should now be connected and you should have access to its console

Edge-Linux Options

Select a Linux option (such as Linux-x86_64) as the target. Separate ‘Edge’ and ‘Console’ install and startup commands will appear.

There will be an ‘Options’ button next to each command.

Edge Options

Option Description
Generate Config Creates a configuration file to run the edge as a service
Disable Prompts Run the script without prompts (Not Recommended)
Dry Run A practice run of the startup process

Console Options

Option Description
Check Certificates Enables certificates to be checked when making requests to the platform
Edge Treats console as an edge binary when enabled
Console Errors Enables sending JS errors from the console to this web server
Portal Errors Enables sending JS errors from the portal to this web server

Other options can be configured in the generated config file at /etc/clearblade/config.toml

Remote Login

To get access to the Edge console (notice that it says “not logged in” ), you must click on the Edge you want to access and login with your email and password that you use for the ClearBlade platform.

You should now be able to see the Edge console.

Upgrade Edge

An older version of the Edge has to be running on your device when you do Over the Air updates.

If you are using the console to upgrade your edge, you need to do one of these tasks first:

  1. If your edge binary is stored in any of the system directories (i.e /usr/local/bin etc), you need to start your edge using sudo OR

  2. If you don’t want to use sudo, you need to move your edge binary to a location where your user has permissions to read/write files.

This is required because we need access to the filesystem to backup the old edge binary and store the new binary.

  1. Choose the Edge(s) you want to upgrade and click ‘Upgrade Edges’.

  2. Verify the Edge(s) and versions being updated and click ‘Update’.

  3. The upgrade will start and be monitored on your platform. Changes will appear on your terminal. Once the upgrade is completed, click ‘Done’.

  4. The Edge(s) should now be updated and the new version should be listed.