cncf / cncf/toc

[Incubation] CloudNativePG Incubation Application

Open
#1,961 8 comments 118 reactions 2 assignees Claimed by @jrsapi View on GitHub
dd/status/in-progress kind/dd level/incubation needs-triage toc
Dominant language
HTML
Stars
1.9k
Forks
724
Avg merge
6d 12h
Merged PRs (30d)
4

Description

# Review Project Moving Level Evaluation
- [x] I have reviewed the TOC's [moving level readiness triage guide](https://github.com/cncf/toc/blob/main/operations/dd-toc-guide.md#initial-triageevaluation-prior-to-assignment), ensured the criteria for my project are met before opening this issue, and understand that unmet criteria will result in the project's application being closed.

# CloudNativePG Incubation Application
v1.6
This template provides the project with a framework to inform the TOC of their conformance to the Incubation Level Criteria.

Project Repo(s): https://github.com/cloudnative-pg/cloudnative-pg
Project Site: https://cloudnative-pg.io/
Sub-Projects: See https://github.com/cloudnative-pg/governance/blob/main/COMPONENT-OWNERS.md
Communication: #cloudnativepg-users on CNCF Slack

Project points of contacts:

- Armando Ruocco, armando.ruocco@enterprisedb.com, @armru
- Floor Drees, floor.drees@enterprisedb.com, @FloorD
- Francesco Canovai, francesco.canovai@enterprisedb.com, @fcanovai
- Gabriele Bartolini, gabriele.bartolini@enterprisedb.com, @gbartolini
- ~~Jonathan Gonzalez, jonathan.gonzalez@enterprisedb.com, @sxd~~
- Leonardo Cecchi, leonardo.cecchi@enterprisedb.com, @leonardoce
- Marco Nenciarini, marco.nenciarini@enterprisedb.com, @mnencia
- ~~Philippe Scorsolini, philippe.scorsolini@upbound.io, @phisco~~

- [ ] (Post Incubation only) [Book a meeting with CNCF staff](http://project-meetings.cncf.io) to understand project benefits and event resources.

## Incubation Criteria Summary for $PROJECT

### Application Level Assertion

- [X] This project is currently Sandbox, accepted on 20250121, and applying to Incubation.
- [ ] This project is applying to join the CNCF at the Incubation level.

### Adoption Assertion

_The project has been adopted by the following organizations in a testing and integration or production capacity:_

See the official [Adopters](https://github.com/cloudnative-pg/cloudnative-pg/blob/main/ADOPTERS.md) file.

*Note:* We can also provide large end-users who are yet to become public but could be interested in private conversations with the CNCF TOC.

## Application Process Principles

### Suggested

N/A

### Required

- [X] **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 25-Sept-2024, and can be discovered at https://www.youtube.com/watch?v=Nsu5Em8Ig88.

- [X] **All project metadata and resources are [vendor-neutral](https://contribute.cncf.io/maintainers/community/vendor-neutrality/).**

- [X] **Review and acknowledgement of expectations for [Sandbox](https://sandbox.cncf.io) 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.

- [X] **Additional documentation as appropriate for project type, e.g.: installation documentation, end user documentation, reference implementation and/or code samples.**

- [Installation & upgrade](https://cloudnative-pg.io/documentation/current/installation_upgrade/)
- [Quickstart](https://cloudnative-pg.io/documentation/current/quickstart/)
- [Architecture](https://cloudnative-pg.io/documentation/current/architecture/)
- [CNPG Playground](https://github.com/cloudnative-pg/cnpg-playground)

## Governance and Maintainers

Note: this section may be augmented by the completion of a Governance Review from the Project Reviews subproject.

### Suggested

- [X] **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.**

- The project has recently adopted [issues in the Governance project](https://github.com/cloudnative-pg/governance/issues) with gitvote for public and transparent votes.

- [X] **Clear and discoverable project governance documentation.**

- [Governance Project](https://github.com/cloudnative-pg/governance/blob/main/GOVERNANCE.md)

- [X] **Governance is up to date with actual project activities, including any meetings, elections, leadership, or approval processes.**

- https://github.com/cloudnative-pg/governance/blob/main/GOVERNANCE.md#maintainers
- https://github.com/cloudnative-pg/cloudnative-pg/blob/main/CONTRIBUTING.md

- [X] **Governance clearly documents [vendor-neutrality](https://contribute.cncf.io/maintainers/community/vendor-neutrality/) of project direction.**

- https://github.com/cloudnative-pg/governance/blob/main/GOVERNANCE.md#values

- [x] **Document how the project makes decisions on leadership, contribution acceptance, requests to the CNCF, and changes to governance or project goals.**

- https://github.com/cloudnative-pg/governance/blob/main/GOVERNANCE.md#maintainers

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

- https://github.com/cloudnative-pg/governance/blob/main/GOVERNANCE.md#project-roles

- [x] **Document a complete maintainer lifecycle process (including roles, onboarding, offboarding, and emeritus status).**

- https://github.com/cloudnative-pg/governance/blob/main/GOVERNANCE.md#project-roles

- [x] **Demonstrate usage of the maintainer lifecycle with outcomes, either through the addition or replacement of maintainers as project events have required.**

- https://github.com/cloudnative-pg/governance/blob/main/GOVERNANCE.md#project-roles

- [x] **If the project has subprojects: subproject leadership, contribution, maturity status documented, including add/remove process.**

- https://github.com/cloudnative-pg/governance/blob/main/COMPONENT-OWNERS.md

### Required

- [x] **Document complete list of current maintainers, including names, contact information, domain of responsibility, and affiliation.**

- https://github.com/cloudnative-pg/governance/blob/main/MAINTAINERS.md

- [x] **A number of active maintainers which is appropriate to the size and scope of the project.**

- [x] **Code and Doc ownership in Github and elsewhere matches documented governance roles.**

- Every project has a `GOVERNANCE.md` file that points to the main one in the `governance` project. For example, this is the [GOVERNANCE.md file for CloudNativePG](https://github.com/cloudnative-pg/cloudnative-pg/blob/main/GOVERNANCE.md).

- [x] **Document adoption and adherence to the CNCF Code of Conduct or the project's CoC which is based off the CNCF CoC and not in conflict with it.**

- https://github.com/cloudnative-pg/governance/blob/main/CODE_OF_CONDUCT.md

- [x] **CNCF Code of Conduct is cross-linked from other governance documents.**

- Example: [CoC from CloudNativePG](https://github.com/cloudnative-pg/cloudnative-pg/blob/main/CODE_OF_CONDUCT.md)

- [x] **All subprojects, if any, are listed.**

- All projects are listed under the organisation: https://github.com/cloudnative-pg

## Contributors and Community

Note: this section may be augmented by the completion of a Governance Review from the Project Reviews subproject.

### Suggested

- [x] **Contributor ladder with multiple roles for contributors.**

- We currently have only component owners and maintainers as they seem good enough for now. But we might explore different ones before or after incubation. See: https://github.com/cloudnative-pg/governance/blob/main/GOVERNANCE.md#project-roles

### Required

- [x] **Clearly defined and discoverable process to submit issues or changes.**

- https://github.com/cloudnative-pg/cloudnative-pg/blob/main/CONTRIBUTING.md

- [x] **Project must have, and document, at least one public communications channel for users and/or contributors.**

- https://github.com/cloudnative-pg/cloudnative-pg/blob/main/CONTRIBUTING.md
- https://github.com/cloudnative-pg/cloudnative-pg/tree/main?tab=readme-ov-file#communications

- [x] **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.**

- https://github.com/cloudnative-pg/cloudnative-pg/tree/main?tab=readme-ov-file#communications

- [x] **Up-to-date public meeting schedulers and/or integration with CNCF calendar.**

- https://github.com/cloudnative-pg#cloudnativepg-community-meetings
- https://zoom-lfx.platform.linuxfoundation.org/meetings/cloudnativepg?view=week

- [x] **Documentation of how to contribute, with increasing detail as the project matures.**

- [Generic contributions](https://github.com/cloudnative-pg/cloudnative-pg/blob/main/CONTRIBUTING.md)
- [Source contributions](https://github.com/cloudnative-pg/cloudnative-pg/blob/main/contribute/README.md)
- [Developer Certificate of Origin](https://github.com/cloudnative-pg/cloudnative-pg/blob/main/contribute/developer-certificate-of-origin)
- [Developmnet environment setup](https://github.com/cloudnative-pg/cloudnative-pg/blob/main/contribute/development_environment/README.md)
- [E2E testing procedure](https://github.com/cloudnative-pg/cloudnative-pg/tree/main/contribute/e2e_testing_environment)
- [Linux Foundation Mentorship program fro CNPG](https://github.com/cloudnative-pg/cloudnative-pg/blob/main/contribute/lfx-mentorship-program.md)
- [Release procedure](https://github.com/cloudnative-pg/cloudnative-pg/blob/main/contribute/release_procedure.md)

- [x] **Demonstrate contributor activity and recruitment.**

- https://cloudnativepg.devstats.cncf.io/d/66/developer-activity-counts-by-companies?orgId=1
- https://insights.linuxfoundation.org/project/cloudnativepg/contributors?timeRange=past365days
- https://insights.linuxfoundation.org/project/cloudnativepg/popularity?timeRange=past365days

## Engineering Principles

### Suggested

- [x] **Roadmap change process is documented.**

- https://github.com/cloudnative-pg/cloudnative-pg/blob/main/ROADMAP.md

- [x] **History of regular, quality releases.**

- https://github.com/cloudnative-pg/cloudnative-pg/releases

### Required

- [x] **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._**
- _If applicable_ a General Technical Review was completed/updated on DD-MMM-YYYY, and can be discovered at $LINK.

- https://github.com/cloudnative-pg/cloudnative-pg?tab=readme-ov-file#scope
- https://github.com/cloudnative-pg/cloudnative-pg/blob/main/docs/src/faq.md

- [x] **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.**

- https://cloudnative-pg.io/documentation/current/
- https://cloudnative-pg.io/documentation/current/use_cases/
- https://cloudnative-pg.io/documentation/current/operator_capability_levels/

- [x] **Document and maintain a public roadmap or other forward looking planning document or tracking mechanism.**

- https://github.com/cloudnative-pg/cloudnative-pg/blob/main/ROADMAP.md

- [x] **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._**
- _If applicable_ a General Technical Review was completed/updated on DD-MMM-YYYY, and can be discovered at $LINK.

- https://github.com/cloudnative-pg/cloudnative-pg/blob/main/contribute/technical-architecture.md
- https://cloudnative-pg.io/documentation/current/architecture/
- https://cloudnative-pg.io/documentation/current/controller/
- https://cloudnative-pg.io/documentation/current/container_images/
- https://cloudnative-pg.io/documentation/current/imagevolume_extensions/

- [x] **Document the project's release process.**

- [Release procedure](https://github.com/cloudnative-pg/cloudnative-pg/blob/main/contribute/release_procedure.md)

## Security

### Suggested

N/A

### Required

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

- [x] **Clearly defined and discoverable process to report security issues.**

- https://github.com/cloudnative-pg/cloudnative-pg/blob/main/SECURITY.md

- [x] **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.**

- https://github.com/cloudnative-pg/cloudnative-pg/security

- [x] **Document [Security Self-Assessment](https://tag-security.cncf.io/community/assessments/guide/self-assessment/).**

- [x] **Achieve the Open Source Security Foundation (OpenSSF) Best Practices passing badge.**

- https://www.bestpractices.dev/en/projects/9933

## Ecosystem

### Suggested

N/A

### Required

- [x] **Publicly documented list of adopters, which may indicate their adoption level (dev/trialing, prod, etc.)**

- https://github.com/cloudnative-pg/cloudnative-pg/blob/main/ADOPTERS.md
- https://cloudnative-pg.io/end_users/

- [x] **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.

- [x] **Clearly documented integrations and/or compatibility with other CNCF projects as well as non-CNCF projects.**

- https://cloudnative-pg.io/documentation/current/cncf-projects/external-secrets/
- https://cloudnative-pg.io/documentation/current/cncf-projects/cilium/
- https://github.com/cloudnative-pg/postgres-keycloak-oauth-validator

## Additional Information

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.