Iofogctl Platform YAML Specification

iofogctl allows users to deploy Edge Compute Networks ('ECNs'). The various resources which constitute an ECN are specified within YAML files for iofogctl to consume.

Note for those upgrading from a previous version

We have updated the yml spec significantly, and while these are small changes in practice, your current yml files will fail to deploy on 1.3.0

To translate your yml files to the new spec, please see these quick changes

Control Plane

The Control Plane is the overarching component containing specifications for Controllers and associated credentials.

apiVersion: iofog.org/v1
kind: ControlPlane # What are we deploying
metadata:
  name: buffalo
  namespace: default
spec:
  iofogUser:
    name: Foo
    surname: Bar
    email: user@domain.com
    password: g9hr823rhuoi
  controllers:
    - name: vanilla
      host: 30.40.50.3
      ssh:
        user: foo
        keyFile: ~/.ssh/id_rsa
        port: 22
    - name: kubernetes
      kube:
        config: ~/.kube/config
        replicas: 2

Field	Description
iofogUser	Credentials registered against ioFog Controller REST API.
controllers	List of Controller instances. See Controller section for more details.

Controller

Controllers are components of an ECN responsible for executing the workload of the Control Plane. You can define individuals Controllers for the purposes of expanding your Control Plane. Most of the time, however, you will deploy your Controllers through the Control Plane spec.

apiVersion: iofog.org/v1
kind: Controller # What are we deploying
metadata:
  name: alpaca
  namespace: default # Optional, iofogctl namespace to use
spec:
  # Only required for non-K8s deployment
  host: 30.40.50.5
  ssh:
    user: foo
    keyFile: ~/.ssh/id_rsa
    port: 22 # Optional, defaults to 22
  # Only required for K8s deployment
  kube:
    config: ~/.kube/config
    staticIp: 34.23.14.6 # Optional
    replicas: 1 # Optional, defaults to 1
    serviceType: LoadBalancer # Optional, defaults to "LoadBalancer"

Field	Description
name	User-defined unique identifier of Controller instance within an iofogctl namespace. Must start and end with lowercase alphanumeric character. Can include '-' character.
host	Hostname of remote host that iofogctl must SSH into to install Controller service.
ssh.user	Username of remote host that iofogctl must SSH into to install Controller service.
ssh.keyFile	Path to private SSH key that iofogctl must use to SSH into remote host to install Controller service.
ssh.port	Port to use with SSH
kube.config	Path to Kubernetes configuration file that iofogctl uses to install Controller service to Kubernetes cluster.
kube.staticIp	Pre-existing static IP address for Kuberneretes Load Balancer service to use.
kube.replicas	Number of Controller Pods to deploy on Kubernetes cluster.
kube.serviceType	Kubernetes service type for Controller (one of `LoadBalancer`, `NodePort` or `ClusterIP`)

Connector

Connectors are components of an ECN responsible for handling messaging between Microservices.

apiVersion: iofog.org/v1
kind: Connector # What are we deploying
metadata:
  name: tiger
  namespace: default # Optional, iofogctl namespace to use
spec:
  # Only required for non-K8s deployment
  host: 30.40.50.5
  ssh:
    user: foo
    keyFile: ~/.ssh/id_rsa
    port: 22 # Optional, defaults to 22
  # Only required for K8s deployment
  kube:
    config: ~/.kube/config

Field	Description
name	User-defined unique identifier of Connector instance within an iofogctl namespace. Must start and end with lowercase alphanumeric character. Can include '-' character.
host	Hostname of remote host that iofogctl must SSH into to install Connector service.
ssh.user	Username of remote host that iofogctl must SSH into to install Connector service.
ssh.keyFile	Path to private SSH key that iofogctl must use to SSH into remote host to install Connector service.
ssh.port	Port to use with SSH
kube.config	Path to Kubernetes configuration file that iofogctl uses to install Connector service to Kubernetes cluster.

Note that at the moment Connector does not support specifying Replicas or ServiceType the same way as Controller does.

Agent

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

apiVersion: iofog.org/v1
kind: Agent # What are we deploying
metadata:
  name: meerkat
  namespace: default # Optional, iofogctl namespace to use
spec:
  host: 30.40.50.6
  ssh:
    user: foo
    keyFile: ~/.ssh/id_rsa
    port: 22 # Optional, defaults to 22

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

Edge Compute Network

An entire ECN can be specified within a single YAML file.

Multiple resources can be incorporated into a single YAML file using --- as a separator.

---
apiVersion: iofog.org/v1
kind: ControlPlane
metadata:
  name: buffalo
  namespace: default
spec:
  iofogUser:
    name: Serge
    surname: Radinovich
    email: serge@edgeworx.io
    password: mysecretpw
  controllers:
    - name: alpaca-1
      host: 30.40.50.3
      ssh:
        user: serge
        keyFile: ~/.ssh/id_rsa
    - name: alpaca-2
      host: 30.40.50.4
      ssh:
        user: serge
        keyFile: ~/.ssh/id_rsa
---
apiVersion: iofog.org/v1
kind: Connector
metadata:
  name: zebra
  namespace: default
spec:
  host: 30.40.50.5
  ssh:
    user: serge
    keyFile: ~/.ssh/id_rsa
---
apiVersion: iofog.org/v1
kind: Agent
metadata:
  name: hippo-1
  namespace: default
spec:
  host: 30.40.50.6
  ssh:
    user: serge
    keyFile: ~/.ssh/id_rsa
---
apiVersion: iofog.org/v1
kind: Agent
metadata:
  name: hippo-2
  namespace: default
spec:
  host: 30.40.50.7
  ssh:
    user: serge
    keyFile: ~/.ssh/id_rsa

You can also use this approach to deploy a subset of the ECN by omitting any of the Control Plane, Connectors, or Agents sections.