Agent YAML Specification

Agents are components of an ECN which run on edge nodes. They communicate with Controllers to allow your edge nodes to host Microservices.

apiVersion: datasance.com/v3
kind: Agent
metadata:
  name: meerkat
  namespace: default
spec:
  host: 30.40.50.6
  ssh:
    user: foo
    keyFile: ~/.ssh/id_rsa
    port: 22
  config:
    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
    upstreamRouters: ['default-router']
    networkRouter: ''
    routerConfig:
      routerMode: edge
      messagingPort: 5672
      edgeRouterPort: 56721
      interRouterPort: 56722
    dockerPruningFrequency: 1
    logLevel: INFO
    availableDiskThreshold: 90
  scripts:
    dir: /tmp/my-scripts
    deps:
      entrypoint: install_deps.sh
    install:
      entrypoint: install_iofog.sh
      args:
        - 3.0.0-alpha1
    uninstall:
      entrypoint: uninstall_iofog.sh

Required Fields

The following fields are necessary for every Agent YAML specification.

Field	Description
name	User-defined unique identifier of Agent instance within an potctl namespace. Must start and end with lowercase alphanumeric character. Can include '-' character.
host	Hostname of remote host that potctl must SSH into to install Agent service.
ssh.user	Username of remote host that potctl must SSH into to install Agent service.
ssh.keyFile	Path to private SSH key that potctl must use to SSH into remote host to install Agent service.
ssh.port	Port to use with SSH. Optional (default: 22).

Installation Plugin Fields

Agents can be specified to require user-defined installation scripts to be executed instead of the default potctl installation procedures.

Custom installation scripts are specified through the optional scripts field in the Agent YAML.

Field	Description
dir	Source directory containing all scripts to be used in Agent installation and uninstallation procedures. All files in this directory are copied to `/etc/iofog/agent/` on the Agent host.
deps	Details pertaining to the script in `scripts.dir` which serves as the entrypoint to installing pre-requisites of ioFog Agent.
install	Details pertaining to the script in `scripts.dir` which serves as the entrypoint to installing ioFog Agent.
uninstall	Details pertaining to the script in `scripts.dir` which serves as the entrypoint to uninstalling ioFog Agent.
*.entrypoint	Name of the script in `scripts.dir` which serves as the entrypoint to a procedure run on the Agent host.
.*.args	List of arguments to be provided to the entrypoint when invoked on the Agent host.

Configuration Fields

The following fields can be specified to modify Agent behaviour.

Note that these values can be overidden after Agent deployment through the AgentConfig kind specified here.

Configuration details are specified through the optional config field in the Agent YAML.

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 in seconds
changeFrequency	Set the get changes frequency in seconds
deviceScanFrequency	Set the scan devices frequency in seconds
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
upstreamRouters	Set the upstream routers (using Agent names or `default-router`)
networkRouter	Set the network router (using Agent names or `default-router`)
host	Hostname used for router communication and public ports. Default: host provided at deploy time.
routerConfig	Set the router configuration
routerConfig.routerMode	Set the router mode. Available values are `edge`, `interior` and `none`. Default: `edge`
routerConfig.messagingPort	Set the router messaging port. Default: 5672
routerConfig.edgeRouterPort	Set the router edge router port. Only valid if routerMode is `interior`. Default: 56721
routerConfig.interRouterPort	Set the router interior router port. Only valid if routerMode is `interior`. Default: 56722
logLevel	Set the standard logging levels that can be used to control logging output
dockerPruningFrequency	Set the docker pruning frequency in hours
availableDiskThreshold	Set the available disk threshold

Agent Configuration YAML Specification

Agent Configuration YAML files let you configure an ioFog Agent provisioned with your Controller. You can use Agent Configuration to modify the behaviour of an Agent after it is deployed.

An Agent Configuration can be retrieved using potctl describe agent-config <AGENT_NAME>

An Agent Configuration can be deployed using potctl deploy -f agent-config.yaml

apiVersion: datasance.com/v3
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
  upstreamRouters: ['default-router']
  networkRouter: ''
  host: 123.123.123.123
  routerConfig:
    routerMode: edge
    messagingPort: 5672
    edgeRouterPort: 56721
    interRouterPort: 56722
  dockerPruningFrequency: 1
  logLevel: INFO
  availableDiskThreshold: 90

Required Fields​

Installation Plugin Fields​

Configuration Fields​

Agent Configuration YAML Specification

Required Fields

Installation Plugin Fields

Configuration Fields