1.2.0
Core ConceptsQuick Start
Prepare Your Remote HostsPrepare Your NetworkSetup Your Control PlaneSetup Your AgentsSetup All-in-one
IntroductionGet To Know ioFogManage Your MicroservicesCreate Your First Microservice - JavaScriptDeploy Your Microservice
Introduction to iofogctlIofogctl YAML SpecificationPlatform ToolsHelm Guide
OverviewSDKDebugging
DiagnosticsHardware Abstraction LayerBluetooth REST API
JSON REST API And Open Weather Map
OverviewCLI UsageREST API Reference
OverviewCLI UsageAPI Reference
OverviewCLI UsageLocal API Reference
GuidelinesCode of Conduct

Quick Start

In this guide we will:

  • Install the prerequisites and tools required to create and manage ECN's ('Edge Compute Networks')
  • Create an ECN on a local machine to demonstrate the processes and components involved in an ECN

Prerequisites

Install iofogctl on Mac

Mac users can use Homebrew:

brew tap eclipse-iofog/iofogctl
brew install iofogctl@1.2

Install iofogctl on Linux

The Debian package can be installed like so:

curl -s https://packagecloud.io/install/repositories/iofog/iofogctl/script.deb.sh | sudo bash
sudo apt-get install iofogctl=1.2.5

And similarly, the RPM package can be installed like so:

curl -s https://packagecloud.io/install/repositories/iofog/iofogctl/script.rpm.sh | sudo bash
sudo yum install iofogctl-1.2.5-1.x86_64

Verify iofogctl Installation

Run iofogctl version to verify you have successfully installed the CLI.

Deploy ioFog Locally

You can use iofogctl deploy to install and provision ioFog software. Now we will deploy ioFog locally by specifying localhost in the host fields of our yaml file.

Go ahead and paste the following commands into your terminal:

echo "---
controllers:
  - name: LocalController
    host: localhost
    iofoguser:
      name: Quick
      surname: Start
      email: user@domain.com
      password: q1u45ic9kst563art

agents:
 - name: LocalAgent
   host: localhost" > /tmp/quick-start.yaml
iofogctl deploy -f /tmp/quick-start.yaml

After the deployment has successfully completed, we can verify the resources we specified in the YAML file are running on our local machine.

iofogctl get all

View the Edge Compute Network

To have a quick look at the local ECN, we can run:

iofogctl get all

Teardown

To remove our ECN and any microservices deployed on it, we can run the following command:

iofogctl delete all

Next Steps

Now that you have seen what ioFog is about, you can create a real ECN with remote hosts. Instructions are found here.

You can also try deploying Microservices on the local ECN. You can follow the tutorial found here.