toc
toc copied to clipboard
cncf
[SANDBOX PROJECT ONBOARDING] Kanister
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#introduction
- [ ] Understand 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-policy
- [ ] Review the online programs guidelines: https://github.com/cncf/foundation/blob/master/online-programs-guidelines.md
- [ ] Understand 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-allowlist
- [ ] Is 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)
- [x] 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.io
- [ ] Create maintainer list + add to aggregated https://maintainers.cncf.io list by submitting a PR to it
- [ ] Artwork: Submit a pull request to https://github.com/cncf/artwork with your artwork
- [ ] Domain: 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 - [email protected] is the best email to send those to
- [ ] Trademarks: transfer any trademark and logo mark assets over to the LF - https://github.com/cncf/foundation/tree/master/agreements has agreements
- [x] GitHub: 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/cncf
- [ ] GitHub: ensure DCO or CLA are enabled for all GitHub repositories of the project
- [ ] GitHub: ensure that that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's README on GitHub
- [x] Website: 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 [email protected]
- [ ] OpenSSF 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:
- [x] Devstats: add to devstats https://devstats.cncf.io/
- [x] Insights: add to LFX Insights https://insights.v3.lfx.linuxfoundation.org/
- [x] Marketing: update relevant intro + slide decks
- [x] Events: update CFP + Registration + CFP Area forms
- [ ] ServiceDesk: confirm maintainers have read https://www.cncf.io/services-for-projects/
- [ ] CNCF Welcome Email Sent to confirm maintainer list access
- [ ] Book time with the team with http://project-meetings.cncf.io
- [ ] Create 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)
- [ ] Adopt a license scanning tool, like FOSSA or Snyk
Also added to All CNCF (example of commits dashboards with 5 new Sandbox projects selected) DevStats instance, here are Project Health(s) dashboards: link 1, link 2.
Hi @mlavi! Have you or your team had a chance to check this list out and start working on tasks?
Hi Crystal, we stopped until we got past Kubecon and now we're picking up again! We'll link in some Kanister issues to show progress, such as https://github.com/kanisterio/kanister/issues/221
I'll be speaking to Veeam Legal tomorrow to start the process on their side.
Hello @mlavi! I’ve invited your GitHub organization to the CNCF GitHub Enterprise account.
Once you accept the invitation, we can then add thelinuxfoundation as an owner, and then onboard you to LFX Insights (which is a matter of adding an app, similar to adding the DCO bot) which uses read only, public data to drive the reports on the Insights dashboard.
That would mark these two checklist items as up-to-date and complete (and it supersedes the need to add Chris and I as owners):
- [ ] GitHub: ensure
thelinuxfoundation,caniszczyk, andkrookare added as initial org owners, this helps us make sure we have continuity of GH ownership while we onboard you to our GitHub Enterprise instance: https://github.com/enterprises/cncf - [ ] Insights: add to LFX Insights https://insights.v3.lfx.linuxfoundation.org/
You can learn more about Insights here:
Please let me know if you have any questions about onboarding GHE and/or Insights.
Thank you @krook, @pavannd1 has responded to the invitation.
Hello @Cmierly, we would like to migrate the Kanister.io web site to GitHub pages, under control of the Kanisterio organization. Currently, the https://github.com/kanisterio/website/settings/pages says "Pages on this repository are disabled. Please contact your organization administrators."
Is there another web hosting option available or preferred, or could we ask to enable this for the https://github.com/kanisterio/website repository?
We'll be working on DNS next.
Hello @Cmierly, we would like to migrate the Kanister.io web site to GitHub pages, under control of the Kanisterio organization. Currently, the https://github.com/kanisterio/website/settings/pages says "Pages on this repository are disabled. Please contact your organization administrators."
Is there another web hosting option available or preferred, or could we ask to enable this for the https://github.com/kanisterio/website repository?
Hi @mlavi. I'm looking into this.
The LFX Insights onboarding task is now marked complete on the CNCF side.
Once the initial data load finishes, I'll share a link to your project-specific dashboard where you can explore dashboards and reports. It should be ready for you by the end of the week.
Insights data loading is complete. You can now check out the Kanister-specific dashboard here.
Through the left nav, you can go through the Overview, Velocity, and Productivity dashboards. There is also a set of info on Contributors, Organizations, and Activities under the Reports section. All of them can be filtered by timeframe.
You can find Insights documentation here, file tickets if something doesn't look right (v3 is in beta so any reports are very helpful), and post public feedback at this forum topic.
Hello @Cmierly I have worked with our Legal team to complete the CNCF Trademark and Account Assignment Agreement, can we use DocuSign to execute the agreement? If so, what email address should I ask them to send it to? Thanks.
Could you please check as completed, both can be verified at https://github.com/orgs/kanisterio/people/enterprise_owners
- is your project in its own separate neutral github organization?
- GitHub: ensure 'thelinuxfoundation' and 'caniszczyk' are added as initial org owners
Hello @Cmierly I have worked with our Legal team to complete the CNCF Trademark and Account Assignment Agreement, can we use DocuSign to execute the agreement? If so, what email address should I ask them to send it to? Thanks.
Just send a signed PDF to [email protected] and we'll revert a fully executed copy from there.
Sorry for the slow progress on this, but we continue to move forward and track work here: https://github.com/orgs/kanisterio/projects/2
PR to modify the existing Kanister entry in the landscape: https://github.com/cncf/landscape/pull/3797
I just checked with Veeam Legal and the Trademark/assignment agreement was signed and sent with DocuSign to [email protected], could @amye or @Cmierly check? Thank you!
We'll be in the Project Pavillion Kiosk #PP3-A on Wednesday next week for KubeCon!
Ah, so! We just need a signed PDF sent to that address, it cannot do Docusign.
@amye It is possible to follow the DocuSign link just to download the PDF? I believe it is the system of record our Legal team uses to acknowledge receipt.
@Cmierly can you pleaseadd @mlavi to the Kanister project maintainer mailing list?
Hi @mlavi I have set up a FOSSA Team and Account for the project. We use FOSSA to check and report on CNCF license policy compliance.
I've sent instructions to the project's maintainers list. Once you have access to that list check the FOSSA message I have sent it has instructions on what to do next.
@RobertKielty I can certainly do that but I will need @mlavi to send me the aggregated maintainers list so I can properly add them to the mailing list
@Cmierly @amye Sorry to be a pest: if you received the DocuSign link that was sent in email, you can click through to download the PDF agreement. Is that possible?
Hi @mlavi ! I have grabbed a copy of the document and sent it out to be signed off on our end. I'll send you an email with the fully executed document once it's completed
@Cmierly @amye we are updating our Maintainers now, we have a question: do we need to disclose email addresses for each individual maintainer (we are disclosing GitHub accounts, of course) or can we advertise a group alias for maintainers? We would prefer the latter.
Hello @Cmierly we moved the https://www.kanister.io website to GitHub page hosting within the project this week, so it is now self-contained.
I've just updated the footer: could you review and check off the "Website: ensure LF footer..." item or let me know if I misinterpreted the requirements? Thanks.
I am still keeping an eye out for the email on the CNCF execution of the agreement.
I've checked off the footer task.
@Cmierly do we have an update on the agreement from our side?
@krook @mlavi Hi! I do have the document but I also still need the emails for the Kanister maintainers. I currently don't have a way to mail the completed copy to @mlavi
Kanister setup on FOSSA and Snyk but I have no email addresses to send invites to.
I checked for emails to send out invites for access to the FOSSA and Snyk services.
Looks like we don't have those yet on record?
cc @Cmierly @mlavi @krook