Draft: Porter to Incubation

[schristoff]

Porter Incubation Application

v1.5
This template provides the project with a framework to inform the TOC of their conformance to the Incubation Level Criteria.

Project Repo(s): GetPorter/Porter
Project Site: porter.sh

Sub-Projects: Porter Operator, Porter Mixins
Communication: #porter and #porter-maintainers in CNCF Slack

Project points of contacts:

• Sarah Christoff (sarah.christoff13@gmail.com
• Steven Gettys (Steven.Gettys@gmail.com)
• Troy Connor
• Kim Christensen
• Brian DeGeeter

Incubation Criteria Summary for Porter

Adoption Assertion

The project has been adopted by the following organizations in a testing and integration or production capacity:
*
See Adopters

Application Process Principles

Suggested

N/A

Required

• Give a presentation and engage with the domain specific TAG(s) to increase awareness
  • 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.

• 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.
  Installation Docmentation
  Best Practices

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.

Governance.MD

• 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.
  Biweekly meetings are recorded and put on Youtube.

• Governance clearly documents vendor-neutrality of project direction.

• 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).
  Contribution Ladder discusses roles, how to become each role, and removal.
  

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

ContributionLadder has emeritus, inactivity period, and covers involuntary removal.

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

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

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

Six

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

Owners.MD

• Document agreement that the project will adopt CNCF Code of Conduct.

Porter CoC (CNCF CoC)

• CNCF Code of Conduct is cross-linked from other governance documents.

CoC

• All subprojects, if any, are listed.

Porter Operator

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.
  ContributionLadder.MD

Required

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

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

Contact in Readme

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

Contact in Readme

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

Yes, recently updated! (and is on website)

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

Contributing.MD

• Demonstrate contributor activity and recruitment.
  Insights

Engineering Principles

Suggested

• Roadmap change process is documented.

Proposal Documentation

• History of regular, quality releases.

Latest, Canary and Quarterly 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.

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

What is Porter?

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

This Github project board that feeds into our release board

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

There’s a lot in the website’s documentation, but this one is significant.

• Document the project's release process.

Releases

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.

We leverage Github security reporting, and have it documented in the SECURITY.md

• 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 enforced by getporter organization

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

SECURITY.md

• 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.)
  ADOPTERS.md

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

To be completed by the TOC

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.

Porter Mixins are extensions of Porter that interact with other Open Source tools, such as Terraform, Helm, and Spin. Contributors are encouraged to make their own mixins with the use of our Skeletor template.
The Porter Operator is also an Operator that enables a Kubernetes native usage of Porter.