sandbox
sandbox copied to clipboard
cncf
[PROJECT ONBOARDING] k0s
Welcome to CNCF Project Onboarding
Sandbox reference issue: https://github.com/cncf/sandbox/issues/125
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
- [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.
- [ ] 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.
- [x] 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. - [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 and consider adding this to a
GOVERNANCE.mdfile at the root of your repo. - [x] 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.
- [ ] 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 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.
Can you please send me the Project Contribution Agreement so I can get it reviewed and executed?
Welcome to the CNCF Sandbox @randybias and the k0s 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 first box can probably be ticked:
Migrate your Slack channels (if any) to the Kubernetes or CNCF Slack workspace. CNCF staff can help.
References:
- kubernetes/community#8079
- k0sproject/k0s#5195
The Contribution Agreement has just been sent by email to the folks listed on the Sandbox application.
Received and it's in review with legal. Not sure how to tick the boxes above. Presume it needs to be @mrbobbytables, but we have done most of what we can do before the agreement is signed.
Thanks @randybias. You can either copy/paste the Markdown checklist into a comment and keep it updated as you go. Or just post a list of what you're done with. Bob or I can then update the list at the top.
These are done: 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.
These are now done:
Join the #maintainers-circle Slack channel.
All core maintainers are part of that channel
Start working on written, open governance and consider adding this to a GOVERNANCE.md file at the root of your repo.
We've created separate community repo to host all these kind of things. Mainly so we do not need to copy-pasta same thing all over various repos.
@jnummelin in order to invite k0s and k0smotron to the CNCF GitHub enterprise instance they'll need to be released from the GHE they're currently in.
I went ahead and updated the landscape - https://github.com/cncf/landscape/pull/4268
@jnummelin in order to invite k0s and k0smotron to the CNCF GitHub enterprise instance they'll need to be released from the GHE they're currently in.
I know. The legal stuff is still pending a bit which we need to sort out before we can do the actual move.
I did add all the maintainers to the aggregated maintainers list: https://github.com/cncf/foundation/pull/982
Thanks @jnummelin, we got the maintainer PR and email. Thanks for sending those.
@jnummelin are there any updates on onboarding tasks you may have already completed?
@jnummelin in order to invite k0s and k0smotron to the CNCF GitHub enterprise instance they'll need to be released from the GHE they're currently in.
I know. The legal stuff is still pending a bit which we need to sort out before we can do the actual move.
With the CA signed, it looks like we can move forward on this @jnummelin. Also, please let us know if any other tasks are now done on your side.
@jnummelin let me know if you would prefer to use FOSSA or Snyk? I can setup either service to for you to monitor compliance with the CNCF 3rd Party License Policy.
@jnummelin @twz123 @juanluisvaladas @ncopa @makhov @kke @emosbaugh
Can you let me know which license scanner service the project would prefer to use, FOSSA or Snyk?
@jnummelin @twz123 @juanluisvaladas @ncopa @makhov @kke @emosbaugh
Can you let me know which license scanner service the project would prefer to use, FOSSA or Snyk?
I'd probably go with FOSSA.
I've sent out FOSSA invitations to @jnummelin @twz123 @juanluisvaladas @ncopa @makhov @kke @emosbaugh
Please accept the invitations first then I will add you to the k0s team there.
Once added to the team, I will you to import your code repos into CNCF FOSSA
@jnummelin great to meet you in person in Helsinki!
Are there any other tasks we can mark complete?
@jnummelin I see the k0sproject org is still within the Mirantis GHE so I can't invite it to the CNCF GHE. Is that ready to transfer?
And are there other tasks we can mark complete?
In the meantime, until we can invite to the CNCF GHE, can you please invite @thelinuxfoundation as an org owner?
@jnummelin @twz123 @juanluisvaladas @ncopa @makhov @kke @emosbaugh
Are there tasks (other than the GHE transfer which we're doing next week) that can be started or marked complete?
- [ ] 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.
- [ ] Submit a pull request with your artwork.
- [ ] 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.
- [ ] Add a license scanning tool, like FOSSA or Snyk. @RobertKielty can help with this one.
- [ ] 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.
For the latter, it would be:
Copyright © k0s a Series of LF Projects, LLC For website terms of use, trademark policy and other project policies please see lfprojects.org/policies/.