cncf
[PROJECT ONBOARDING] OVN-Kubernetes
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
- [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 CNCF IP Policy.
- [x] The trademark guidelines.
- [x] The license allowlist.
- [x] The online program guidelines.
- [x] Book time with CNCF staff to understand project benefits and event resources.
Contribute and transfer
- [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] 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].
- [x] Transfer any trademark and logo assets to the Linux Foundation via the Contribution Agreement.
- [x] Submit a pull request with your artwork.
- [x] Transfer website analytics to [email protected]. CNCF staff can help.
Update and document
- [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
READMEon 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
READMEfile). - [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.
- [ ] Start on an OpenSSF Best Practices Badge.
CNCF staff tasks
- [x] Add the project to DevStats.
- [x] Add the project to CLOmonitor.
- [x] 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 a license scanning tool, like FOSSA or Snyk.
- [x] Invite developers to the #maintainers-circle Slack channel.
- [ ] Send a welcome email to confirm maintainer list access.
Thank you for the onboarding checklist!! We will get started on this shortly
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
- [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 CNCF IP Policy.
- [x] The trademark guidelines.
- [x] The license allowlist.
- [x] The online program guidelines.
- [x] Book time with CNCF staff to understand project benefits and event resources.
Contribute and transfer
- [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] 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: https://github.com/cncf/landscape/pull/4111
- [x] Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected].
- [x] Transfer any trademark and logo assets to the Linux Foundation.
- [x] Submit a pull request with your artwork. : https://github.com/cncf/artwork/pull/520
- [x] Transfer website analytics to [email protected]. CNCF staff can help.
Update and document
- [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
READMEon 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
READMEfile). - [x] Create a maintainer list and add it to the aggregated CNCF maintainer list via pull request. DONE: https://github.com/cncf/foundation/pull/881
- [x] 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
- [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.[ ] Add the project to LFX Project Control Center.
- [x] Add a license scanning tool, like FOSSA or Snyk.
- [x] Invite developers to the #maintainers-circle Slack channel.
- [x] Send a welcome email to confirm maintainer list access.
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.
@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
@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.
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?
CNCF Landscape PR: https://github.com/cncf/landscape/pull/4111
This needs two more things:
- new slack URL after transfer
- need to wait for repo transfer to happen this coming week
Opened Maintainer List PR: https://github.com/cncf/foundation/pull/881 Also sent the maintainer emails to [email protected]
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.
@tssurya http://servicedesk.cncf.io/
Please drop us a note if you’ll have issues with accessing it.
@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?
@tssurya yes, please email us, and we'll proceed from there.
FYI @Cmierly
@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)
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.
@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
@girishmg and I met at the Project Pavilion we had a look at Slack and FOSSA setup
Marking the FOSSA setup as complete https://app.fossa.com/account/settings/organization/teams/71679
The service desk access still does not work for me, would be awesome to have that sorted...
thank you @Cmierly ! it works now!
- I have created the helpdesk ticket for logo: https://cncfservicedesk.atlassian.net/servicedesk/customer/portal/1/CNCFSD-2558 FYI @girishmg PTAL
- @girishmg you mentioned you spoke with someone during KubeCon around slack migration.. Has this process started already? Do we need a ticket to track that?
- Finally the website domain: https://ovn-kubernetes.io/ we need some help in transferring the domain into CNCF, its currently owned by netlify: shall I start that here: https://jira.linuxfoundation.org/plugins/servlet/desk/portal/2 ?
@girishmg @tssurya I can work on the Slack migration for you.
Ideally, I would join your current Slack Workspace and look around. Would it be possible for me to join temporarily?
@RobertKielty ofc, let me invite you: could you please give me your email that I can use to add you to our workspace?
@tssurya I have accepted your invite to join ovn-org Slack workspace. Thank you for inviting me.
Ideally, we would like an Owner account to export your content and membership. This is the easiest way to complete the migration of users and their messages. Owner exports give the best preservation of existing community content from your workspace.
We do not normally migrate the # general or # random channels.
As the cloud-native workspace hosts channels for many projects we suggest that all project channels are named using a prefix that identifies your project. Most of your channels we would migrate are prefixed perfectly, the only one not prefixed with ovn- is # libovsdb Renaming that channel to # ovn-libovsdb would be best in terms of grouping the channels on lists within the cloud-native Slack Workspace making them discoverable by end-users and collaborators.
Slack imports into the cloud-native workspace will merge your existing workspace user accounts where email addresses match accounts in both workspaces. User accounts in your workspace that are new to the cloud-native workspace will be sent an email invite to join the cloud-native workspace.
Slack imports sometimes fail because certain email domains are barred from joining our Slack workspace. Should that occur, I handle that scenario by logging a support call with Slack.
Finally, when we start the export/import journey to migrate your existing workspace content to the cloud-native workspace, let your existing community know that it is happening and leave messages behind directing community members to the new home for the project.
@jcaamano: how are we looking for migrating the libovsdb project over? any ETA?
We have migrated Slack channels and users over to the cloud-native workspace.
Thank you @tssurya and @girishmg for your work on this!
OVN has been added to CLOMonitor https://clomonitor.io/projects/cncf/kube-ovn so I have marked that as complete also.
update: we are working on https://github.com/cncf/landscape/pull/4111 and logos: https://github.com/cncf/artwork/pull/520