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

Common Header YAML Specification

The most important commands of iofogctl consume YAML files as input. A YAML file consists of one or more resources. Every resource contains a header section and a spec section. The header section contains fields common to all resources defined within the spec section.

apiVersion: iofog.org/v1
kind: ControlPlane
metadata:
  name: buffalo
  namespace: default # Optional, defaults to value specified by iofogctl namespace flag
spec:
Field Description
apiVersion ioFog YAML schema version. Currently iofog.org/v1
kind String representing what type of resource we want to deploy. The available values are ControlPlane, Controller, Connector, Agent, AgentConfig, Application and Microservice.
metadata Object containing metadata about the resource
metadata.name User defined, unique identifier of the resource in its namespace.
metadata.namespace Optional. Will force iofogctl to work in this specific namespace (If specified, it overwrites the -n CLI option)
spec Object containing the deployment specifications, different for each resource