Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

View file
nameHanoi Release Notes-v2v4.pdf
height250

Release Date: November 8th, 2020

Namer: Joan Duran

The Hanoi Release is the 7th successful community release of EdgeX Foundry.  It is a minor (dot) release (version 1.3) and backward compatible with Edinburgh (1.0), Fuji (1.1) and Geneva (1.2) along with any patch releases of the 1.x releases.

...

This release includes many core data and core metadata service V2 APIs.  The device and application services have also been outfitted with new V2 APIs.  These first APIs allow for device and device service provisioning and setup.  Provisioning is a critical element of EdgeX "thing" management and serves as a good place to gauge the new V2 APIs effectiveness.

Adopter Warnings

Per the Geneva release in the spring 2020, the EdgeX community deprecated three EdgeX features.  This includes MongoDB support, the Support Logging Service, and the Support Rules Engine (which wrapped Java-based Drools rules engine).  These services remain but are still deprecated in Hanoi in order to maintain backward compatibility.  EdgeX adopters should make plans to move away from these services. The community will remove these in an upcoming major release (currently forecast for the Ireland release in the spring of 2021).

...

Please see the Issues List in EdgeX Foundry Github repositories for known bugs.  In any repository Issue List, look for issues with the “Bug” label – such as https://github.com/edgexfoundry/edgex-go/labels/bug for bugs in the main repository of edgex-go.

  • In the case where a large number devices are connected through a device service, and the device service is restarted, the maximum HTTP request size (for Go Lang applications this is 10MB) may be exceeded when the device service restarts and makes call to Core Metadata for all relevant devices and device profile information. This issue is being addressed in the V2 API to be released with Ireland release (spring 2021).  Although it requires some custom coding, there are workarounds to this issue.  Connect with the EdgeX community via Slack (https://edgexfoundry.slack.com/archives/CE44YG81E) if you need assistance if this issue is applicable to your use case.
  • When a device is locked / unlocked via core metadata (via set of AdminState update), the callback to the device service is not notified of the change. See https://github.com/edgexfoundry/edgex-go/issues/2880.

General

  • Migration of the platform to Go 1.15
  • Upgraded to Redis 6
  • A program to vet and approve 3rd party libraries and modules
  • Restructure of the Docker Compose Files and make facility to create them (removing a lot of duplicate code and the need for users to uncomment for specific service needs). The Docker Compose files now take advantage of the multi-file Compose approach.
  • Corrected service Dockerfiles to use CMD versus ENTRYPOINT
  • Snap artifacts now being managed, built and released to the Snap store by Canonical. The EdgeX Snap names have also been transferred to Canonical.
  • EdgeX web site refresh
  • Introduction of the User Self-Endorsement program (see EdgeX Wiki).
  • Design of Device Service to Application Service communication via message bus (bypassing Core Data).
  • Adoptions of Conventional Commits specification across EdgeX repositories
  • Use of Dependabot to watch for and create pull requests on dependency upgrades
  • EdgeX Documentation refactor; improvements, cleanup and refactor
  • Upgraded to new releases of Vault (1.5.3), Kong (2.0.5), Consul (1.8), Kuiper (1.0).
  • Removed all RAML API specification documents and moved all API documentation to Swagger (also provided in SwaggerHub).
  • Created a new edgex-examples repository and moved all project examples to this repository. Developed policies and procedures for managing and maintaining these examples.

...