Eclipse Kura 5.1.0 Release Review

Type
Release
State
Successful
End Date of the Review Period

Reviews run for a minimum of one week. The outcome of the review is decided on this date. This is the last day to make comments or ask questions about this review.

Project
Eclipse Kura
Release

5.1.0

Description

This minor release of Eclipse Kura, compatible with Java 8 and OSGi R7, introduces new framework features like gpsd support, EDGE AI, Container management from Kura, device log management and reporting.

It also introduces new gateway profiles with the important addition of Ubuntu 20 64 bits for Intel Up 2 and Raspberry Pi.

 

Features

  • Position service gpsd support
  • Docker container with Ubi8
  • Docker Container Management API, with containers as Kura configurable components and INVENTORY-V1 integration
  • EDGE AI APIs and NVIDIA Triton reference implementation and corresponding wire component.
  • Log Management APIs and implementation with Web UI integration
  • Network configuration snapshot-only based
  • H2DB database update to 2.1.210 and required data service adaptations
  • CONF-V2 and WIRE-V1 new REST APIs and Request Handlers
  • Configurable PPP logging policy in kura.properties file
  • Added the jax-rs provider multipart dependency
  • Support for snapshot in JSON format
  • Asset update to support scale, offset and unit in numeric channels
  • Web Ui and user admin implementation update to support forced password change on first login
  • Wi-Fi 5Ghz refactoring and enhancements 
  • New platforms support with Intel Up 2 with Ubuntu 20, Raspberry Pi Ubuntu 20 and NVIDIA Jetson Nano

 

Breaking Changes

  • Eclipse Kura v5.1 does not introduce API breakage with previous releases.
  • The H2DB package has been updated from 1.4.199 to 2.1.210 in response to CVEs that affected the dependency. The new package introduces breaking changes (documented in https://github.com/eclipse/kura/pull/3728), both in database persistence format and behaviour, that will make existing persisted databases not usable with the latest version. Manual migration is required as the H2db project does not provide an automated upgrade solution. 

 

Deprecated APIs

  • org.eclipse.kura.position.PositionService (Partial)
  • org.eclipse.kura.net.NetworkService (partial)
  • org.eclipse.kura.net.wifi.WifiConfig (partial)

 

New Hardware Platforms and Distributions

  • Intel Up 2 with Ubuntu 20
  • Raspberry Pi Ubuntu 20
  • NVIDIA Jetson Nano

 

Target Platform Updates

  • com.h2database.h2=2.1.210
  • com.google.protobuf=3.19.3
  • com.eclipsesource.jaxrs.provider.multipart=2.2.0.201602281253
  • org.apache.commons.commons-net=3.8.0
  • org.apache.commons.commons-io=2.11.0
  • com.eurotech.gpsd4java=1.0.0
  • org.eclipse.jetty.continuation=9.4.44.v20210927
  • org.eclipse.jetty.http=9.4.44.v20210927
  • org.eclipse.jetty.io=9.4.44.v20210927
  • org.eclipse.jetty.security=9.4.44.v20210927
  • org.eclipse.jetty.server=9.4.44.v20210927
  • org.eclipse.jetty.servlet=9.4.44.v20210927
  • org.eclipse.jetty.util=9.4.44.v20210927
  • org.eclipse.jetty.util.ajax=9.4.44.v20210927

 

Architectural Issues

This release of Kura does not introduces API breaking changes but deprecases few APIs especially in networking. This release due to the H2DB update introduces a functional breaking change.

The project has also started a review of the supported platforms, in order to be able to concentrate the support to a more defined set of targets.

Security Issues

No new CVEs for Eclipse Kura have been reported or solved in this release.

We have updated the main framework dependencies to reduce the list of possible affecting CVEs.

The updated dependencies lists is the following:

  • com.h2database.h2=2.1.210
  • com.google.protobuf=3.19.3
  • com.eclipsesource.jaxrs.provider.multipart=2.2.0.201602281253
  • org.apache.commons.commons-net=3.8.0
  • org.apache.commons.commons-io=2.11.0
  • com.eurotech.gpsd4java=1.0.0
  • org.eclipse.jetty.continuation=9.4.44.v20210927
  • org.eclipse.jetty.http=9.4.44.v20210927
  • org.eclipse.jetty.io=9.4.44.v20210927
  • org.eclipse.jetty.security=9.4.44.v20210927
  • org.eclipse.jetty.server=9.4.44.v20210927
  • org.eclipse.jetty.servlet=9.4.44.v20210927
  • org.eclipse.jetty.util=9.4.44.v20210927
  • org.eclipse.jetty.util.ajax=9.4.44.v20210927
Conforms To UI/UX Guidelines
Not verified
End of Life

The following APIs have been marked as deprecated:

  • org.eclipse.kura.position.PositionService (Partial)
  • org.eclipse.kura.net.NetworkService (partial)
  • org.eclipse.kura.net.wifi.WifiConfig (partial)
Communities

Issues related to the Kura v5.1 release: https://github.com/eclipse/kura/issues?q=is%3Aissue+project%3Aeclipse%2Fkura%2F7+

Pull Requests related to the Kura v5.1 release: https://github.com/eclipse/kura/pulls?q=is%3Apr+project%3Aeclipse%2Fkura%2F7+

Links
GitLab tracking issue