cncf
[PROJECT ONBOARDING] Interlink
Welcome to CNCF Project Onboarding
Sandbox Application reference issue: https://github.com/cncf/sandbox/issues/343
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.
- [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. 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
- [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.
- [ ] 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.
- [x] 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.
Alright, thanks @krook ! We are working and the onboarding tasks, I'll report back soon as they have been completed
Welcome to CNCF Project Onboarding
Sandbox Application reference issue: #343
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.
- [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. Let the TOC know if you plan to change your project name.
- [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] 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.
- [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.- [ ] 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.
- [ ] 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.- [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].
- [ ] 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.
- [ ] 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
Created a separate GitHub organization and thelinuxfoundation invited as owner.
Moving the project repos now.
UPD. @dciangot I've just noticed your most recent message. Once the migration is completed, please ping me and I'll update the landscape with the new links (or you can do it by opening a PR directly).
Hi @idvoretskyi , I did take a look at the PR for the landscape. The description and tags looks a bit off w.r.t. the project scope. I'm afraid that is misreferenced description. Can you double check with the description here https://github.com/cncf/sandbox/issues/343 ?
@dciangot purely my fault, apologies about that.
I'll update the description shortly.
@dciangot here's the updated one - https://github.com/cncf/landscape/pull/4264
@dciangot 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.
@dciangot 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.
@krook I've just forwarded the Agreement to our legal office, I'll let you know as soon as I'll hear back from them
cncf/landscape#4264
@idvoretskyi I have just noticed that the category was left the same as before fixing the description. I think that it should land close to where "Virtual Kubelet" lives currently. Can it be moved there?
@krook I've just forwarded the Agreement to our legal office, I'll let you know as soon as I'll hear back from them
Thanks @dciangot. In the meantime are there other tasks we can mark complete?
Hi @krook , yes. We are missing the last repository to be migrated to the new org and final descriptions (here https://github.com/interlink-hq) and the last artworks to be produced for the PR.
All the rest should have almost gone (I'm updating with a tick as they complete).
Regarding the org, will inviting thelinuxfoudantion account be enough or we do need to send a ping here?
Regarding the org, will inviting thelinuxfoudantion account be enough or we do need to send a ping here?
Thanks @dciangot. Once we invite the new org into our GitHub Enterprise account we can then add thelinuxfoundation as an org owner ourselves, so no need to invite.
Mailing list created and welcome email sent https://lists.cncf.io/g/cncf-interlink-maintainers/messages
@dciangot @spigad @bianco95 for license scanning, can you let know if you have a preference to use Snyk or FOSSA for license scanning? Feel free to reach to me on cloud-native Slack.
Working with @dciangot on setting up the team on FOSSA, I noted that the branded project name is capitized as interLink not Interlink, so I updated the issue description accordingly.
@dciangot is now a Team Admin over on FOSSA and can add the remaining maintainers to the Team when they accept their inviations.
@dciangot I checked that team on FOSSA and it looks like there are no imported projects associated with the team. Did you get a chance to do a Quick Import?
Hi, sorry I didn't @RobertKielty . We are migrating to the new org in a few days, will this cause any issue? I suppose is better importing the repo once in the final location, is this correct?
Hi @dciangot, as soon as you've imported the repos in the new project org into FOSSA we can mark the task complete.
@RobertKielty repo imported and associated with the team in FOSSA
Do you mind sending the invite again to the other two maintainers? they where away and the invite is now expired.
@dciangot thanks for that update.
I have re-sent FOSSA invitations out to @spigad @bianco95
@dciangot as you are a Team Admin, you can add them to the interLink FOSSA Team when they accept their invitations.
@dciangot you will need to add all of the code repos in the interLink-hq org to FOSSA.
https://github.com/orgs/interlink-hq/repositories
@dciangot you will need to add all of the code repos in the interLink-hq org to FOSSA.
https://github.com/orgs/interlink-hq/repositories
Done! @RobertKielty about the scan results, is there any documented guideline or any channel where we can ask how to handle that properly?
Thanks so much @dciangot! I can see that you imported 10 repos and that they are being scanned by FOSSA. I have marked this on-boarding task as complete.
The CNCF 3rd Party License Policy is described here
https://github.com/cncf/foundation/blob/main/allowed-third-party-license-policy.md
When logged in to FOSSA, you can review our policy configuration
https://app.fossa.com/policies/licensing
@mrbobbytables and @krook can advise you from a process point of view on how to handle reports of non-compliance made within FOSSA.
@mrbobbytables and @krook can advise you from a process point of view on how to handle reports of non-compliance made within FOSSA.
Please share the report here @dciangot FYI @jeefy and we can review