[PROJECT ONBOARDING] CloudNativePG

[mrbobbytables]

Welcome to CNCF Project Onboarding

Sandbox reference issue: #128

This is an issue created to help onboard your project into the CNCF after the TOC has voted to accept your project.

We would like your project to complete onboarding within one month of acceptance.

Please track your progress by using "Quote reply" to create your own copy of this checklist in an issue, so that you can update the status as you finish items.

REQUIRED BEFORE PROCEEDING WITH ONBOARDING

A "Project Contribution Agreement" must be completed and any existing trademarks MUST be transferred to the Linux Foundation BEFORE CNCF staff onboarding tasks can be completed.

• Review and understand the CNCF IP Policy. Ensure you are using a CNCF compatible license; inbound projects must use the Apache 2.0 license or seek approval for exceptions. Licenses for dependencies are covered separately below.
• Review and understand the LF trademark guidelines.
• Transfer any trademark and logo assets to the Linux Foundation via the Contribution Agreement. CNCF staff will send this document to the contact emails listed in the Sandbox application.

---

Review and understand other documents

• The Technical Leadership Principles that outlines the expected behavior for any maintainer in a leadership role.
• The project proposal process and requirements.
• The services available for your project at the CNCF.
• The dependency license allowlist.
• The online program guidelines.
• The telemetry data collection and usage policy.
• Book time with CNCF staff to understand project benefits and event resources.

Contribute and transfer other materials

• Move your project to its own separate neutral GitHub organization. This will make it transferable to the CNCF's GitHub Enterprise account. If it's already in a GHE account, you will need to remove it from that first.
• Accept the invite to join the CNCF GitHub Enterprise account. We'll then add thelinuxfoundation as an organization owner to ensure neutral hosting of your project.
• Migrate your Slack channels (if any) to the Kubernetes or CNCF Slack workspace. CNCF staff can help.
• Join the #maintainers-circle Slack channel.
• Transfer your domain to the CNCF. The "LF Stakeholder email" is projects@cncf.io. The "Project" is CNCF.
• Submit a pull request with your artwork.
• Transfer website analytics to projects@cncf.io. CNCF staff can help.

Update and document project details

• Ensure that DCO (preferred) or CLA are enabled for all GitHub repositories of the project.
• Ensure that that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's README.md on GitHub.
• Ensure LF footer is on your website and guidelines are followed (if your project doesn't have a dedicated website, please adopt those guidelines for the README.md file). The project-specific footer text you should use will be provided in the Contribution Agreement instructions.
• Create a maintainer list and add it to the aggregated CNCF maintainer list via pull request.
• Provide emails for the maintainers to get access to the maintainers mailing list and Service Desk. Email them to project-onboarding@cncf.io.
• Start working on written, open governance and consider adding this to a GOVERNANCE.md file at the root of your repo.
• Start on an OpenSSF Best Practices Badge.

CNCF staff tasks to support the project

• Add the project to DevStats.
• Add the project to CLOmonitor.
• Add the project to LFX Insights. This is done by adding a read-only app to your GitHub organization once it's in CNCF GHE.
• Add the project to LFX Project Control Center.
• Add the project to the Cloud Native Landscape by updating landscape.yml following these instructions.
• Add a license scanning tool, like FOSSA or Snyk.
• Send a welcome email to confirm maintainer list access.

[gbartolini]

Please track your progress by using "Quote reply" to create your own copy of this checklist in an issue, so that you can update the status as you finish items.

REQUIRED BEFORE PROCEEDING WITH ONBOARDING

A "Project Contribution Agreement" must be completed and any existing trademarks MUST be transferred to the Linux Foundation BEFORE further project onboarding tasks can be completed.

• Review and understand the CNCF IP Policy. Ensure you are using a CNCF compatible license; inbound projects must use the Apache 2.0 license or seek approval for exceptions. Licenses for dependencies are covered separately below.
• Review and understand the LF trademark guidelines.
• Transfer any trademark and logo assets to the Linux Foundation via the Contribution Agreement. CNCF staff will send this document to the contact emails listed in the Sandbox application.

---

Review and understand other documents

Tracked in cloudnative-pg/governance#7

• The Technical Leadership Principles that outlines the expected behavior for any maintainer in a leadership role.
• The project proposal process and requirements.
• The services available for your project at the CNCF.
• The dependency license allowlist.
• The online program guidelines.
• The telemetry data collection and usage policy.
• Book time with CNCF staff to understand project benefits and event resources.

Contribute and transfer other materials

• Move your project to its own separate neutral GitHub organization. This will make it transferable to the CNCF's GitHub Enterprise account. If it's already in a GHE account, you will need to remove it from that first.
• Accept the invite to join the CNCF GitHub Enterprise account. We'll then add thelinuxfoundation as an organization owner to ensure neutral hosting of your project.
• Migrate your Slack channels (if any) to the Kubernetes or CNCF Slack workspace. CNCF staff can help.
• Join the #maintainers-circle Slack channel.
• Transfer your domain to the CNCF. The "LF Stakeholder email" is projects@cncf.io. The "Project" is CNCF.
• Submit a pull request with your artwork.
• Transfer website analytics to projects@cncf.io. CNCF staff can help.

Update and document project details

• Ensure that DCO (preferred) or CLA are enabled for all GitHub repositories of the project.
• Ensure that that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's README.md on GitHub.
• Ensure LF footer is on your website and guidelines are followed (if your project doesn't have a dedicated website, please adopt those guidelines for the README.md file). The project-specific footer text you should use will be provided in the Contribution Agreement instructions.
• Create a maintainer list and add it to the aggregated CNCF maintainer list via pull request.
• Provide emails for the maintainers to get access to the maintainers mailing list and Service Desk. Email them to project-onboarding@cncf.io.
• Start working on written, open governance and consider adding this to a GOVERNANCE.md file at the root of your repo.
• Start on an OpenSSF Best Practices Badge.

CNCF staff tasks to support the project

• Add the project to DevStats.
• Add the project to CLOmonitor.
• Add the project to LFX Insights. This is done by adding a read-only app to your GitHub organization once it's in CNCF GHE.
• Add the project to LFX Project Control Center.
• Add the project to the Cloud Native Landscape by updating landscape.yml following these instructions.
• Add a license scanning tool, like FOSSA or Snyk.
• Send a welcome email to confirm maintainer list access.

[krook]

Welcome to the CNCF Sandbox @gbartolini and the CloudNativePG team!

CNCF staff is working on the first step, which is to create and share the Contribution Agreement with you shortly.

I'll send an email to the contacts listed on the Sandbox application. The Contribution Agreement can be signed by the contributing organization listed there, or a group of individuals.

[gbartolini]

I'll send an email to the contacts listed on the Sandbox application. The Contribution Agreement can be signed by the contributing organization listed there, or a group of individuals.

Awesome, Thanks! Looking forward to it!

[krook]

Welcome again to the CNCF Sandbox! We're creating the Contribution Agreement document for you now and should have it to you shortly.

In the meantime, there are a few generic tasks in this checklist that you can work on that don't have a hard dependency on the CA, such as reviewing documents, documenting any governance you may already have, and preparing your maintainer lists to share.

[krook]

The Contribution Agreement has just been sent by email to the folks listed on the Sandbox application.

[lukaszgryglicki]

Project's DevStats instance was added.

[gbartolini]

Accepted the invite to join the CNCF GitHub Enterprise account.

[krook]

Now that your project is in the CNCF GitHub Enterprise account we're going to do these two tasks on our side:

• Add thelinuxfoundation as an an organization owner, if it's not already one.
• Use that id to install the "LFX CM" GitHub app which will feed read-only, public activity to LFX Insights.

[cynthia-sg]

Project has been added to CLOMonitor

[gbartolini]

Contribution agreement done. For CNPG see this: cloudnative-pg/cloudnative-pg@5c51b9a

[RobertKielty]

The project is setup on both FOSSA and Snyk! 8 repos imported into both.

Great to meet you @sxd today and thank you for your igenuity on getting your Snyk access resolved ;)

Here again, is the 3rd Party License policy that you need to comply with

https://github.com/cncf/foundation/blob/main/allowed-third-party-license-policy.md

which you can use to guide you as you work thru the small number of reported issues.

[krook]

• Add thelinuxfoundation as an an organization owner, if it's not already one.
• Use that id to install the "LFX CM" GitHub app which will feed read-only, public activity to LFX Insights.

This has now been done by CNCF staff.

[sxd]

Thanks @krook

I was searching into LFX Insights, but I can't find the project, I'm guessing it will take some time to load everything and load the project right ?

Regards,

[krook]

Correct, it will take time to ingest and process the data @sxd