Installation using edgectl
The Edge local service can be installed using our edgectl utility, or by using a manual/scripted installation method. This article explains how to install using edgectl, which you can add download from our repository or through a manual download.
Install edgectl utility from the repository
Follow these steps to install the EdgeIQ SmartEdge service on your edge gateway device using our apt repository. If apt is not available on your system, please skip to the next section for instructions on manually downloading and installing edgectl.
Step 1 - Add the repository
echo "deb [trusted=yes] https://apt.fury.io/edgeiq/ /" > /etc/apt/sources.list.d/edgeiq.list
Step 2 - Update apt
apt update
Step 3 - Install edgectl
apt install edgeiq-edgectl
Manually download the edgectl utility
Follow these steps to install the EdgeIQ SmartEdge service on your edge gateway device.
Step 1 - Download edgectl using wget
NOTE: Replace [YOUR_DEVICE_ARCHITECTURE] with a value that matches your architecture: arm5, armhf, arm64, arm7, or amd64 |
wget https://api.edgeiq.io/api/v1/platform/edgectl/latest/edgectl-linux-[YOUR_DEVICE_ARCHITECTURE]-latest
Step 2 - Move edgectl and change permissions
mv ./edgectl-* ./edgectl && chmod +x ./edgectl
Install Edge using the edgectl utility
Step 1 - Run the following command to begin installation using edgectl.
edgectl install
Step 2 - Select the version. The default is latest.
![Screen Shot 2021-06-18 at 9.10.10 AM.png 1420](https://files.readme.io/3edfc53-Screen_Shot_2021-06-18_at_9.10.10_AM.png)
Step 3 - Type in the installation location. The default is /opt .
![Screen Shot 2021-06-18 at 9.10.02 AM.png 1488](https://files.readme.io/ddd30d5-Screen_Shot_2021-06-18_at_9.10.02_AM.png)
Step 4 - Select platform. The default is generic.
![Screen Shot 2021-06-18 at 9.09.32 AM.png 1486](https://files.readme.io/785d58c-Screen_Shot_2021-06-18_at_9.09.32_AM.png)
Step 5 - Select the network configurer. The default is none.
![Screen Shot 2021-06-18 at 9.09.01 AM.png 1524](https://files.readme.io/7902cd2-Screen_Shot_2021-06-18_at_9.09.01_AM.png)
Step 6 - Select device identifier. The default is MAC of eth0.
![Screen Shot 2021-06-18 at 9.08.05 AM.png 1500](https://files.readme.io/63b6221-Screen_Shot_2021-06-18_at_9.08.05_AM.png)
Auto for device unique ID.
The file name is given.
![Screen Shot 2021-06-18 at 9.07.57 AM.png 1576](https://files.readme.io/c6c3750-Screen_Shot_2021-06-18_at_9.07.57_AM.png)
File for device unique ID.
Step 7 - Enter the account/company ID
![Screen Shot 2021-06-18 at 9.00.08 AM.png 1634](https://files.readme.io/e083bc1-Screen_Shot_2021-06-18_at_9.00.08_AM.png)
Your company ID can be found in the EdgeIQ web portal under Onboard > Accounts > Manage Account > Account ID.
![Screen Shot 2021-06-18 at 8.59.56 AM.png 1938](https://files.readme.io/d906bd3-Screen_Shot_2021-06-18_at_8.59.56_AM.png)
Step 8 - Verify Results
In addition to receiving a "Success" response from edgectl, you should see the device status indicator turn green in the portal. Also, heartbeat payloads should begin appearing according to the configured interval time (the default is 4 hours).
The responses will be similar to what is shown in the figure below.
![Screen Shot 2021-06-18 at 8.58.19 AM.png 1640](https://files.readme.io/998db6d-Screen_Shot_2021-06-18_at_8.58.19_AM.png)
Success
Device Health:
![Screen Shot 2021-06-18 at 8.57.26 AM.png 1854](https://files.readme.io/01c2acc-Screen_Shot_2021-06-18_at_8.57.26_AM.png)
Device Health
Heartbeats:
![Screen Shot 2021-06-18 at 8.57.01 AM.png 2096](https://files.readme.io/c927968-Screen_Shot_2021-06-18_at_8.57.01_AM.png)
Heartbeats
Failure
The most common reason for EdgeIQ installation to fail is the device not being configured in the EdgeIQ platform.
![Screen Shot 2021-06-18 at 8.55.47 AM.png 1810](https://files.readme.io/b51f4d5-Screen_Shot_2021-06-18_at_8.55.47_AM.png)
You see an error similar to "Unable to connect to EdgeIQ, ensure you have the representative device data created in EdgeIQ followed by edge log output."
![Screen Shot 2021-06-18 at 8.54.47 AM.png 2186](https://files.readme.io/2dcb880-Screen_Shot_2021-06-18_at_8.54.47_AM.png)
Updated about 3 years ago