cncf
[PROJECT ONBOARDING] KubeFleet
Welcome to CNCF Project Onboarding
Sandbox reference issue: https://github.com/cncf/sandbox/issues/307
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.
- [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.
- [x] 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.
- [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.
- [x] Submit a pull request with your artwork.
- [x] Transfer website analytics to [email protected]. CNCF staff can help.
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. - [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
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. - [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.
- [ ] 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 @britaniar and the KubeFleet 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.
Hi @krook ! Thanks so much for helping KubeFleet with our onboarding task 🙏 The legal team is still reviewing the contribution agreement and it might take a bit more time as I understand; I see that the expectation is that the onboarding should complete within a month, and I am wondering, is there any process we could go through to apply for an extension? Or is it OK if completing all the tasks takes longer than expected? Thanks 🙏
Hi @michaelawyu. Onboarding time is more of a guideline than a rule, and in this case we're using a new process for the CA so it's expected to take a bit more time than usual. Please keep working through the other tasks in the meantime. I've updated the main checklist with your updates.
@michaelawyu I see this is still under the Azure GitHub org. Once you migrate that to its own org (and release it from Microsoft's GHE, if that's the case) we can then invite it to the CNCF GHE instance.
Hi @krook ! Thanks for the reminder. As discussed with team I have created the kubefleet-dev GitHub organization and copied our current codebase there in the KubeFleet repository. The license and other materials have been updated in accordance with the respective CNCF requirements.
I understand that the usual practice is to use the transfer feature, however, we have some internal scaffolding (pipelines, etc.) and usage patterns that are making this option very difficult for us to adopt. We pledge that after the donation process completes we will shift our development to the neutral org/repository and the current repo will become a mirror of the kubefleet-dev/kubefleet repo instead purely for internal consumption. If there's any concern about this, please let me know.
Thanks for the update @michaelawyu. In the meantime I invited the kubefleet-dev org.
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.
- [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. All KubeFleet dependencies use CNCF pre-approved licenses.
- [x] The online program guidelines.
- [x] The telemetry data collection and usage policy.
- [x] 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. Note: see KubeFleet.
- [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. Note: N/A; no channel to migrate.
- [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. Note: N/A; no domain to transfer.
- [x] Submit a pull request with your artwork. Note: N/A; no artwork to submit at the moment. Will create the PR when the assets become available.
- [x] Transfer website analytics to [email protected]. CNCF staff can help. Note: N/A; no website to transfer.
Update and document project details
- [x] Ensure that DCO (preferred) or CLA are enabled for all GitHub repositories of the project. Note: DCO app added to the repo and has been enforced to all PRs.
- [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.- [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
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. Note: Governance work is in progress.- [x] Start on an OpenSSF Best Practices Badge.
Hi @krook ! Thanks for the help along the way 🙏 I've added the latest checklist, PTAL.
Thanks @michaelawyu so it looks like the last remaining tasks for you are to send us the list of maintainers.
We can then handle the rest. FYI @RobertKielty on FOSSA/Snyk, @idvoretskyi on landscape.
Hi Daniel! All the task items assigned to KubeFleet's side has been completed (the checklist is updated); thanks so much for all the guidance. If there's additional task for us to complete or any concern/question, please let me know.
Hi Daniel! All the task items assigned to KubeFleet's side has been completed (the checklist is updated); thanks so much for all the guidance. If there's additional task for us to complete or any concern/question, please let me know.
Thanks @michaelawyu we'll just need your help configuring this one. @RobertKielty can you please send the invites?
@idvoretskyi can you please take a pass at this one?
- [ ] Add the project to the Cloud Native Landscape by updating landscape.yml following these instructions.
Thanks @idvoretskyi. There are probably a few other projects in the list that could also use a landscape entry: https://github.com/cncf/sandbox/issues
Looks like we just have some staff tasks left here @idvoretskyi, @RobertKielty, and @riaankleinhans:
- [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.
- [x] Send a welcome email to confirm maintainer list access.
@britaniar what license scanner service the KubeFleet would prefer to use?
Re: Landscape entry. From what I see, the project hasn't migrated from the Azure org yet, so I'd rather wait until this task is accomplished to avoid adding incorrect data to the landscape entry (by the end of the day, the project has to migrate into its own one).
From what I see, it's still here - https://github.com/Azure/fleet
UPD. Nevermind! @krook has pointed me out to the cloned (not migrated) org&repo - https://github.com/kubefleet-dev
Welcome mail sent https://lists.cncf.io/g/cncf-kubefleet-maintainers/message/1
@britaniar what license scanner service the KubeFleet would prefer to use?
@RobertKielty We would prefer to use Snyk. Thanks!
I've sent invitations out to join CNCF Snyk. @britaniar when you import your repos into Snyk for scanning, we can call this done.
@zhiying-lin thank you for accepting your Snyk invitation! Let me know when you have imported your code repos for scanning and we can close this task off.
cc @britaniar @krook