Open
Description
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 to complete onboarding within one month of acceptance.
From the project side, please ensure that you:
- Understand the project proposal process and reqs: https://github.com/cncf/toc/blob/main/process/project_proposals.md#introductionUnderstand the services available for your project at CNCF https://www.cncf.io/services-for-projects/Ensure your project meets the CNCF IP Policy: https://github.com/cncf/foundation/blob/master/charter.md#11-ip-policyReview the online programs guidelines: https://github.com/cncf/foundation/blob/master/online-programs-guidelines.mdUnderstand the trademark guidelines: https://www.linuxfoundation.org/en/trademark-usage/Understand the license allowlist: https://github.com/cncf/foundation/blob/master/allowed-third-party-license-policy.md#approved-licenses-for-allowlistIs your project working on written, open governance? see https://contribute.cncf.io/maintainers/governance/Slack: Are your slack channels migrated to the Kubernetes or CNCF Slack? (see https://slack.com/help/articles/217872578-Import-data-from-one-Slack-workspace-to-another for more details)Is your project in its own separate neutral github organization?Submitted a Pull request to add your project as a sandbox project to https://landscape.cncf.ioCreate maintainer list + add to aggregated https://maintainers.cncf.io list by submitting a PR to itArtwork: Submit a pull request to https://github.com/cncf/artwork with your artworkDomain: transfer domain to the CNCF - https://jira.linuxfoundation.org/plugins/servlet/theme/portal/2/create/63
Things that CNCF will need from the project:
- Provide emails for the maintainers added to https://maintainers.cncf.io in order to get access to the maintainers mailing list and ServiceDesk - project-onboarding@cncf.io is the best email to send those toTrademarks: transfer any trademark and logo mark assets over to the LF - https://github.com/cncf/foundation/tree/master/agreements has agreementsGitHub: ensure 'thelinuxfoundation' and 'caniszczyk' are added as initial org owners, this helps us make sure we have continuity of GH ownership that we will onboard to our GitHub Enterprise instance: https://github.com/enterprises/cncfGitHub: ensure that that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's README on GitHubWebsite: ensure LF footer is there and website guidelines followed (if your project doesn't have a dedicated website, please adopt those guidelines to the README file of your project on GitHub).Website: Analytics transferred to projects@cncf.ioOpenSSF Best Practices Badge: Start on an OpenSSF Best Practices Badge https://bestpractices.coreinfrastructure.org/en
Things that the CNCF will do or help the project to do:
- Devstats: add to devstats https://devstats.cncf.io/Insights: add to LFX Insights https://insights.v3.lfx.linuxfoundation.org/Marketing: update relevant intro + slide decksEvents: update CFP + Registration + CFP Area formsServiceDesk: confirm maintainers have read https://www.cncf.io/services-for-projects/CNCF Welcome Email Sent to confirm maintainer list accessBook time with the team with http://project-meetings.cncf.ioCreate space for meetings/events on https://community.cncf.io, e.g., https://community.cncf.io/pravega-community/ - (https://github.com/cncf/communitygroups/blob/main/README.md#cncf-projects)Add project's groups.io maintaner list to maintainers@cncf.io
Metadata
Metadata
Assignees
Type
Projects
Milestone
Relationships
Development
No branches or pull requests
Activity
lukaszgryglicki commentedon May 20, 2023
DevStats page added.
Will also be added to All CNCF around Monday next week.
lukaszgryglicki commentedon May 21, 2023
Also added to All CNCF, table.
amye commentedon Jun 7, 2023
Checking in on this one: @hiddeco -
This both puts your project on the landscape and the CNCF projects page, so it's pretty important!
amye commentedon Jun 14, 2023
Quick ping on this, this gets you on the sandbox project page on the website. @hiddeco - anyone else I should work with on this?
hiddeco commentedon Jun 15, 2023
I am still awaiting the official handover from Mozilla Foundation, which is blocking further announcements.
amye commentedon Jun 15, 2023
Ah, got it! I will hold then.
hiddeco commentedon Jun 30, 2023
Bit of a jigsaw puzzle here in terms of getting things done in the right order, as we are lacking an artwork at present which seems to be pretty much required for the landscape.
I am working on resolving the maintainers list first, will then get us onto https://maintainers.cncf.io, to then make use of the ServiceDesk.
However, I can confirm at present:
Plus:
hiddeco commentedon Jun 30, 2023
As licensing scanning tool, my preference would go out to FOSSA.
amye commentedon Jun 30, 2023
Aha! This explains a bunch of things. Ok.
@RobertKielty for FOSSA for next week.
4 remaining items
Cmierly commentedon Sep 28, 2023
@RobertKielty
Hi! Were the FOSSA invites sent?
hiddeco commentedon Sep 29, 2023
We have been invited, project should be available in FOSSA dashboard now. We are running into a
however (using a push-only API key generated from my account), see: getsops/sops#1308
amye commentedon Oct 9, 2023
@RobertKielty - what might be the hangup here?
krook commentedon Jan 9, 2024
Added to LFX Insights
RobertKielty commentedon Mar 11, 2024
I have sent out an email to cncf-SOPS-maintainer@lists.cncf.io with details of the FOSSA Setup and I DM'd @sabre1041 on Slack to share credentials.
I will mark FOSSA setup as complete when @sabre1041 has let me know that that SOPS repos are being scanned.
RobertKielty commentedon Mar 14, 2024
SOPS Are scanning 5 projects with FOSSA
krook commentedon Jan 31, 2025
@hiddeco There are a few remaining tasks here before we can close out onboarding. Can you please review and complete these items:
krook commentedon Feb 22, 2025
@hiddeco ping, looks like some simple tasks to check off and then we can mark onboarding complete.
hiddeco commentedon Mar 28, 2025
We do meet the DCO, etc. requirements except for the licensing.
This is a tricky issue, as SOPS was donated by Mozilla to the CNCF it has a MPL-2.0 license. Changing this license or reforming it into the preferred Apache-2.0 license is technically possible but difficult, and would need guidance from the CNCF. I sadly lost access to my previous conversations with Chris A. due to Weaveworks closing shop, but I believe he thought it could be done.
We filed an issue for this, but things have not changed much since then and we are still operating in a "self-elected" manner. I will discuss with the other maintainers, and see if we can prioritize formalizing this in a document.
This seems like the easiest one to pick up :-).
krook commentedon Mar 30, 2025
Thanks for the update @hiddeco.
Once you just document the current governance and start on an OpenSSF badge we can mark those tasks complete (they don't have to be done, just started). Please let me know when that happens.
On the MPL front... yes, that may be a bit more complex. I'll find out what we need to do there.
krook commentedon Apr 21, 2025
@hiddeco for the MPL issue can you please open an issue with this new license exception request template? We can then use that to track updates on what needs to be done.
[-][SANDBOX PROJECT ONBOARDING] SOPS[/-][+][PROJECT ONBOARDING] SOPS[/+]krook commentedon May 12, 2025
@hiddeco any progress on these 3 remaining onboarding tasks?
The GOVERNANCE.md and OpenSSF badge should be pretty straightforward as they just need an initial start.
And for MPL, that one will be a matter of opening an issue with the new template.