sandbox
sandbox copied to clipboard
cncf
[PROJECT ONBOARDING] container2wasm
Welcome to CNCF Project Onboarding
Sandbox reference issue: https://github.com/cncf/sandbox/issues/123
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.
- [x] 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
- [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. - [ ] 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.
- [x] Ensure that that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's
README.mdon 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.mdfile). 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].
- [x] Start working on written, open governance and consider adding this to a
GOVERNANCE.mdfile at the root of your repo. - [ ] Start on an OpenSSF Best Practices Badge.
CNCF staff tasks to support the project
- [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.
- [ ] 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.
Welcome to the CNCF Sandbox @ktock and the container2wasm 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.
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.
The Contribution Agreement has just been sent by email to the folks listed on the Sandbox application.
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.
container2wasm is now hosted in a separete organization: https://github.com/container2wasm/container2wasm
Now that your project is in the CNCF GitHub Enterprise account we're going to do these two tasks on our side:
- Add
thelinuxfoundationas 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.
- Add
thelinuxfoundationas 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.
@ktock are there any updates on onboarding tasks you may have already completed?
Yes, the following is the current status.
- [x] 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.
- [x] Review and understand the LF trademark guidelines.
- [x] 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
- [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 dependency license allowlist.
- [x] The online program guidelines.
- [x] The telemetry data collection and usage policy.
- [ ] Book time with CNCF staff to understand project benefits and event resources.
Contribute and transfer other materials
- [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] Migrate your Slack channels (if any) to the Kubernetes or CNCF Slack workspace. CNCF staff can help.
There was no slack channel previously.
- [x] Join the #maintainers-circle Slack channel.
- [x] Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected]. The "Project" is CNCF.
There is no domain to transfer.
- [x] Submit a pull request with your artwork.
There is no artwork to submit.
- [x] Transfer website analytics to [email protected]. CNCF staff can help.
There is no website analytics.
Update and document project details
- [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
README.mdon 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.mdfile). 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.
Sent a pull request to https://github.com/cncf/foundation/pull/993
- [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 and consider adding this to a
GOVERNANCE.mdfile at the root of your repo.- [x] Start on an OpenSSF Best Practices Badge.
Started on an OpenSSF Best Practices Badge as https://www.bestpractices.dev/en/projects/10395
Mailing list created and welcome email sent https://lists.cncf.io/g/cncf-container2wasm-maintainers
Since there's no website, I've sent a PR to add the LF trademark to the project README.
This step is optional (and can always be requested at some point after you've onboarded). Let us know if we can mark it complete for now:
- [ ] Book time with CNCF staff to understand project benefits and event resources.
@RobertKielty can you please help with this:
Once those are done, onboarding would be complete.
This step is optional (and can always be requested at some point after you've onboarded). Let us know if we can mark it complete for now:
Book time with CNCF staff to understand project benefits and event resources.
Sure. While I haven't booked the meeting, please let me know when it's needed.
@ktock I have sent out invitations to join both FOSSA and Snyk to you;
On FOSSA you already have a personal account with the email you provided to us.
If you want to use CNCF FOSSA you need to send an email to [email protected] you can cc me and have it moved to the CNCF. If you transfer the account you will loose your personal account so if that is a problem reach out to me on cloud-native Slack and I can go through options for you.
@krook @RobertKielty Since container2wasm is a Go project, I'm considering adding https://github.com/google/go-licenses, which is a license scanning tool well-suited for Go projects.
@ktock both CNCF Legal and CNCF Project Team staff have establised processes in place to access their FOSSA and Snyk CNCF service instances for the purposes of checking project compliance with the 3rd Party License policy.
CNCF staff run reports on those services across all the projects and also have manually configured those two services to codify the CNCF 3rd Party License policy for all of the projects.
I have checked with management in the past, and there is no desire within the CNCF to add a new license scanning tool, as doing so would further fragment the effort required to manage licenses accross all of the existing projects.
@RobertKielty Thanks for the explanation. I'll reach out to the FOSSA team about joining the CNCF instance. Could you share your email so I can CC you?
@ktock thanks for getting back to me so quickly :)
I have sent an email to you and [email protected].
I requested that your personal account on FOSSA is migrated over the CNCF Service Instance.
Once you provide your approval to FOSSA support and they then migrate your account you will no longer have access to your existing FOSSA account but you will gain access to the CNCF FOSSA enterprise account.
If you need your existing FOSSA account for other work, let me and FOSSA Support know on the email. Sometimes, migrating an existing FOSSA account is a problem for maintainers who are using FOSSA for other work outside of the project being on-boarded into the CNCF Sandbox. If that is the case for you I can let you know what else we can do to handle that.
@RobertKielty Thank you for sending the request.
I requested that your personal account on FOSSA is migrated over the CNCF Service Instance.
Once you provide your approval to FOSSA support and they then migrate your account you will no longer have access to your existing FOSSA account but you will gain access to the CNCF FOSSA enterprise account.
If you need your existing FOSSA account for other work, let me and FOSSA Support know on the email. Sometimes, migrating an existing FOSSA account is a problem for maintainers who are using FOSSA for other work outside of the project being on-boarded into the CNCF Sandbox. If that is the case for you I can let you know what else we can do to handle that.
Yes, I'm OK about the migration of the FOSSA account.
Brilliant! I'd expect FOSSA support to action this request within the next 8 hours.
@ktock thank you for importing your project repo into FOSSA, I have moved the Project into the container2wasm team and marked the task as complete.
@ktock I was about to close the on-boarding issues but I couldn't find the project in maintainers.cncf.io
Have you added container2wasm to this list? It's just a PR to add you and the project in.
[ ] Create a maintainer list and add it to the aggregated CNCF maintainer list via pull request.
Nearly there! 🚀
@krook I have added the project maintainer file to our internal record.
Hi @RobertKielty, thank you for configuring the FOSSA migration.
Have you added container2wasm to this list? It's just a PR to add you and the project in. [ ] Create a maintainer list and add it to the aggregated CNCF maintainer list via pull request.
Yes, https://github.com/cncf/foundation/pull/993 has already been merged.
@ktock well that's everything completed 🚀
Thank you for all of your work and effort on completing the on-boarding tasks.
Welcome to the CNCF Sandbox! 🎉