sandbox
sandbox copied to clipboard
cncf
[PROJECT ONBOARDING] KitOps
Welcome to CNCF Project Onboarding
Sandbox Application reference issue: https://github.com/cncf/sandbox/issues/313
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.
- [x] Optional: 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. - [ ] 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.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].
- [ ] 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.
- [ ] 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.
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.
The landscape entry is here - https://github.com/cncf/landscape/pull/4265
@gorkem 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.
The new organization for the KitOps and related projects is https://github.com/kitops-ml
A few updates:
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.
Done - we are using Apache 2 for all repositories.
Review and understand the LF trademark guidelines. Let the TOC know if you plan to change your project name.
Done - we have no plans to change the 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.
Done - Docusigned by Brad Micklea
The Technical Leadership Principles that outlines the expected behavior for any maintainer in a leadership role.
Done
Done
Done
Done
Migrate your Slack channels (if any) to the Kubernetes or CNCF Slack workspace. CNCF staff can help.
We have no slack channels for KitOps, but we do have a Discord channel: https://discord.gg/D97SAtug - not sure how we should handle that.
Join the #maintainers-circle Slack channel.
Done
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.
Done via CNCF compatible CoC in the repo
Start working on written, open governance and consider adding this to a GOVERNANCE.md file at the root of your repo.
Done via CNCF compatible Goverance.md in the repo
@gorkem do you have a preference for FOSSA or Snyk for license scanning?
@gorkem do you have a preference for FOSSA or Snyk for license scanning?
@RobertKielty We prefer Snyk, we are more familiar with it.
@gorkem updated our internal records for you, @amisevsk and @bmicklea and I have invited you to join the KitOps Team on CNCF Snyk.
After you import your project repos into Snyk, let me know here we can mark this task complete.
@gorkem I can see that you imported all of the project repos into Snyk, I've checked the box in the top level task list.
Thanks again @bmicklea. Are there any additional items we can mark off or help you with?
We have completed the following as well:
- Provide emails for the maintainers to get access to the maintainers mailing list and Service Desk
- Migrate your Slack channels --> we don't have any so nothing to migrate
- Submitted a pull request with our artwork
Is "Start on an OpenSSF Best Practices Badge" mandatory?
Is "Start on an OpenSSF Best Practices Badge" mandatory?
Yes. All that's needed is to log in with GitHub to start the badge and it will track progress and suggest security improvements.
The footers for Kitops.org has been updated according to guideliness. I think we can cross out the Ensure LF footer is on your website item.
The footers for Kitops.org has been updated according to guideliness. I think we can cross out the
Ensure LF footer is on your websiteitem.
@gorkem It looks like there's just a CNCF member badge there. The guidelines are in bullet 7 here.
For KitOps that would be:
Copyright © KitOps a Series of LF Projects, LLC For website terms of use, trademark policy and other project policies please see lfprojects.org/policies/.
An example here: https://kgateway.dev/
Thanks @gorkem and @Jwilliamsr. Any update on the final 3 tasks? Two are just document reviews and the last would be starting the domain transfer for https://kitops.org/
Great, marked that task off as it's underway.
How about reviewing the two documents?
@bmicklea @gorkem @Jwilliamsr
I see the domains are transferred, thank you.
Just two more basic tasks to do before we can mark onboarding complete.
Can you please confirm one or more of you have read these two docs?
- [ ] The dependency license allowlist.
- [ ] The telemetry data collection and usage policy.
Just two more basic tasks to do before we can mark onboarding complete.
Hi @bmicklea @gorkem @Jwilliamsr. If you can confirm those two docs have been read, we can then mark CNCF onboarding complete.
@krook I have reviewed the license and telemetry policy earlier. I think we can mark those.