Page History

NOTE:  California has been released.  See the release page for details of this release.

Delivery:  ~June 2018

The main theme for the California release of EdgeX is to provide a solid open source foundation for commercialization and deployment in a wide variety of Industrial IoT edge use cases. 

Key to this is the first implementation of priority APIs and reference microservices for security and manageabilitysecurity infrastructure.  Another key theme for the California release is improving overall performance and lowering the baseline footprint of the code base.  Work is currently underway for California offers drop-in alternatives for key microservices (e.g. Core Services, Export and Device Services) all EdgeX microservices based in Go Lang with a stretch goal being select implementations in C.  Overall, the California release will improve EdgeX ease of use among a larger, more polyglot, development community.  Planned features to be delivered (as of January 2018 TSC Face-to-Face meeting).

Release Themes and Objectives

• Deliver top priority security and system management APIs and reference implementations of supporting microservices initial security infrastructure (e.g. reverse proxy, key management)
• Deliver on promise for a performant, reliable IoT edge platform
• Reduce overall footprint by an order of magnitude through alternative microservice implementations in Go Lang and possibly Cwith future services (especially device services) in languages like C/C++
• Enable near real-time performance (see targets below)
• Improved Improve and overhauled overhaul the documentation set - moving developer documentation to GitHub
• Device Service SDKs in Go Lang and C/C++
• Blackbox tests for the entire EdgeX API set
• Arm 64 native testing - with continuous integration processes extended to produce artifacts and support the native testing
• Performance tests on startup time, request/response times on all APIs, latency to actuation from device service collection, through core data, to rules engine, command back to a device service.
  • Performance metric testing will include CPU and memory usage statistics
• Not MVP, but additional contributions sought for
  • Provide additional reference connectivity
    • Export Services (e.g. AWS/Greengrass)
    • Device Services (e.g. OPC-UA)
  • Demonstration of EdgeX in real-world POC/test bed, including through possible collaboration with the IIC

General Release Tasks and Notes

• Expand hardware support
  • Arm
• Not MVP, but additional contributions sought for
  • Alternate (from Docker/Docker Compose) deployment and orchestration options

Micro Service Tasks and Notes

• Meet all performance targets
  • New reference implementations of all micro services in Go Lang (C/C++)
• Implement security & system management API hooks
• Not MVP, but additional contributions sought for
  • Improved and more dynamic configuration
  • Better Export Services flexibility/SDK-like elements

General Release Tasks and Notes

• Expand hardware support - ARM 64
  EdgeX has been built to be cross platform.  Some micro services (such as those written in Go) require compiling to the native platforms (cross compiling).  Once the program artifacts for the platform have been created, they also need to be containerized (example: in Docker container).  Generally, the containerization is platform dependent, but there are exceptions.  Finally, it is also desired that the micro services be tested on their native platform.  While virtual machines and simulation environments can allow functional tests to occur, some issues and performance metrics for that platform can only be identified when running on the target platform.  This task therefore includes:
  • CI process that includes cross compiling for Intel/Arm platform artifacts
  • Micro service Docker container images produced for Intel and Arm platforms
  • Native platform testing of the micro services on Intel and Arm platforms

• Improve and overhaul the documentation set
  Moving developer documentation from Wiki to GitHub so that it is updated/maintained/reviewed like code is (through formal pull requests, etc.).  This allows the documentation to also be versioned with the code-base.  Use of standard documentation tools and processes, allow the documentation to be “built” by the CI processes and released in more user friendly (and portable) fashion.

• Blackbox tests for the entire EdgeX API set
  Prior to the California release, there have been blackbox REST API tests against the core services (core-data, core-metadata, core-command).  Additional blackbox REST API coverage is being added for the supporting services (logging, notifications, scheduler, etc.), export services (export-client, export-distro), and device services (some of which will apply to the SDK and can be used against generic device services built by the SDK).

• Meet initial performance targets
  While more requirements from the field are needed, the overall performance targets for EdgeX are listed at the bottom of this page and include running all the core, support and application micro services in < 1GB or RAM on a 64 bit CPU, requiring less than 32GB of disk storage space, start (collectively) in under 1 minute and actuate from sensor collection to device trigger in < 1 second.

Core & Supporting Service Tasks and Notes

• Convert all core and supporting services to Go Lang.  Many of the services have been refactored since the California Preview so as to align better with Go Lang patterns and practices.
• Upgrade of Consul (from 0.7 to 1.0)

Export Service Tasks and Notes

• Convert export services to Go Lang. 
• In addition to the previously existing HTTP/HTTPS, MQTT/MQTTS, Azure IoT Hub, and Google IoT Core “north side”export capability, additional north side connectors are provided to include XMPP, ThingsBoard, and Brightics IoT

Device Service SDK and Device Service Tasks and Notes

• While new device service SDKs (and associated device services) did not make this release, requirements and design for Go and C based SDKs are to be completed.  New SDKs and device services will be released between California and the Delhi release as they become available.

System Management Task and Notes

• Provide a preliminary set of requirements and general roadmap for system management (or micro service management) to guide implementation in future releases.
• Provide alternative SDK langauge support in Go Lang and possibly C
• Implement security & system management API hooks
• Not MVP, but additional contributions sought for
  
• Provide SDK Tool plugins to facility developers
  • Ex:  Eclipse plugin
  • SDK download (non-github oriented)
• Provide new and/or updated Device Services
  • Real BACnet or BLE
  • Additional DS (i.e. Zigbee, OPC-UA, CANBus, …)
• Reduce/optimize Java DS (remove Spring Framework, etc.)
Updates to SDK get propagated back out to existing DS via common shared libraries

Security Tasks and Notes

A
• Institute an OS reverse proxy
will be selected and integrated to EdgeX

• Integrate with AAA service (see below)

• With no (or very few) changes to existing micro services at this time

Currently looking at Traefik for dev/test and possibly NginX for prod

• (Kong) to protect the micro service APIs from unauthorized outside requests.
  • This will be for HTTP/S only (meaning security for MQTT and other protocols will not yet be provided)

• An open source Authentication and Authorization server (s). (E.G., Keycloak, Dex, Hydra, …) will be selected and integrated to EdgeX

Prod deployment models will require integration with centralized AAA.  Initial solution will be to integrate with reverse proxy
• • With no (or very few) changes to existing micro services at this time
• Data Protection Services via HashiCorps’s Vault
will be
• is integrated with EdgeX
  This will provide Key Management
, Certificate Services, Encryption

• API abstraction to allow 3rd party implementation/extensions

• Some additional research/work needs to be finalized for California around license, external CA support, local crypto library, bootstrap provisioning, local secure store for bootstrap credentials, unattended startup

• Security testing framework

System Management Tasks and Notes

• /secret storage for EdgeX going forward (to include certs, passwords, etc.)

DevOps Task & Notes

• Blackbox testing is automated with error results provided to interested parties.
  This feature helps to maintain the EdgeX APIs over time and insure that changes to the code base do on effect the micro service interfaces.
• Automated ARM 64 builds, testing and artifact production have been instituted on 3rd party platforms

• System management API (action, alerts, metric) as discussed and outlined here

System management Agent

Target Performance

• The target is to run all of EdgeX (all the services to include the virtual device service) on a Raspberry Pi 3 (1 GB RAM, 64bit CPU, at least 32GB storage space, running Raspbian Linux distro)

  • This is not an endorsement of the platform as our favorite or otherwise endorsed platform

  • It only suggests the general characteristics of a “developer community” target platform

  • This may not be entirely feasible without all Go replacements, but is the target and the development community will report back when/where this is not possible

  • For example, it is unlikely the target security implementation will fit on this size platform

• Additional “developer community” targets

• Startup in 1 minute or less (post OS boot – from micro service start to all services up and available)

• Throughput for one piece of data (with one IP device connected by hard wire – versus WiFi) from data ingestion at the Device Service layer, through Core Data, to Rules Engine and back down through Command Service finally to Device Service for actuation will be < 1 second