cncf
[PROJECT ONBOARDING] Drasi
Welcome to CNCF Project Onboarding
Sandbox reference issue: https://github.com/cncf/sandbox/issues/296
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.
- [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.
- [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] 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. - [x] 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
- [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. - [ ] 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. - [ ] 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.
- [ ] 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.
Thanks for kicking off the onboarding process! I'll start tracking the work for onboarding once we have the Project Contribution Agreement" in place.
Welcome to the CNCF Sandbox! We're creating the Contribution Agreement document for you now and should have it to you shortly.
In the meantime, there are a few generic tasks in this checklist that you can work on that don't have a hard dependency on the CA, such as reviewing documents, documenting any governance you may already have, and preparing your maintainer lists to share.
Welcome to CNCF Project Onboarding
Sandbox reference issue: #296
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 further project onboarding tasks can be completed.
- [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.[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] 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.[x] 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.[x] 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 theREADME.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].[x] Start working on written, open governance and consider adding this to aGOVERNANCE.mdfile at the root of your repo.[ ] Start on an OpenSSF Best Practices Badge.CNCF staff tasks to support the project
- [ ] 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 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.
The Contribution Agreement has just been sent by email to the folks listed on the Sandbox application.
The Contribution Agreement has just been sent by email to the folks listed on the Sandbox application.
Hi @krook , I've replied to the email you sent with a request that came from our legal department. Would it possible to take look and let me know what the next steps are?
The Contribution Agreement has just been sent by email to the folks listed on the Sandbox application.
Hi @krook , I've replied to the email you sent with a request that came from our legal department. Would it possible to take look and let me know what the next steps are?
Hi @krook, just wanted to make sure it was okay to send over the signed Contibution Agreement doc with all the fields filled in as a PDF. If not, we can redo it.
Hi @krook, just wanted to make sure it was okay to send over the signed Contibution Agreement doc with all the fileds filled in as a PDF. If not, we can redo it.
Hi @NValsan, thank you I've asked our Legal folks to confirm. Also just synced our checklist above with your completed tasks.
Hi @krook, the Docusign Project Contribution Agreement has been signed by the Drasi team. Is there anything else we need to do to kickoff the CNCF GitHub Enterprise Account process?
Hi @krook, the Docusign Project Contribution Agreement has been signed by the Drasi team. Is there anything else we need to do to kickoff the CNCF GitHub Enterprise Account process?
Excellent, thank you @NValsan. The drasi-project needs to be released from the current GitHub Enterprise account that it's part of before we can invite it.
On the https://github.com/enterprises/[$YOUR_ORG]/organizations page you need to click on the 3 dot menu and choose "Remove organization". When that's done we can invite to the CNCF GHE.
Hi @krook, we're working through the process of transferring our domain ownership to the CNCF. Is there any documentation about how new records can be added when needed and who will maintain/approve changes once the transfer is complete?
... we're working through the process of transferring our domain ownership to the CNCF. Is there any documentation about how new records can be added when needed and who will maintain/approve changes once the transfer is complete?
Hi @NValsan, our public facing documentation is a little out of date. I'll try to get that updated pretty quick, but in the meantime, here's the info:
- Domains
- We recommend letting the CNCF purchase any new domains for you. You can open a ticket using the service desk. We also recommend against using the
.ioTLD.
- We recommend letting the CNCF purchase any new domains for you. You can open a ticket using the service desk. We also recommend against using the
- DNS
- We usually set this up one of two ways:
- Delegate DNS to Netlify If we go this way, DNS becomes self serve. We'll add you and any maintainers who need access to the Netlify team and you'll be able to make any updates you need. This works really well if you're also hosting with Netlify.
- Let the LF manage. This method also works well, but your project would have to open a service desk ticket for any changes you'd need.
- We usually set this up one of two ways:
Thank you @krook ! Ideally we'd like to go with the DNS-> Netlify approach so that we can add records as needed.
FYI, @krook I have put in a request to move the Drasi domain to CNCF ownership with the zones file we have but we'd like to ensure that the DNS records are fully in place before unlocking and transferring the domain. Will update the checklist once the full transfer is completed.
FYI, @krook I have put in a request to move the Drasi domain to CNCF ownership with the zones file we have but we'd like to ensure that the DNS records are fully in place before unlocking and transferring the domain. Will update the checklist once the full transfer is completed.
Thanks @NValsan. FYI @nate-double-u
Hi @idvoretskyi , the Drasi logo isn't showing in the landscape (I checked in Grid and Card mode). Is there something I need to do to help with this? I'd be happy to help.
@NValsan if you could add your artwork logo to https://github.com/cncf/landscape/tree/master/hosted_logos, it would be great :)
@NValsan if you could add your artwork logo to https://github.com/cncf/landscape/tree/master/hosted_logos, it would be great :)
Thanks, @idvoretskyi . I opened PR, https://github.com/cncf/landscape/pull/4324, for this.
Hi @krook, the Drasi project is now a neutral free standing org. Could you send us an invite to the CNCF EA? This is for this checklist item, " 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."
I was wondering about transferring the analytics of the Drasi website to the CNCF. We have Google Analytics enabled already. I looked at the docs for analytics here, https://github.com/cncf/techdocs/blob/c6cb637b9fafd991eef399ede9bc060927c7f618/docs/analytics.md, and didn't see anything about how to transfer ownership to the CNCF (this checklist item"Transfer website analytics to [email protected]. CNCF staff can help"). Are there other reference docs I can use, @krook?
@agentofreality @amansinghoriginal @danielgerlag @ruokun-niu I can send out invitations to set you up on FOSSA or Snyk for license scanning, do you have a preference for either service?
I have set up the project on both services, and sent out invitations for FOSSA. If you prefer to use Snyk let me know.
I checked the FOSSA Inviations and the invitations have yet to be accepted. I will send out Snyk invations now also.
didn't see anything about how to transfer ownership to the CNCF (this checklist item"Transfer website analytics to [email protected]. CNCF staff can help")
Hi @NValsan - make [email protected] an Admin of your Google Account. Let us know which property(ies) are to be migrated and we'll migrate them to the CNCF Projects GA account.
didn't see anything about how to transfer ownership to the CNCF (this checklist item"Transfer website analytics to [email protected]. CNCF staff can help")
Hi @NValsan - make [email protected] an Admin of your Google Account. Let us know which property(ies) are to be migrated and we'll migrate them to the CNCF Projects GA account.
Thanks @chalin ! I've added the [email protected] account as an admin to our exisiting Google Analytics account which we use to track visits to the drasi.io website.