[PROJECT ONBOARDING] kgateway

[mrbobbytables]

Welcome to CNCF Project Onboarding

Sandbox Application reference issue: #319

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. Other tasks can be done by projects in the meantime.

• 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. Let the TOC know if you plan to change your project name.
• 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.
• Optional: 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 [email protected]. The "Project" is CNCF.
• Submit a pull request with your artwork.
• Transfer website analytics to [email protected]. 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 [email protected].
• 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!

We’re preparing your Contribution Agreement (CA) and will email it to the contacts on your Sandbox application soon. Here’s a preview of a generic CA, which sets up a legal entity for the project and assigns trademarks and logos to the Linux Foundation.

In the meantime, you can tackle some onboarding tasks that don’t depend on the CA, like reviewing documents, outlining any existing governance, and preparing your maintainer lists.

[craigbox]

Can you please help us get us set up with a 1-3 user Google Workspace instance for kgateway.dev?
Or should we set this up ourselves and set billing to CNCF?

[lukaszgryglicki]

DevStats instance added.

[lukaszgryglicki]

Project added to All CNCF DevStats instance and also to Projects Health dashboard.

[linsun]

Regarding Transfer [your domain to the CNCF](https://jira.linuxfoundation.org/plugins/servlet/desk/portal/2/create/63?requestGroup=19). The "LF Stakeholder email" is [[email protected]](mailto:[email protected]). The "Project" is CNCF., per @yuval-k, our kgateway.dev domain, which is part of a bundle can't be transferred within 120 days of the bundle purchase date. We'll start the transfer after March 21, 2025.

[cynthia-sg]

Project has been added to CLOMonitor

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

[krook]

@linsun the Contribution Agreement draft has just been sent by email to the folks listed on the Sandbox application for review. Please let us know if there are any changes (like contact info and additional trademarks) that should be included.

[linsun]

Tried to submit artwork based on what we currently have: cncf/artwork#549

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

[jenshu]

These are done:

Ensure that DCO (preferred) or CLA are enabled for all GitHub repositories of the project.

Provide emails for the maintainers to get access to the maintainers mailing list and Service Desk. Email them to [email protected].