[Incubation] Metal3.io Incubation Application

[kashifest]

Metal3.io Incubation Application

Project Repo(s): https://github.com/metal3-io
Project Site: https://metal3.io/
Sub-Projects: NA
Communication: https://github.com/metal3-io/community?tab=readme-ov-file#socializing

Project points of contacts:
Adam Rozman, [email protected]
Dmitry Tantsur, [email protected]
Kashif Khan, [email protected]
Tuomo Tanskanen, [email protected]
Zane Bitter, [email protected]

Incubation Criteria Summary for Metal3.io

Adoption Assertion

The project has been adopted by the following organizations in a testing and integration or production capacity:
*
Metal3.io Adopters are tracked here https://github.com/metal3-io/community/blob/main/ADOPTERS.md

Other open source projects that are utilizing Metal3:

• Airship
• Cluster API
• DT Technik "Das SCHIFF"
• OpenShift
• Sylvia-Projects
• Kanod
• Medik8s

Furthermore maintainers have noticed that there are many more companies that are actively using Metal3, as representatives of said companies are opening issues, writing proposals and in general contribute to the project but have not registered themselves as official adopters.

Application Process Principles

Suggested

N/A

Required

• Give a presentation and engage with the domain specific TAG(s) to increase awareness
• Presented on tag-runtime meeting for 18-07-2024, and can be discovered at https://www.youtube.com/watch?v=YhGOd9jhWog&t=932s.

• TAG provides insight/recommendation of the project in the context of the landscape
• To be done by Tag Runtime

• All project metadata and resources are vendor-neutral.
• Yes. Metal3.io is utilizing CNCF provided vendor neutral resources for communication, testing , hosting and governance.

• Review and acknowledgement of expectations for Sandbox projects and requirements for moving forward through the CNCF Maturity levels.
• Met during Project's application on 08-09-2020.

• Due Diligence Review.

• To be done by TOC
  Completion of this due diligence document, resolution of concerns raised, and presented for public comment satisifies the Due Diligence Review criteria.

• Additional documentation as appropriate for project type, e.g.: installation documentation, end user documentation, reference implementation and/or code samples.

• Installation documentation - https://book.metal3.io/developer_environment/tryit

• End user documentation- https://book.metal3.io/

• Blog posts - https://metal3.io/blog/index.html

Governance and Maintainers

Note: this section may be augmented by the completion of a Governance Review from TAG Contributor Strategy.

Suggested

• Clear and discoverable project governance documentation.
• Project Governance
• Community healthcheck and governance repository

• Governance has continuously been iterated upon by the project as a result of their experience applying it, with the governance history demonstrating evolution of maturity alongside the project's maturity evolution.
• Metal3.io project Governance has iterated organically as it has gained experienced over the years. Contributor Roles and contributor ladder processes are streamlined over the past years as well as team member onboarding/offboarding process is well defined. The Project has currently 17 maintainers and it has received contributions from 426 contributors who come from 60 different companies.

• Governance is up to date with actual project activities, including any meetings, elections, leadership, or approval processes.
• Yes, governance repository is kept up to date according to project activities. List of PRs that keep these documents and repository up to date can be found here https://github.com/metal3-io/community/pulls?q=is%3Apr+is%3Aclosed

• Governance clearly documents vendor-neutrality of project direction.
• Metal3 Vendor neutrality document

• Document how the project makes decisions on leadership, contribution acceptance, requests to the CNCF, and changes to governance or project goals.
• Maintainer governance
• Contributor Roles
• Contributor ladder
• Contributing guide

• Document how role, function-based members, or sub-teams are assigned, onboarded, and removed for specific teams (example: Security Response Committee).
• Maintainer governance
• Contributor Roles
• Contributor ladder

• Document a complete maintainer lifecycle process (including roles, onboarding, offboarding, and emeritus status).

• Maintainer governance

• Contributor Roles

• Contributor ladder

• Demonstrate usage of the maintainer lifecycle with outcomes, either through the addition or replacement of maintainers as project events have required.

• Here are some examples:
  Adding maintainer: metal3-io/metal3-dev-env@da6b2a9
  Moving maintainer to emeritus: metal3-io/baremetal-operator@75c649d

• If the project has subprojects: subproject leadership, contribution, maturity status documented, including add/remove process.
• NA

Required

• Document complete list of current maintainers, including names, contact information, domain of responsibility, and affiliation.
• Metal3.io Maintainers
• Maintainer Processes

• A number of active maintainers which is appropriate to the size and scope of the project.
• Metal3.io has 17 active maintainers

• Code and Doc ownership in Github and elsewhere matches documented governance roles.
• DCO
• Contributor Guide

• Document agreement that project will adopt CNCF Code of Conduct.
• Metal3.io follows CNCF Code of Conduct

• CNCF Code of Conduct is cross-linked from other governance documents.
  Yes. https://github.com/metal3-io/community/blob/main/GOVERNANCE.md

• All subprojects, if any, are listed.
  NA

Contributors and Community

Note: this section may be augmented by the completion of a Governance Review from TAG Contributor Strategy.

Suggested

• Contributor ladder with multiple roles for contributors.
• Contributor ladder

Required

• Clearly defined and discoverable process to submit issues or changes.
• Example issue template
• Example Contributing Guide

• Project must have, and document, at least one public communications channel for users and/or contributors.

• List and document all project communication channels, including subprojects (mail list/slack/etc.). List any non-public communications channels and what their special purpose is.
• Communication channels

• Up-to-date public meeting schedulers and/or integration with CNCF calendar.
• Project has applied to be integrated with CNCF calendar

• Documentation of how to contribute, with increasing detail as the project matures.
• Example Contributing Guide

• Demonstrate contributor activity and recruitment.
• Metal3.io devstat dashboard
• Metal3 has had 426 individual contributors
  on the project’s GitHub repositories from 60 different organizations.
• The project has 906 Stargazers/Watchers and 455 forks across its repositories.
• DevStats graph
  shows that we have a fairly consistent number of contributions throughout the past year.
• CloMonitor stats also shows Metal3 is doing fairly well in CNCF best practice metrics.
• In addition, we have a very high number of downloads of our container images from quay.io. Since the download statistics is not publicly visible, we are not adding any link. As an example of our traction the aggregated number of container image downloads from the Metal3's container repository from 20-11-2023 to 19-12-2023 was on average 14830 and the peak was 40,584 during a single day.

Engineering Principles

Suggested

• Roadmap change process is documented.
• Community Roadmap

• History of regular, quality releases.
  We started releasing major components even before we were accepted as Sandbox and since then we have stream lined the release process and added more component releases from different repositories across the organizations. Here are the release pages
• Cluster API Provider Metal3
• Baremetal Operator
• IP Address Manager
• Ironic Image

Required

• Document project goals and objectives that illustrate the project’s differentiation in the Cloud Native landscape as well as outlines how this project fulfills an outstanding need and/or solves a problem differently.
• Project Goal

• Document what the project does, and why it does it - including viable cloud native use cases.
• Metal³ user-guide

• Document and maintain a public roadmap or other forward looking planning document or tracking mechanism.
• Project Roadmap
• Roadmap Process Documentation

• Document overview of project architecture and software design that demonstrates viable cloud native use cases, as part of the project's documentation.
• Metal³ user-guide

• Document the project's release process.
• Release Process

Security

Note: this section may be augemented by a joint-assessment performed by TAG Security.

Suggested

N/A

Required

• Clearly defined and discoverable process to report security issues.
• Project security policy

• Enforcing Access Control Rules to secure the code base against attacks (Example: two factor authentication enforcement, and/or use of ACL tools.)
• Two factor authentication is enforced.

• Document assignment of security response roles and how reports are handled.
• Project security policy
• Security team

• Document Security Self-Assessment.
• WIP add security self-assessment document metal3-io/metal3-docs#456

• Achieve the Open Source Security Foundation (OpenSSF) Best Practices passing badge.
• OpenSSF Best Practices passing badge

Ecosystem

Suggested

N/A

Required

• Publicly documented list of adopters, which may indicate their adoption level (dev/trialing, prod, etc.)
  Metal3.io Adopters are tracked here https://github.com/metal3-io/community/blob/main/ADOPTERS.md

Other open source projects that are utilizing Metal3:

• Airship
• Cluster API
• DT Technik "Das SCHIFF"
• OpenShift
• Sylvia-Projects
• Kanod
• Medik8s

Furthermore maintainers have noticed that there are many more companies that are actively using Metal3, as representatives of said companies are opening issues, writing proposals and in general contribute to the project but have not registered themselves as official adopters.

• Used in appropriate capacity by at least 3 independent + indirect/direct adopters, (these are not required to be in the publicly documented list of adopters)

The project provided the TOC with a list of adopters for verification of use of the project at the level expected, i.e. production use for graduation, dev/test for incubation.

• TOC verification of adopters.
• To be done by TOC

Refer to the Adoption portion of this document.

• Clearly documented integrations and/or compatibility with other CNCF projects as well as non-CNCF projects.
• The Metal3 stack integrates into Kubernetes Cluster API which is a CNCF project.
• Metal3's IPAM is also used by cluster-api-provider-vsphere's CI. Cluster-api-provider-vsphere is a sub-project of sig-cluster-lifecycle and is a CNCF supported project.
  Other open source projects that are utilizing Metal3:
• Airship
• Cluster API
• DT Technik "Das SCHIFF"
• OpenShift
• Openstack Ironic
• Sylvia-Projects
• Kanod
• Medik8s

Additional Information

[kashifest]

This issue is opened with reference to our incubation proposal opened earlier last year here #1231

[Rozzii]

Just adding some example that was left out from the "Demonstrate usage of the maintainer lifecycle with outcomes, either through the addition or replacement of maintainers as project events have required."

Adding maintainer: metal3-io/metal3-dev-env@da6b2a9
Moving maintainer to emeritus: metal3-io/baremetal-operator@75c649d

[angellk]

@kashifest Thank you for re-submitting the application with the new template. Moving this to Metal3's current place in the queue on the project board.

[racedo]

@angellk is there any other input we can provide to help moving this forward? Thanks!

[TheFoxAtWork]

This is ideally next for TOC assignment contingent on expertise alignment of TOC members

[angellk]

@kashifest @racedo @Rozzii
In preparation for Metal3.io to be picked up by a TOC member after the KubeCon freeze period -- and prior to TOC member assignment -- please:

• review the definition of an adopter
• verify 5-7 project adopters that can and are willing to be interviewed by the TOC reviewer(s) and
• submit information for each adopter to the Adopter Interview Questionnaire form.
• complete the in-progress Security Self Assessment

[kashifest]

@angellk thanks a lot for the heads up, we are already working on the steps you suggested.

[tuminoid]

• complete the in-progress Security Self Assessment

metal3-io/metal3-docs#456 has been completed and merged in metal3-docs.

[rochaporto]

@angellk thanks a lot for the heads up, we are already working on the steps you suggested.

Ping us here when you've submitted the adopter information, you're next in the queue.

[kashifest]

Ping us here when you've submitted the adopter information, you're next in the queue.

We have submitted 4 Adopter's contact information now, for the 5th we are gathering the contact information as we speak.

[kashifest]

Ping us here when you've submitted the adopter information, you're next in the queue.

We have submitted 4 Adopter's contact information now, for the 5th we are gathering the contact information as we speak.

And now we have submitted 5th Adopter information as well.

[angellk]

@rochaporto confirmed the Adopter information is captured in the sheet - Metal3.io is ready to be picked up for Due Diligence post freeze.

[rochaporto]

Thanks @angellk . @kashifest will reach out soon for a kick-off.

[rochaporto]

Status update:

• slack channel for quick iterations with the project
• 4 adopter interviews completed ( 1 more being scheduled )
• ongoing DD review of the project