[PROJECT ONBOARDING] OVN-Kubernetes

[Cmierly]

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 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.

Review and understand

• 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 CNCF IP Policy.
• The trademark guidelines.
• The license allowlist.
• The online program guidelines.
• Book time with CNCF staff to understand project benefits and event resources.

Contribute and transfer

• 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 thelinuxfoundation as 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.
• Submit a pull request to add your project as a Sandbox project to the Cloud Native Landscape by updating landscape.yml following these instructions.
• Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected].
• Transfer any trademark and logo assets to the Linux Foundation via the Contribution Agreement.
• Submit a pull request with your artwork.
• Transfer website analytics to [email protected]. CNCF staff can help.

Update and document

• 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 on 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 file).
• 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.
• Start on an OpenSSF Best Practices Badge.

CNCF staff tasks

• Add the project to DevStats.
• 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.
• Add the project to LFX Project Control Center.
• Add a license scanning tool, like FOSSA or Snyk.
• Invite developers to the #maintainers-circle Slack channel.
• Send a welcome email to confirm maintainer list access.

[tssurya]

Thank you for the onboarding checklist!!
We will get started on this shortly

[tssurya]

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.

This comment tracks our progress for the onboarding; Deadline is Nov 17th, 1 month from acceptance as sandbox!

Review and understand

• 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 CNCF IP Policy.
• The trademark guidelines.
• The license allowlist.
• The online program guidelines.
• Book time with CNCF staff to understand project benefits and event resources.

Contribute and transfer

• 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 thelinuxfoundation as 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.
• Submit a pull request to add your project as a Sandbox project to the Cloud Native Landscape by updating [landscape.yml] (https://github.com/cncf/landscape/blob/master/landscape.yml) following these instructions. DONE: Add ovn-kubernetes to CNCF landscape landscape#4111
• Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected].
• Transfer any trademark and logo assets to the Linux Foundation.
• Submit a pull request with your artwork. : Add ovn-kubernetes logos artwork#520
• Transfer website analytics to [email protected]. CNCF staff can help.

Update and document

• 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 on GitHub. : DONE: https://github.com/ovn-kubernetes/ovn-kubernetes?tab=coc-ov-file
• 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 file).
• Create a maintainer list and add it to the aggregated CNCF maintainer list via pull request. DONE: Add OVN-Kubernetes maintainers foundation#881
• 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.
• Start on an OpenSSF Best Practices Badge.

CNCF staff tasks

• Add the project to DevStats.
• 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.[ ] Add the project to LFX Project Control Center.
• Add a license scanning tool, like FOSSA or Snyk.
• Invite developers to the #maintainers-circle Slack channel.
• Send a welcome email to confirm maintainer list access.

[krook]

Hi @tssurya and OVN-Kubernetes team,

This task is a prerequisite for a few of the staff tasks. Please let us know when it's complete.

• 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.

[tssurya]

@krook yes! will try to get this started immediately; we have a community meeting this coming monday, wanted to announce it first that we are planning to do this

[tssurya]

@krook yes! will try to get this started immediately; we have a community meeting this coming monday, wanted to announce it first that we are planning to do this

The move is scheduled for next Tuesday: https://groups.google.com/g/ovn-kubernetes/c/3rOneJsuA24/m/XMLzgnrFAwAJ
It was also announced in OVN-Kubernetes upstream meeting that happened on 28th October.

[tssurya]

Opened Maintainer List PR: cncf/foundation#881
Also sent the maintainer emails to [email protected]

[tssurya]

The maintainers met with @krook last Thursday - was a very productive call where Daniel helped answer our questions. Thank you CNCF.

I have one question regarding: https://github.com/cncf/foundation/blob/main/allowed-third-party-license-policy.md#approved-licenses-for-allowlist
I was reading this and is my understanding correct that all packages we use in our project must have the licenses either mentioned here: https://spdx.org/licenses/ OR is it restricted to the 12 of them mentioned directly on the md docs alone?

[tssurya]

CNCF Landscape PR: cncf/landscape#4111

This needs two more things:

1. new slack URL after transfer
2. need to wait for repo transfer to happen this coming week

[idvoretskyi]

@tssurya great. Please keep us posted.

[lukaszgryglicki]

DevStats page added.

[tssurya]

Could we please get a link to the service desk space? We'd like to request help with designing an official logo that has the correct aspect ratio since our current logo is not really professionally made.

[idvoretskyi]

@tssurya http://servicedesk.cncf.io/

Please drop us a note if you’ll have issues with accessing it.

[tssurya]

@idvoretskyi thank you! yes unfortunately I am having issues accessing it (We couldn't give you access. Use another email and try again. to be precise on the error), I did finish the step where I should send an email to [email protected] so perhaps I need wait a bit more for access?

[idvoretskyi]

@tssurya yes, please email us, and we'll proceed from there.

FYI @Cmierly

[tssurya]

@tssurya yes, please email us, and we'll proceed from there.

FYI @Cmierly

oh the email was already sent (was done on Sat, title: OVN-Kubernetes CNCF Sandbox project onboarding: Providing emails of maintainers)

[tssurya]

FYI: We have moved ourselves into a neutral org: https://github.com/ovn-kubernetes/ovn-kubernetes
this should unblock the staff tasks,
thank you for being patient here

PS: Our CI is misbehaving a bit here after the transfer (unsure if its related to new repo being part of free tier); but let us know when the transfer to enterprise account will start and if we need to accept the linux foundation member in our project.

[tssurya]

@krook : Sorry to ping you directly, We have moved our repo to the neutral org but given its free tier all our PRs are failing on CI probably because of limited allowed resources on the free tier plan. Would we get the enterprise invite shortly or should we in the interim purchase a team plan of sorts to unblock ourselves?

cc @trozet

[idvoretskyi]

@tssurya I’ll invite you, no worries.

[tssurya]

thank you @idvoretskyi !

[lukaszgryglicki]

Project was added to All CNCF DevStats instance.

[tssurya]

update: we are working on cncf/landscape#4111 and logos: cncf/artwork#520

[krook]

Sorry for the delay. The new 2025 "Project Contribution Agreement" is now available.

This replaces the trademark agreements mentioned in the original checklist.

I'll be sending an email to the contacts listed in the Sandbox application issue to handle next steps.

Please review the instructions in the email, fill out the Google Doc, and then we can it them completed via Docusign.

Once done, that will unblock us from continuing the rest of these Sandbox onboarding tasks.

We can address any questions about the Agreement over email.

[tssurya]

ack thanks @krook !
also which PR do we need to open to finish getting the project into https://contribute.cncf.io/contributors/projects/ ?

[krook]

also which PR do we need to open to finish getting the project into https://contribute.cncf.io/contributors/projects/ ?

That page is auto-generated from landscape.cncf.io. So, once the PR is merged over there it will be propagated to this page.

[krook]

@tssurya Looks like this landscape PR still needs you to rebase and sign your commits: cncf/landscape#4111 (comment)

[tssurya]

@tssurya Looks like this landscape PR still needs you to rebase and sign your commits: cncf/landscape#4111 (comment)

done!

[jcaamano]

@krook

I regards to the DCO requirement, the probot DCO app is specifically mentioned:

• Ensure that DCO (preferred) or CLA are enabled for all GitHub repositories of the project.

However that app seem to be rather unmaintained in regards to new (but not so new) github features like the merge queue: dcoapp/app#199

I wonder if we could use alternatives, like https://github.com/cncf/dcochecker?

cc @RobertKielty

[krook]

@jcaamano The CNCF has been building a drop in replacement for that unmaintained version and supports the newer GitHub features. It's available to install here: https://github.com/apps/dco-2

From @tegioz: "Regarding merge queues: we do "support" them, in the sense that no tricks are required to make it work with them, but the check isn't run again. We assume it was run during the PR checks and we mark is as passed automatically when asked to run from the merge queue."

[tssurya]

@tssurya Looks like this landscape PR still needs you to rebase and sign your commits: cncf/landscape#4111 (comment)

done!

@krook @RobertKielty : I unfortunately still don't see the logo rendering correctly here: https://contribute.cncf.io/contributors/projects/#ovn-kubernetes Is there something I have done wrong in my PR?
Same for https://cloud-native.slack.com/archives/C08AP5D74D7/p1737969281452889 what we discussed here in the ecosystem as well our logo doesn't seem to render

[tssurya]

@krook / @RobertKielty : another quick question: I'd like to transfer this netlify domain https://ovn-kubernetes.io/ over to CNCF management. I have opened https://jira.linuxfoundation.org/plugins/servlet/desk/portal/2/IT-27810 for the same, Please help with what needs to be done for this to be completed.

[krook]

@krook / @RobertKielty : another quick question: I'd like to transfer this netlify domain https://ovn-kubernetes.io/ over to CNCF management. I have opened https://jira.linuxfoundation.org/plugins/servlet/desk/portal/2/IT-27810 for the same, Please help with what needs to be done for this to be completed.

Thanks @tssurya. LF IT should be able to work on the domain transfer. @nate-double-u can help with the Netlify part. Please open a CNCF Service Desk ticket for that and we'll get it sorted.

[krook]

@krook @RobertKielty : I unfortunately still don't see the logo rendering correctly here: https://contribute.cncf.io/contributors/projects/#ovn-kubernetes Is there something I have done wrong in my PR?

@cjyabraham are you able to see why this isn't rendering?

[cjyabraham]

@krook @RobertKielty : I unfortunately still don't see the logo rendering correctly here: https://contribute.cncf.io/contributors/projects/#ovn-kubernetes Is there something I have done wrong in my PR?

@cjyabraham are you able to see why this isn't rendering?

The logo comes from Landscape and it isn't currently set up there. If you fix it on landscape it should propagate down to the Contribute site in a day or two.

[tssurya]

@krook @RobertKielty : I unfortunately still don't see the logo rendering correctly here: https://contribute.cncf.io/contributors/projects/#ovn-kubernetes Is there something I have done wrong in my PR?

@cjyabraham are you able to see why this isn't rendering?

The logo comes from Landscape and it isn't currently set up there. If you fix it on landscape it should propagate down to the Contribute site in a day or two.

How do I fix it on landscape? I don't see a way for me to edit it there. I had fixed the artwork linking on my PR for the landscape repo already..Is it supposed to be pointing to that exact logo that should be present there?

[tssurya]

@krook / @RobertKielty : another quick question: I'd like to transfer this netlify domain https://ovn-kubernetes.io/ over to CNCF management. I have opened https://jira.linuxfoundation.org/plugins/servlet/desk/portal/2/IT-27810 for the same, Please help with what needs to be done for this to be completed.

Thanks @tssurya. LF IT should be able to work on the domain transfer. @nate-double-u can help with the Netlify part. Please open a CNCF Service Desk ticket for that and we'll get it sorted.

yes I opened a ticket for this: https://jira.linuxfoundation.org/plugins/servlet/desk/portal/2/IT-27830 but unfortunately I think I still need to get the zone file to get my DNS record management moved as well. But I think the website has been moved to CNCF already? Not entirely sure if it has been completed.

[tssurya]

@krook @RobertKielty : I unfortunately still don't see the logo rendering correctly here: https://contribute.cncf.io/contributors/projects/#ovn-kubernetes Is there something I have done wrong in my PR?

@cjyabraham are you able to see why this isn't rendering?

The logo comes from Landscape and it isn't currently set up there. If you fix it on landscape it should propagate down to the Contribute site in a day or two.

How do I fix it on landscape? I don't see a way for me to edit it there. I had fixed the artwork linking on my PR for the landscape repo already..Is it supposed to be pointing to that exact logo that should be present there?

@cjyabraham could you please help?

[cjyabraham]

@krook @RobertKielty : I unfortunately still don't see the logo rendering correctly here: https://contribute.cncf.io/contributors/projects/#ovn-kubernetes Is there something I have done wrong in my PR?

@cjyabraham are you able to see why this isn't rendering?

The logo comes from Landscape and it isn't currently set up there. If you fix it on landscape it should propagate down to the Contribute site in a day or two.

How do I fix it on landscape? I don't see a way for me to edit it there. I had fixed the artwork linking on my PR for the landscape repo already..Is it supposed to be pointing to that exact logo that should be present there?

@cjyabraham could you please help?

The landscape.yml file is looking for ovn-kubernetes.svg as configured on this line. You'll need to PR that repo to add ovn-kubernetes.svg to the hosted_logos directory. Does that make sense?

[tssurya]

@krook @RobertKielty : I unfortunately still don't see the logo rendering correctly here: https://contribute.cncf.io/contributors/projects/#ovn-kubernetes Is there something I have done wrong in my PR?

@cjyabraham are you able to see why this isn't rendering?

The logo comes from Landscape and it isn't currently set up there. If you fix it on landscape it should propagate down to the Contribute site in a day or two.

How do I fix it on landscape? I don't see a way for me to edit it there. I had fixed the artwork linking on my PR for the landscape repo already..Is it supposed to be pointing to that exact logo that should be present there?

@cjyabraham could you please help?

The landscape.yml file is looking for ovn-kubernetes.svg as configured on this line. You'll need to PR that repo to add ovn-kubernetes.svg to the hosted_logos directory. Does that make sense?

yes! cncf/landscape#4259 thank you!

[tssurya]

@krook : one other thing.. for running the upstream meetings could we use/add community meetings into cncf zoom/calendar for sandbox projects? I don't see that in the checklist but thought of asking..

[krook]

@krook : one other thing.. for running the upstream meetings could we use/add community meetings into cncf zoom/calendar for sandbox projects? I don't see that in the checklist but thought of asking..

Yes, you can use Service Desk to open a ticket to add it to the CNCF Community Calendar.

Separately, what Zoom account are you using now?

[cynthia-sg]

Project has been added to CLOMonitor

[krook]

Now that your project is in the CNCF GitHub Enterprise account we're going to do these two tasks on our side:

• Add thelinuxfoundation as 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.

[krook]

Hi @tssurya do you have an update on these tasks:

• Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected]. The "Project" is CNCF.
• 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 file).
• Start on an OpenSSF Best Practices Badge.
• Invite developers to the #maintainers-circle Slack channel. This one you can actually do yourself as it's a public channel now.

[tssurya]

Hi @tssurya do you have an update on these tasks:

• Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected].The "Project" is CNCF.

There is a ticket in one of the comments above, the website was transferred.. the domain not yet. I need to wait for another 30days or so before being able to transfer from name.com to cncf. (Because I recently transferred from netlify to name.com and there is some rule around this), but more so the transfer was tried and it didn't work.. so we will try again in some days

• [ ] 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 file).
• [ ] Start on an OpenSSF Best Practices Badge.

these two not yet, I'll try to finish this asap. apologies for the delay

• [ ] Invite developers to the #maintainers-circle Slack channel. This one you can actually do yourself as it's a public channel now.

yes this was done, all maintainers were added to that channel.

[krook]

Excellent, thank you @tssurya. This would be the website footer:

Copyright © OVN-Kubernetes a Series of LF Projects, LLC
For website terms of use, trademark policy and other project policies please see lfprojects.org/policies/.

[krook]

Working with @tssurya, latest status:

This is underway with LF IT:

• Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected].

This will be handled through a Service Desk ticket for staff to help with:

• 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 file).

This @riaankleinhans can help with:

• Send a welcome email to confirm maintainer list access.

[tssurya]

Hi @tssurya do you have an update on these tasks:

• Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected].The "Project" is CNCF.

There is a ticket in one of the comments above, the website was transferred.. the domain not yet. I need to wait for another 30days or so before being able to transfer from name.com to cncf. (Because I recently transferred from netlify to name.com and there is some rule around this), but more so the transfer was tried and it didn't work.. so we will try again in some days

Still working with Johnson on 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 file).[ ] [ ] Start on an OpenSSF Best Practices Badge.

these two not yet, I'll try to finish this asap. apologies for the delay

This is done: https://cncfservicedesk.atlassian.net/servicedesk/customer/portal/1/CNCFSD-2756

[riaankleinhans]

Mailing list created: