search

cncf / sandbox

Applications for Sandbox go here! ⏳📦🧪
Apache License 2.0
136 stars 22 forks source link

[PROJECT ONBOARDING] OpenEBS #299

Open Cmierly opened 1 month ago

Cmierly commented 1 month ago

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

Contribute and transfer

Update and document

CNCF staff tasks

avishnu commented 1 month ago

Thanks @Cmierly . Since OpenEBS has been previously in Sandbox, majority of the items in the checklist can be marked as completed. Shall I do that with supporting evidence in the quote-reply?

idvoretskyi commented 1 month ago

@avishnu yes, please do (for the full visibility).

avishnu commented 1 month ago

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.

Thanks for sharing. The links provide very useful insights and have been reviewed.

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.

Believe this is completed. Exists at https://github.com/openebs

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.

Believe this is completed. thelinuxfoundation is an organization owner for openebs.

Migrate your Slack channels (if any) to the Kubernetes or CNCF Slack workspace. CNCF staff can help.

Believe this is completed. There are 2 channels 'openebs' (for community users) and 'openebs-dev' (for community developers) in Kubernetes slack workspace. There is also an 'openebs' channel in CNCF slack workspace.

avishnu commented 4 weeks ago

Submit a pull request to add your project as a Sandbox project to the Cloud Native Landscape by updating landscape.yml following these instructions.

OpenEBS is currently existing in the Cloud Native Landscape as a cloud-native storage project.

avishnu commented 4 weeks ago

Transfer your domain to the CNCF. The "LF Stakeholder email" is projects@cncf.io.

Transfer any trademark and logo assets to the Linux Foundation.

Since OpenEBS was previously in Sandbox, the domain, trademark and logo assets are already with CNCF. Can you help us find this information?

avishnu commented 4 weeks ago

Submit a pull request with your artwork.

https://github.com/cncf/artwork/pull/512

avishnu commented 4 weeks ago

Transfer website analytics to projects@cncf.io. CNCF staff can help.

OpenEBS website (https://openebs.io) is integrated with Google Analytics 4 engine. Will reach out to projects@cncf.io for help with transferring.

krook commented 4 weeks ago

Hi Vishnu,

I've marked off the domain name item as I confirmed we have openebs.io and openebs.org in the LF's records.

We do not seem to have the trademark document. We have a new process for that so I will share new documents when they've been generated.

For analytics, you can open a Service Desk ticket to take care of that. Patrice on our team will handle it.

But, in order to get access to Service Desk, we'll also need you to provide your maintainer email addresses. You can send those to project-onboarding@cncf.io.

avishnu commented 3 weeks ago

https://github.com/organizations/openebs/settings/installations/7220130

Hi Vishnu,

I've marked off the domain name item as I confirmed we have openebs.io and openebs.org in the LF's records.

We do not seem to have the trademark document. We have a new process for that so I will share new documents when they've been generated.

For analytics, you can open a Service Desk ticket to take care of that. Patrice on our team will handle it.

But, in order to get access to Service Desk, we'll also need you to provide your maintainer email addresses. You can send those to project-onboarding@cncf.io.

Thanks @krook . I've emailed project-onboarding@cncf.io with the maintainer details. Will wait for the new process of trademark transfer and documents to be shared with us.

RobertKielty commented 3 weeks ago

@avishnu Thank you for submitting the maintainer details

@krook @Cmierly I have added the maintainer details to our internal records.

Now that I have those details, I can invite you to join the CNCF instances of either FOSSA OR Snyk.

Please let me know which scanning service the OpenEBS project would prefer to use to monitor compliance with the license allow list

Many thanks again.

avishnu commented 3 weeks ago

Update and document

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

GitHub app for DCO is installed in OpenEBS GitHub org and enabled for all the repositories. Refer: https://github.com/organizations/openebs/settings/installations/7220130

Ensure that that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's README on GitHub.

Every repository in the project has a reference to CNCF code of conduct (https://github.com/openebs/community/blob/HEAD/CODE_OF_CONDUCT.md). Have raised this PR as well.

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

OpenEBS website (https://openebs.io) has the LF footer and trademark usage guideline sentence. We will make changes for "Sandbox-level projects should include the sentence “We are a Cloud Native Computing Foundation sandbox project.” and the CNCF logo." soon.

Create a maintainer list and add it to the aggregated CNCF maintainer list via pull request.

Raised the PR: https://github.com/cncf/foundation/pull/878 for the aggregated CNCF maintainer list.

Provide emails for the maintainers to get access to the maintainers mailing list and Service Desk. Email them to project-onboarding@cncf.io.

The maintainer details have been emailed to project-onboarding@cncf.io.

Start working on written, open governance.

The current project governance is penned here: https://github.com/openebs/community/blob/develop/GOVERNANCE.md. The maintainers will engage with CNCF on improving this and reaching the open governance benchmarks.

Start on an OpenSSF Best Practices Badge.

OK.

tiagolobocastro commented 3 weeks ago

Ensure that that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's README on GitHub.

@Cmierly what does explicit mean here? We usually point to https://github.com/openebs/community/blob/HEAD/CODE_OF_CONDUCT.md which in turns point to the CNCF Code of Conduct. Does explicit mean we have to point directly to the CNCF Code of Conduct?

are explicitly referenced at the project's README on GitHub.

Guess we ought to modify both the org .github/README and the main repo/README?

krook commented 3 weeks ago

Thanks @avishnu

avishnu commented 3 weeks ago

@avishnu Thank you for submitting the maintainer details

@krook @Cmierly I have added the maintainer details to our internal records.

Now that I have those details, I can invite you to join the CNCF instances of either FOSSA OR Snyk.

Please let me know which scanning service the OpenEBS project would prefer to use to monitor compliance with the license allow list

Many thanks again.

Thanks @RobertKielty . I believe we are already part of a FOSSA 'team' called 'OpenEBS' which has access to 43 repos today. So, we could continue with FOSSA. However, we'd need changes as some of those 43 repos are now 'archived' and transferred under "https://github.com/openebs-archive" CNCF org. Similarly, we may want to add new repos under the "OpenEBS" team, which ought to be there.

tiagolobocastro commented 3 weeks ago

@RobertKielty Having some trouble setting up a fossa CI action with a token created with my account:

      Error: Invalid project permission
      You do not have permission to edit projects for your Organization
avishnu commented 3 weeks ago

Invite developers to the #maintainers-circle Slack channel. - You can actually add yourselves to this public channel @avishnu

I've added myself to the #maintainers-circle Slack channel. Thanks @krook .

RobertKielty commented 3 weeks ago

I have confirmed OpenEBS team is there. https://app.fossa.com/account/settings/organization/teams/485

I have upgraded the permissions of @tiagolobocastro and @avishnu so that you both have Team Admin permissions.

Those permissions mean that you should be able to interact repos (Projects in FOSSA) that have been added to the Team,

tiagolobocastro commented 3 weeks ago

Hi @RobertKielty,

I do see that I am now a team admin but I still seem to have issues when trying to use the github action or the cli tool:

❯ fossa analyze -T OpenEBS                                                                                                                                                                                                          
[ERROR] An issue occurred

  *** Relevant Errors ***

      Error: Invalid project permission
      You do not have permission to edit projects for your Organization
      Documentation: https://docs.fossa.com/docs/role-based-access-control
      Support: If you believe this to be a defect, please report a bug to FOSSA support at https://support.fossa.com
      Help: Contact your FOSSA organization admin to grant you proper permissions
edrob999 commented 3 weeks ago

@krook concerning the OpenEBS trademark:

We do not seem to have the trademark document. We have a new process for that so I will share new documents when they've been generated.

I believe LFX already owns the trademark for OpenEBS (its listed on https://www.linuxfoundation.org/legal/trademarks). Is there anything additional you will need from us?

RobertKielty commented 3 weeks ago

@tiagolobocastro, it was nice meeting you yesterday. Thank you for your time and effort in completing this task.

@krook, Tiagao added 29 OpenEBS repos to the OpenEBS team on CNCF FOSSA

Name Instructions Character
FOSSA Team Click on Project Tab https://app.fossa.com/account/settings/organization/teams/485
GitHub Org N/A https://github.com/orgs/openebs/repositories?type=all
FOSSA Reports Filter By OpenEBS, sort by Issues https://app.fossa.com/projects?sort=issues-total_desc&count=50

Some of the repos have a large number of license issues reported. FOSSA is reporting on all transitive RubyGem dependencies because of Ruby licensing @tiagolobocastro you and the OpenEBS project team can confer with @jeefy and @krook both here and on the onboarding meeting on how to act on the license issues found.

cynthia-sg commented 3 weeks ago

Project has been added to CLOMonitor

avishnu commented 3 weeks ago

Need help on transferring the website analytics. cc @RobertKielty @krook

lukaszgryglicki commented 3 weeks ago

OpenEBS DevStats instance unarchived.

lukaszgryglicki commented 2 weeks ago

Project was added to All CNCF DevStats instance (backfilled data when OpenEBS was archived and fully regenerated all dashboards).