EdgeX Foundry - Stage 3 - 2020-08-26


Completed by:  Jim White, IOTech Systems (EdgeX TSC Chair)

Submitted to TAC Mail List:  2020/08/19

Presented on TAC Weekly Call:  2020/08/26 (Meeting Recording)




Below is a self-assessment submitted by TSC Chair/Maintainers of the Project. Comments/questions/feedback is welcome either a) in the Comments at the bottom of the page or b) during the TAC call when information is presented

Stage 1: At Large Projects 

Stage 2 and Stage 3 Projects also requested to complete this section, as PLD acceptance criteria requires meeting current as well as prior stage requirements

Stage 1 Criteria (from the PLD)

Meets / Needs Improvement / Missing / Not Applicable

Supporting Data (if needed, include links to specific examples)

Stage 1 Criteria (from the PLD)

Meets / Needs Improvement / Missing / Not Applicable

Supporting Data (if needed, include links to specific examples)

2 TAC Sponsors, if identified (Sponsors help mentor projects) - See full definition on Project Stages: Definitions and Expectations

Meets

Henry Lau (HP) & Sean McGinnis (Dell) & Joe Pearson (IBM)

The typical IP Policy for Projects under the LF Edge Foundation is Apache 2.0 for Code Contributions, Developer Certificate of Origin (DCO) for new inbound contributions, and Creative Commons Attribution 4.0 International License for Documentation. Projects under outside licenses may still submit for consideration, subject to review/approval of the TAC and Board.

Meets

EdgeX is an Apache 2.0 license project.  We require all contributions comply with this license agreement as stated in our Wiki below.
https://wiki.edgexfoundry.org/pages/viewpage.action?pageId=21823866
Our TSC recently added a policy recently to review new libs, modules, etc. brought into the project to insure anything we use (or is used indirectly by modules we bring in) is compliant with this license. https://wiki.edgexfoundry.org/display/FA/Vetting+Process+for+3rd+Party+Dependencies
We also conduct code scans regularly (with each PR) for any license compliance issues.

Upon acceptance, At Large projects must list their status prominently on website/readme

Meets

Posted on our wiki at the page below.
https://wiki.edgexfoundry.org/display/FA/EdgeX+Foundry+Project+Wiki



Stage 1 Projects, please skip to Additional Information Requested from All Projects

Stage 2: Growth Stage

Stage 3 Projects also requested to complete this section

Stage 2 Criteria (from the PLD)

Meets / Needs Improvement / Missing / Not Applicable

Supporting Data (if needed, include links to specific examples)

Stage 2 Criteria (from the PLD)

Meets / Needs Improvement / Missing / Not Applicable

Supporting Data (if needed, include links to specific examples)

Development of a growth plan (to include both roadmap of projected feature sets as well as overall community growth/project maturity), to be done in conjunction with their project mentor(s) at the TAC.

Meets

We maintain a roadmap for the next 2 years and have a long term backlog that extends beyond that timeframe.  The next couple of releases are documented with pages in our Wiki (and you can see past release roadmaps) here:  https://wiki.edgexfoundry.org/display/FA/Roadmap.
Minor fixes and enhancements are also captured in issues with each repository in Github.  Github tags are used to label bugs from enhancement requests and when appropriate are associated with a specific target release (see https://github.com/edgexfoundry/edgex-go/issues for an example).

Document that it is being used in POCs.

Meets

5 companies recently announced use of EdgeX in their products.  This includes Accenture (AIP+ product), ThunderSoft (TurboX), Jaingxing Intelligence (EdgeBox), and Tibco (Project Air) & HP (Engage Edge).    Many of the company presentations to the EdgeX community can be found at the wiki site below.
https://wiki.edgexfoundry.org/display/FA/Vertical+Solutions+Working+Group#VerticalSolutionsWorkingGroup-MeetingMinutes

HP's announcement is found here:  https://press.hp.com/us/en/blogs/2020/hp-unveils-hp-engage-edge.html

IOTech Systems also provides a commercial implementation of EdgeX called Edge Xpert and uses that is several POC and customer projects around the globe.
Home Edge is using EdgeX in their effort.

Demonstrate a substantial ongoing flow of commits and merged contributions.

Meets

Recorded and reported to the EdgeX TSC monthly.  Most recent report:  https://wiki.edgexfoundry.org/download/attachments/329436/July2020Stats.pdf?version=1&modificationDate=1596653219339&api=v2
180+ contributors globally
~ 30 contributors monthly
~ 1 to 4 new contributors a month
~ 140 commits a month

Demonstrate that the current level of community participation is sufficient to meet the goals outlined in the growth plan.

Meets

6 successful project releases since April 2017 (2 each year)
On track for another release (code named Hanoi) in fall of 2020

Demonstrate evidence of, or a plan for, interoperability, compatibility or extension to other LF Edge Projects. Examples may include demonstrating modularity (ability to swap in components between projects).

Meets

Integration with Akraino ELIOT blueprint (tested using UNH lab)
Incubation of Open Horizon project
Use of EdgeX in HomeEdge and continued support of that project
Working on Fledge connectors



Stage 2 Projects, please skip to Additional Information Requested from All Projects

Stage 3: Impact Stage

Criteria

Meets / Needs Improvement / Missing / Not Applicable

Supporting Data (if needed, include links to specific examples)

Criteria

Meets / Needs Improvement / Missing / Not Applicable

Supporting Data (if needed, include links to specific examples)

Have a defined governing body of at least 5 or more members (owners and core maintainers), of which no more than 1/3 is affiliated with the same employer. In the case there are 5 governing members, 2 may be from the same employer.

Meets

Our current TSC is comprised of members from Intel, Canonical, IOTech, Kong, HP, Beechwoods, and VMWare.  For names and details see:

https://wiki.edgexfoundry.org/pages/viewpage.action?pageId=329436#TechnicalSteeringCommittee(TSC)-Members

Have a documented and publicly accessible description of the project's governance, decision-making, and release processes.

Meets

Matters of project governance, decision making and process are covered in our project Wiki.  The following pages outline our policies.
Matters of technical decisions and voting process and rules are defined here:  https://wiki.edgexfoundry.org/display/FA/Technical+Work+in+the+EdgeX+Foundry+Project

Guidance for how to submit code contributions is defined here:  https://wiki.edgexfoundry.org/display/FA/Contributor%27s+Guide and here: https://wiki.edgexfoundry.org/display/FA/Contributor%27s+Process

Documentation on how our release process and what gets released is here:  https://wiki.edgexfoundry.org/display/FA/Release+Process and some additional information on what is considered a release artifact is defined here:  https://docs.edgexfoundry.org/1.2/design/adr/devops/0007-Release-Automation/

Have a healthy number of committers from at least two organizations. A committer is defined as someone with the commit bit; i.e., someone who can accept contributions to some or all of the project.

Meets

Work group chairs automatically have committer rights to their work group repositories and nominate others as committers as spelled out in our governance here:  https://wiki.edgexfoundry.org/pages/viewpage.action?pageId=21823860#Contributors,Committers&Maintainers-NominationandApprovalofMaintainersandCommitters


Each repository has at least 2 committers.  The most used repository has 70 committers (https://github.com/edgexfoundry/edgex-go/graphs/contributors)

Demonstrate evidence of interoperability, compatibility or extension to other LF Edge Projects. Examples may include demonstrating modularity (ability to swap in components between projects).

Meets

Integration with Akraino ELIOT blueprint (tested using UNH lab)
Incubation of Open Horizon project
Use of EdgeX in HomeEdge and continued support of that project
Working on Fledge connectors

Adopt the Foundation Code of Conduct.

Meets

For any significant community meeting such as the TSC meetings or meeting where we are inviting outside community to speak or observe are always preceded by the code of conduct and anti-trust policy statements.  To date, we have had no unacceptable behavior incidents that the project has been made aware of.

Explicitly define a project governance and committer process. This is preferably laid out in a GOVERNANCE.md file and references a CONTRIBUTING.md and OWNERS.md file showing the current and emeritus committers.

Needs improvement

Project governance and committer process is fully documented in our Wiki, but we do not have these in markdown pages (we have 102 repositories so where to put it?).  We have no list of Emeritus committers.  We can look to improve this with our Hanoi Release documentation.
Existing governance and contributor pages are located on this page and its subpages:  https://wiki.edgexfoundry.org/display/FA/Technical+Work+in+the+EdgeX+Foundry+Project
And here:  https://wiki.edgexfoundry.org/display/FA/Contributor%27s+Guide

Have a public list of project adopters for at least the primary repo (e.g., ADOPTERS.md or logos on the project website).

Needs improvement

We have a list of adopters and uses, but not on an Adopters markdown file on a repository.  We do highlight adopters and commercial interests of EdgeX on our Wiki.  For example, this month we have featured an adopter series of presentations on the main page of the site.  We also have an "EdgeX in Market" page here:  https://www.edgexfoundry.org/edgex-in-market/
We can look to improve the adoption coverage in Github with this upcoming release and add more on adopters with the upcoming Website update.

Additional Information Requested from All Projects

Additional Information Requested from All Projects

Supporting Data (if needed, include links to specific examples)

Additional Information Requested from All Projects

Supporting Data (if needed, include links to specific examples)

Intention for the upcoming year (Remain at current stage OR advance towards the next Stage)

Remain

Include a link to your project’s CommunityBridge Insights page. We will be looking for signs of consistent or increasing contribution activity. Please feel free to add commentary to add color to the numbers and graphs we will see on Insights.

https://lfanalytics.io/projects/lfedge%2Fedgex-foundry/dashboard

How many maintainers do you have, and which organizations are they from? (Feel free to link to an existing MAINTAINERS file if appropriate.)

https://wiki.edgexfoundry.org/pages/viewpage.action?pageId=21823860
WG Chair are maintainers of their respective repositories with additional rights to nominate others (which often happens).  Therefore we have at least 9 maintainers.  Most WG Chairs nominate several maintainers to help with the workload of the incoming code reviews.  For example, the main service repository has 28 maintainers/committers (see https://github.com/orgs/edgexfoundry/teams/edgex-go-committers/members).  A small effort/repository may only have a few maintainers.

What do you know about adoption, and how has this changed since your last review / since you joined the current Stage? If you can list companies that are end users of your project, please do so. (Feel free to link to an existing ADOPTERS file if appropriate.)

We are learning about new adopters all the time.   In addition to the companies that are participating in the construction of EdgeX, the following companies have announced (and presented) on EdgeX adoption:

Accenture, ThunderSoft, HP, Jaingxing Intelligence, Tibco, Certis

How has the project performed against its goals since the last review? (We won't penalize you if your goals changed for good reasons.)

Met or exceeded goals.  Nearing 7 million container downloads.   New adopter stories have been a boost to the project.  Regular releases for 3+ years - indicating stability to the marketplace

What are the current goals of the project? For example, are you working on major new features? Or are you concentrating on adoption or documentation?

Working on Hanoi release targeted for fall 2020.  Details of the release can be found here:  https://wiki.edgexfoundry.org/display/FA/Hanoi+Release
Outside the software itself, the project has focused on:

  • improved documentation and on-boarding assistance for new adopters

  • identifying and highlighting adopters

How can LF Edge help you achieve your upcoming goals?

Slack archive and creation of new user or adopter FAQs from specific tagged Slack messages

Do you think that your project meets the criteria for the next Stage?

We are at stage 3

Please summarize Outreach Activities in which the Project has participated in (e.g. Participation in conferences, seminars, speaking engagements, meetups, etc.)

Regular participation* in Hannover Messe, IOT SWC, IOT World and LF events.  Our members speak frequently in live and virtual events all over the world.  We have had 2 major Hackathon events (Chicago and recently one in China).  We are working with Topcoder on an additional virtual event.

(*) - pre-COVID

Are you leveraging the Technical Project Getting Started Checklist? If yes, please provide link (if publicly available).

Developed after our project launched.