CNCF Incubation Checklist

Checklist to Ensure Envoy Gateway Conforms to all CNCF Incubation Project Requirements

Required

• Engage with the domain specific TAG(s) to increase awareness through a presentation or completing a General Technical Review.
  • This was completed and occurred on DD-MMM-YYYY, and can be discovered at $LINK.

• TAG provides insight/recommendation of the project in the context of the landscape

• All project metadata and resources are vendor-neutral. - Nothing that I can think of, please raise an issue if you find one.

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

• Due Diligence Review.

Completion of this due diligence document, resolution of concerns raised, and presented for public comment satisfies 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.
  • The Envoy Gateway website provides comprehensive documentation for the project, covering installation, configuration, API documentation, tutorial tasks, and more.

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.
  • The governance documentation can be found here.

• 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.

• Governance is up to date with actual project activities, including any meetings, elections, leadership, or approval processes.

• Governance clearly documents vendor-neutrality of project direction.
  • The project goals and objectives are documented in GOALS.md , which is vendor-neutral.

• Document how the project makes decisions on leadership, contribution acceptance, requests to the CNCF, and changes to governance or project goals.

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

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

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

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

Required

• Document complete list of current maintainers, including names, contact information, domain of responsibility, and affiliation.

• A number of active maintainers which is appropriate to the size and scope of the project.
  • The Envoy Gateway project currently has six maintainers who actively manage all aspects of the project, including contributing code, reviewing PRs, triaging issues, and more. The full list of maintainers can be found in the OWNERS.md.

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

• Document adoption of the CNCF Code of Conduct
  • Envoy Gateway follows the CNCF Code of Conduct, which is declared in CODE_OF_CONDUCT.md.

• CNCF Code of Conduct is cross-linked from other governance documents.
  • CNCF Code of Conduct is cross-linked in the project README.md and the project website.

• (Not applicable) All subprojects, if any, are listed.

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.

Required

• Clearly defined and discoverable process to submit issues or changes.

• 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.
  • Slack channel and community meetings are listed and documented in the README.md.

• Up-to-date public meeting schedulers and/or integration with CNCF calendar.

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

• Demonstrate contributor activity and recruitment.

Engineering Principles

Suggested

• Roadmap change process is documented.

• History of regular, quality releases.

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. This can also be satisfied by completing a General Technical Review.

• Document what the project does, and why it does it - including viable cloud native use cases. This can also be satisfied by completing a General Technical Review.

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

• Document overview of project architecture and software design that demonstrates viable cloud native use cases, as part of the project's documentation. This can also be satisfied by completing a General Technical Review and capturing the output in the project's documentation.

• Document the project's release process.

Security

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

Suggested

N/A

Required

• Clearly defined and discoverable process to report security issues.

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

• Document assignment of security response roles and how reports are handled.

• Document Security Self-Assessment.

• Achieve the Open Source Security Foundation (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.)

• 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.

Refer to the Adoption portion of this document.

• Clearly documented integrations and/or compatibility with other CNCF projects as well as non-CNCF projects.

Additional Information