EdgeX Foundry - Stage 3 - 2023-09-06
Completed by: Jim White, IOTech Systems
Submitted to TAC Mail List: 2023/9/6
Presented on TAC Weekly Call: 2023/9/6 (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
2 TAC Sponsors, if identified (Sponsors help mentor projects) - See full definition on Project Stages: Definitions and Expectations | Meets | Joe Pearson (IBM), Trevor Conn (Dell) |
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 EdgeX policy 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 | Displayed proudly on the EdgeX wiki home page:
Also on our website: |
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
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. |
Document that it is being used in POCs. | Meets | EdgeX is used in countless POCs worldwide so this list is actually more about production uses.
|
Demonstrate a substantial ongoing flow of commits and merged contributions. | Meets | Collected from LF Insights for the project since inception and for the last 1 year |
| |||||||||
Demonstrate that the current level of community participation is sufficient to meet the goals outlined in the growth plan. | Meets | 12 successful project releases since April 2017 (2 each year)
On track for two more releases in the next year: 3.1 (code named Napa) in fall of 2023, and a likely our second LTS release. The spring of 2023 will release "Odessa." It may be a dot release (to be determined). | |||||||
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 |
|
Stage 2 Projects, please skip to Additional Information Requested from All Projects
Stage 3: Impact Stage
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, HP, Eaton, Oracle, and Beechwoods. For names and details see: https://wiki.edgexfoundry.org/pages/viewpage.action?pageId=88212178 Each TSC group continues to be a good mix of experienced EdgeX leaders with new members and organizations becoming involved. |
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. 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 artefact is defined here: https://docs.edgexfoundry.org/1.2/design/adr/devops/0007-Release-Automation/ Significant new features are discussed via TSC approved Use Case Review (UCR) process to better refine the way in which new requirements are defined, and the Architectural Decision Records (ADR) stage of the design. |
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
|
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 |
|
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. EdgeX adheres to, follows and enforces the LF Edge Code of Conduct without addendum today. |
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. | Meets | Examples of these documents can be found in our main repository https://github.com/edgexfoundry/edgex-go Additionally, project governance and committer process is fully documented in our Wiki. 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 |
Have a public list of project adopters for at least the primary repo (e.g., ADOPTERS.md or logos on the project website). | Meets | Our main repository contains the Adopter document (see https://github.com/edgexfoundry/edgex-go/blob/main/ADOPTERS.md) We also highlight user, adopters and commercial interests of EdgeX on our Website. |
Additional Information Requested from All Projects
Intention for the upcoming year (Remain at current stage OR advance towards the next Stage) | Remain Impact Project, release our second LTS |
Include a link to your project’s LFX 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://insights.lfx.linuxfoundation.org/projects/lfedge%2Fedgex-foundry/dashboard;quicktime=time_filter_3Y |
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 19 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:
Many organizations have adopted, adopting or are considering the adoption of EdgeX and related products including:
Others who have adopted EdgeX and related products:
|
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. Over 9 million container downloads. Regular releases for 6+ years, including the 3rd major release, second Long Term Support coming this year, indicating the stability of EdgeX to the marketplace. Per our plan, we moved from Slack to Github discussions. Slack has the 10K limit and is not good for historical searches. Travel restrictions / travel budgets still hamper the project's ability to have face-to-face meetings, but we did manage to hold a couple of virtual hackathons. |
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 a LTS release targeted for fall 2023 with a likely minor release for spring of 2024 (dependent on some external aspects such as embedded products and move to BSL). Looking to continue to grow the user base with more publicly referenced adopters. Integration to some very large scale customers and industrial use cases. |
How can LF Edge help you achieve your upcoming goals? | We have to explore joint live events for 2024. |
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.) |
|
Are you leveraging the Technical Project Getting Started Checklist? If yes, please provide link (if publicly available). | This was developed after our project launched, but we already follow all steps. |
Please review, and update if needed, your Project entry on the Existing Project Taxonomy page, modifying the Last Updated / Reviewed date in the header. | Updated 9/5/23 by Jim White |
Please share a LFX security report for your project in the last 30 days | https://security.lfx.linuxfoundation.org/#/a0941000005osNnAAI/overview Issues remain with LF over the accuracy of this system. Attempts to get it corrected have never materialized despite repeated attempts and tickets. |