cncf
[PROJECT ONBOARDING] Kmesh
Welcome to CNCF Project Onboarding
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.
Review and understand
- [x] The Technical Leadership Principles that outlines the expected behavior for any maintainer in a leadership role.
- [x] The project proposal process and requirements.
- [x] The services available for your project at the CNCF.
- [x] The CNCF IP Policy.
- [x] The trademark guidelines.
- [x] The license allowlist.
- [x] The online program guidelines.
- [x] Optional: Book time with CNCF staff to understand project benefits and event resources.
Contribute and transfer
- [x] 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.
- [x] Accept the invite to join the CNCF GitHub Enterprise account. We'll then add
thelinuxfoundationas an organization owner to ensure neutral hosting of your project. - [x] Join the #maintainers-circle Slack channel.
- [x] Submit a pull request to add your project as a Sandbox project to the Cloud Native Landscape by updating landscape.yml following these instructions.
- [x] Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected].
- [ ] Transfer any trademark and logo assets to the Linux Foundation via the Contribution Agreement.
- [x] Submit a pull request with your artwork.
- [ ] Transfer website analytics to [email protected]. CNCF staff can help.
Update and document
- [x] Ensure that DCO (preferred) or CLA are enabled for all GitHub repositories of the project.
- [x] Ensure that that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's
READMEon GitHub. - [x] 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
READMEfile). - [x] Create a maintainer list and add it to the aggregated CNCF maintainer list via pull request.
- [x] Provide emails for the maintainers to get access to the maintainers mailing list and Service Desk. Email them to [email protected].
- [x] Start working on written, open governance.
- [x] Start on an OpenSSF Best Practices Badge.
CNCF staff tasks
- [x] Add the project to DevStats.
- [x] Add the project to CLOmonitor.
- [x] 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.
- [x] Add the project to LFX Project Control Center.
- [x] Add a license scanning tool, like FOSSA or Snyk.
- [x] Create groups.io project maintainer list in PCC
- [x] Add project's groups.io maintaner list to [email protected]
- [x] Send a welcome email to confirm maintainer list access.
- [x] Add project's groups.io cncf-sandbox-projects list to [email protected]
Sorry for the delay. The new 2025 "Project Contribution Agreement" is now available.
This replaces the trademark agreements mentioned in the original checklist.
I'll be sending an email to the contacts listed in the Sandbox application issue to handle next steps.
Please review the instructions in the email, fill out the Google Doc, and then we can it them completed via Docusign.
Once done, that will unblock us from continuing the rest of these Sandbox onboarding tasks.
We can address any questions about the Agreement over email.
https://github.com/cncf/artwork/pull/523 Add Kmesh logos to cncf artwork repo.
I've just sent a re-invitation to the CNCF GitHub Enterprise instance.
@kevin-wangzefeng @nlgwcy @hzxuzhonghu @supercharge-xsy @bitcoffeeiux are there any other items that you've completed that we can check off the list?
We can continue to work on onboarding while the Contribution Agreement is being worked out.
Created the mailing list and send the welcome email. https://lists.cncf.io/g/cncf-kmesh-maintainers/messages
@hzxuzhonghu while we await the Contribution Agreement to be completed, are there any other tasks we can mark complete?
Many of them are just reviewing documents and policies.
Thanks @hzxuzhonghu (and others @LiZhenCheng9527, @kevin-wangzefeng, @nlgwcy, @supercharge-xsy, @bitcoffeeiux) any other tasks we can start or mark complete?
- [ ] Join the #maintainers-circle Slack channel.
- [ ] Transfer kmesh.net to the CNCF. The "LF Stakeholder email" is [email protected].
- [ ] Transfer website analytics if they exist. Make [email protected] an admin of your existing Google Analytics org account so that we can move it to a CNCF-managed account.
- [ ] 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 file).
- [ ] Start on an OpenSSF Best Practices Badge. This just needs to be started, not completed.
- [ ] Add a license scanning tool, like FOSSA or Snyk. @RobertKielty can help with this.
- [ ] Optional: Book time with CNCF staff to understand project benefits and event resources.
For the website footer, this is what would need to be added to kmesh.net:
Copyright © Kmesh a Series of LF Projects, LLC For website terms of use, trademark policy and other project policies please see lfprojects.org/policies/.
we have finished
- Join the #maintainers-circle Slack channel.
- Transfer kmesh.net to the CNCF. The "LF Stakeholder email" is [email protected].
- 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 file).
- [ ] Add a license scanning tool, like FOSSA or Snyk. @RobertKielty can help with this.
@RobertKielty can we get this one onboarded please?
maintainer-d CNCF FOSSA onboarding - Report
:spiral_notepad: Actions taken during onboarding...
- ✅ Kmesh has 5 maintainers registered in maintainer-d
- 👥 Kmesh team was already in FOSSA
- @kevin-wangzefeng : you have a pending invitation to join CNCF FOSSA. Please check your registered email and accept the invitation within 48 hours.
- @nlgwcy : you have a pending invitation to join CNCF FOSSA. Please check your registered email and accept the invitation within 48 hours.
- @bitcoffeeiux : you have a pending invitation to join CNCF FOSSA. Please check your registered email and accept the invitation within 48 hours.
- The Kmesh project has not yet imported repos
When you have accepted your invitation to join CNCF FOSSA :
-
Add a comment /fossa-invite accepted to this issue, the maintainer-d onboarding process will add you to you team as a Team Admin (FOSSA RBAC).
-
then, and only then, can you start importing your code and documentation repositories into FOSSA: Getting Started Guide.
Hi @RobertKielty, I don't find any invitation to join CNCF FOSSA, could you retry sending the invitation? Thanks.
@RobertKielty @nlgwcy has added kmesh projects to cncf organization, could you please check any other action should we take?
@hzxuzhonghu and @nlgwcy thank you for importing the repos, from an onboarding point of view I can mark that task as complete.
There are a couple of issues that were noted in the scans, just work through those issues using the below policy as a reference, if you have questions, you can reach out to myself or @krook
https://github.com/cncf/foundation/blob/main/policies-guidance/allowed-third-party-license-policy.md#cncf-allowlist-license-policy
maintainer-d CNCF FOSSA onboarding - Report
:spiral_notepad: Actions taken during onboarding...
- ✅ Kmesh has 7 maintainers registered in maintainer-d
- 👥 Kmesh team was already in FOSSA
- @kevin-wangzefeng : you have a pending invitation to join CNCF FOSSA. Please check your registered email and accept the invitation within 48 hours.
- @nlgwcy : you have a pending invitation to join CNCF FOSSA. Please check your registered email and accept the invitation within 48 hours.
- @bitcoffeeiux : you have a pending invitation to join CNCF FOSSA. Please check your registered email and accept the invitation within 48 hours.
- @LiZhencheng9527 : you have a pending invitation to join CNCF FOSSA. Please check your registered email and accept the invitation within 48 hours.
- @YaoZengzeng : you have a pending invitation to join CNCF FOSSA. Please check your registered email and accept the invitation within 48 hours.
- ✅ Invitation(s) to join CNCF FOSSA sent to @hzxuzhonghu @supercharge-xsy
- The Kmesh project team have imported 5 repo(s)<BR>- kmesh
- kmesh-dns-plugin
- orion
- waypoint
- website
When you have accepted your invitation to join CNCF FOSSA :
-
Add a comment /fossa-invite accepted to this issue, the maintainer-d onboarding process will add you to you team as a Team Admin (FOSSA RBAC).
-
then, and only then, can you start importing your code and documentation repositories into FOSSA: Getting Started Guide.
maintainer-d CNCF FOSSA onboarding - Report
:spiral_notepad: Actions taken during onboarding...
- ✅ Kmesh has 7 maintainers registered in maintainer-d
- 👥 Kmesh team was already in FOSSA
- @kevin-wangzefeng : you have a pending invitation to join CNCF FOSSA. Please check your registered email and accept the invitation within 48 hours.
- @hzxuzhonghu : you have a pending invitation to join CNCF FOSSA. Please check your registered email and accept the invitation within 48 hours.
- @nlgwcy : you have a pending invitation to join CNCF FOSSA. Please check your registered email and accept the invitation within 48 hours.
- @supercharge-xsy : you have a pending invitation to join CNCF FOSSA. Please check your registered email and accept the invitation within 48 hours.
- @bitcoffeeiux : you have a pending invitation to join CNCF FOSSA. Please check your registered email and accept the invitation within 48 hours.
- @LiZhencheng9527 : you have a pending invitation to join CNCF FOSSA. Please check your registered email and accept the invitation within 48 hours.
- @YaoZengzeng : you have a pending invitation to join CNCF FOSSA. Please check your registered email and accept the invitation within 48 hours.
- ✅ Invitation(s) to join CNCF FOSSA sent to
- The Kmesh project team have imported 5 repo(s)<BR>- kmesh
- kmesh-dns-plugin
- orion
- waypoint
- website
When you have accepted your invitation to join CNCF FOSSA :
-
Add a comment /fossa-invite accepted to this issue, the maintainer-d onboarding process will add you to you team as a Team Admin (FOSSA RBAC).
-
then, and only then, can you start importing your code and documentation repositories into FOSSA: Getting Started Guide.