Creation Review

Type
Creation
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.

Proposal

Eclipse IoT Packages

Wednesday, August 21, 2019 - 05:00 by Jens Reimann
This proposal is in the Project Proposal Phase (as defined in the Eclipse Development Process) and is written to declare its intent and scope. We solicit additional participation and input from the community. Please login and add your feedback in the comments section.
Parent Project
Proposal State
Created
Background

At the moment, Eclipse IoT projects are rather standalone and barely integrated with each other. At least that is the impression one might get, as there is no IoT specific “download” or “getting started” page. Integrations do exist but are hard to find for users.

Over time, people involved in the Eclipse IoT Integration group identified that:

  1. we need to better advertise the existing integrations,
  2. there is no single “Eclipse IoT” stack/package at the moment,
  3. different projects would like to show different integrations.
Scope

This project provides deployment instructions and scripts for deploying packages of Eclipse IoT projects to Kubernetes based platforms using Helm charts. The term package, as used in this proposal, denotes a combination of at least two Eclipse IoT projects which are integrated with each other.

In general, the provided scripts/charts are intended to be helpful with getting started quickly with the given technology. However, scripts/charts may also support production deployments, e.g. by means of configuration properties, but that is not a requirement.

In addition to deployment scripts/Helm charts, this project may contain software needed for the integration of projects. In general, everybody is encouraged to put all scripts and software into the specific Eclipse IoT project. However, for some functionality, integrating A with B, it is hard to decide if this piece of code belongs to either A or B. In that case it may be advisable to host this piece of code in the Eclipse IoT Packages project.

A combination of Eclipse IoT projects would be considered an Eclipse IoT Package ifthe projects use each other’s functionality  and are integrated with each other to some degree. Merely deploying components next to each other is not considered an integration in this sense.

New packages may be added to the project as long as they integrate at least two Eclipse IoT projects with each other.

Each package must only use released versions of all components.

While packages hosted by this project must only use open source components, subject to the terms of the open source license, people may take those packages and extend them on their own, integrating their custom, proprietary, closed source extensions. However, they are then not part of this project but a solution built on Eclipse technology.

Description

The goal of the Eclipse IoT Packages project is to provide a simple getting started experience for Eclipse IoT projects that are integrated with each other. Enabling interested users to get started quickly in their own environment and showing how multiple Eclipse IoT projects can work together, thus acting as a blueprint for custom deployments.

Why Here?

The main goal of this project is to make it easier to consume other Eclipse IoT projects. Therefore hosting this project at the Eclipse Foundation seems natural. Also, the goal is to attract many other Eclipse IoT projects to contribute to this project. So it makes sense to use the governing structures of Eclipse.

Future Work
  • Continue to update the Hono, Ditto, Hawkbit package when new versions of these individual projects get released
  • Advertise the stack: write tutorials, screencasts, …
  • Encourage other projects to provide new integrated packages, or extend existing ones
Project Scheduling
  • Get the project started
  • Announce this during EclipseCon Europe 2019
  • Provide a first integrated package consisting of Hono, Ditto, Hawkbit projects
Committers
Kai Hudalla (This committer does not have an Eclipse Account)
Stefan Maute (This committer does not have an Eclipse Account)
Thomas Jaeckle (This committer does not have an Eclipse Account)
Dominik Guggemos (This committer does not have an Eclipse Account)
Jeroen Lavermann (This committer does not have an Eclipse Account)
Carsten Lohmann (This committer does not have an Eclipse Account)
Mentors
Interested Parties
  • Jens Reimann (Red Hat)
  • Carsten Lohmann (Bosch SI)
  • Dejan Bosanac (Red Hat)
  • Kai Hudalla (Bosch SI)
Initial Contribution

The project will start with an empty code base.

Source Repository Type