1.3.0
Core ConceptsQuick StartMinikube and Vagrant, the Kubernetes local stack
IntroductionPrepare Your Remote HostsPrepare Your Kubernetes ClusterPrepare Your NetworkSetup Your Control PlaneSetup Your ConnectorsSetup Your Agents
IntroductionGet To Know ioFogManage Your MicroservicesCreate Your First Microservice - JavaScriptDeploy Your Microservice
Introduction to iofogctlCommon Header YAML SpecificationPlatform YAML SpecificationAgent configuration YAML SpecificationApplication YAML Specification
Platform ToolsHelm Guide
OverviewSDKDebugging
Controller microservices overviewSystem: DiagnosticsSystem: Hardware Abstraction LayerSystem: Bluetooth REST APIJSON REST API And Open Weather Map
OverviewLegacy CLI UsageREST API Reference
OverviewLegacy CLI UsageAPI Reference
OverviewLegacy CLI UsageLocal API Reference
GuidelinesCode of Conduct

Iofogctl agent configuration YAML specification

iofogctl allows users to deploy ioFog resources that are specified in YAML files.

Agent configuration

Agent configuration YAML files let you configure an ioFog Agent provisioned with your Controller.

An agent configuration can be retrieved using iofogctl describe agent-config <AGENT_NAME>

An agent configuration can be deployed using iofogctl deploy -f agent-config.yaml

apiVersion: iofog.org/v1
kind: AgentConfig
metadata:
  name: agent-1 # ioFog Agent name
spec:
  # All fields are optional - Only the specified fields will be updated
  name: agent-1
  description: agent running on VM
  latitude: 46.204391
  longitude: 6.143158
  agentType: auto
  dockerUrl: unix:///var/run/docker.sock
  diskLimit: 50
  diskDirectory: /var/lib/iofog-agent/
  memoryLimit: 4096
  cpuLimit: 80
  logLimit: 10
  logDirectory: /var/log/iofog-agent/
  logFileCount: 10
  statusFrequency: 10
  changeFrequency: 10
  deviceScanFrequency: 60
  bluetoothEnabled: true
  watchdogEnabled: false
  abstractedHardwareEnabled: false
Field Description
name User-defined unique identifier of an agent within an ioFog Controller. Must start and end with lowercase alphanumeric character. Can include '-' character.
description Short description of the agent
latitude Latitude coordinate of the agent. The ioFog Agent will automatically try to detect its own latitude if it has access to the internet
longitude Longitude coordinate of the agent. The ioFog Agent will automatically try to detect its own longitude if it has access to the internet
agentType Architecture type of agent. It will be used to determine which image gets deployed. The accepted values are auto, x86 and arm. auto will have the ioFog agent detect the architecture it is running on, and report it to the ioFog controller. It defaults to auto if it fails to parse the value.
dockerUrl Docker engine socket
diskLimit Limit, in GiB, of disk space that the software is allowed to use
diskDirectory Set the directory to use for disk storage
memoryLimit Set the limit, in MiB, of RAM memory that the software is allowed to use for messages
cpuLimit Set the limit, in percentage, of CPU time that the software is allowed to use
logLimit Set the limit, in GiB, of disk space that the log files can consume
logDirectory Set the directory to use for log file storage
logFileCount Set the number of log files to evenly split the log storage limit
statusFrequency Set the status update frequency
changeFrequency Set the get changes frequency
deviceScanFrequency Set the scan devices frequency
bluetoothEnabled Boolean. Set on/off for the bluetooth service. If ON, this will install the restblue microservice
watchdogEnabled Boolean. If enabled, watchdog will kill all docker containers running on the agent if they are not part of the microservices deployed by ioFog. If enabled, only docker containers started by the agent process will be allowed to run
abstractedHardwareEnabled Boolean. Set on/off the HAL services. If ON, this will install the HAL microservice