Skip to content

Installation

Edge Builder consists of different components, and these are installed using the following packages:

  • edgebuilder-server. This package installs the Edge Builder server components. For further information on installing the server components, see Install the Server Components
  • edgebuilder-cli. This package installs the Edge Builder CLI. For further information on installing the CLI, see Install the CLI
  • edgebuilder-node. This package installs the Edge Builder node components. For further information on installing the node components, see Manually Install the Node Components

Info

The Edge Builder server and node packages require docker.io. If you have docker-ce installed, you must uninstall it before installing the Edge Builder packages.

The following table shows the distributions, architectures and file type for each package:

Package Minimum System Requirements Distributions Architectures Package Type
edgebuilder-server Dual Core CPU
1GB Memory
4GB Disk
Ubuntu 21.04
Ubuntu 20.04
Ubuntu 18.04
Debian 10
All distributions: amd64 DEB
edgebuilder-node Single Core CPU
300mb Memory
1.5GB Disk
Ubuntu 20.04
Ubuntu 18.04
Debian 10
Raspios-buster
Ubuntu and Debian distributions: amd64 or arm64
Raspios-buster distributions: arm32
DEB
edgebuilder-cli 100MB Disk Linux amd64, arm64, arm32 DEB
RPM

Note

  • The resource usage of the Server Components will scale as the number of Nodes increases. The resource utilisation of the Nodes will increase depending on application workload.

Standard Installation Steps

In a typical deployment, you will only need to install the Server Components and CLI manually. The Node Components will be installed as part of the node provisoning process when Edge Builder is running.

Install the Server Components

To install the Edge Builder server components, run the following command:

sudo sh -c 'wget -O - https://raw.githubusercontent.com/IOTechSystems/edgebuilder-installer/v1.2.0/edgebuilder-install.sh | sh -s - server'

Install the CLI

To install the Edge Builder CLI, run the following command:

sudo sh -c 'wget -O - https://raw.githubusercontent.com/IOTechSystems/edgebuilder-installer/v1.2.0/edgebuilder-install.sh | sh -s - cli'

Optional Installation Steps

Manually Install the Node Components

It is possible to manually install the Node Components ahead of provisoning the Node with Edge Builder. To install the Edge Builder node components, run the following command:

sudo sh -c 'wget -O - https://raw.githubusercontent.com/IOTechSystems/edgebuilder-installer/v1.2.0/edgebuilder-install.sh | sh -s - node'

Edge Builder License

You must have a license to run Edge Builder.

To obtain the Edge Builder license, contact IOTech Support.

The license can be added to Edge Builder via the REST api or CLI.

Next Steps

The best way to get to grips with Edge Builder is to try out our tutorials. These use vagrant to start pre-configured vms allowing you to quickly try out many of Edge Builder's features.

Alternatively you can refer to our Server Components reference to start Edge Builder, and our CLI reference to interact with it.