toc icon indicating copy to clipboard operation
toc copied to clipboard

[SANDBOX PROJECT ONBOARDING] KubeArmor

Open amye opened this issue 4 years ago • 42 comments

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:

  • [x] Understand the project proposal process and reqs: https://github.com/cncf/toc/blob/main/process/project_proposals.adoc#introduction
  • [x] Understand the services available for your project at CNCF https://www.cncf.io/services-for-projects/
  • [x] Ensure your project meets the CNCF IP Policy: https://github.com/cncf/foundation/blob/master/charter.md#11-ip-policy
  • [x] Review the online programs guidelines: https://github.com/cncf/foundation/blob/master/online-programs-guidelines.md
  • [x] Understand the trademark guidelines: https://www.linuxfoundation.org/en/trademark-usage/
  • [x] Understand the license allowlist: https://github.com/cncf/foundation/blob/master/allowed-third-party-license-policy.md#approved-licenses-for-allowlist
  • [x] Has your project adopted open governance already? see http://opengovernance.dev
  • [ ] 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?
  • [x] Submitted a Pull request to add your project as a sandbox project to https://landscape.cncf.io
  • [x] Create maintainer list + add to aggregated https://maintainers.cncf.io list by submitting a PR to it
  • [x] Have added your project to https://github.com/cncf/contribute
  • [x] Artwork: Submit a pull request to https://github.com/cncf/artwork with your artwork
  • [x] -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:

  • [x] Provide emails for the maintainers added to https://maintainers.cncf.io in order to get access to the maintainers mailing list and ServiceDesk
  • [x] 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
  • [x] GitHub: ensure DCO or CLA are enabled for all GitHub repositories of the project
  • [x] Website: ensure LF footer is there and website guidelines followed
  • [x] Website: Analytics transferred to [email protected]
  • [x] CII: Start on a CII 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
  • [x] ServiceDesk: confirm maintainers have read https://www.cncf.io/services-for-projects/
  • [x] CNCF Welcome Email Sent to confirm maintainer list access, welcome email has monthly project sync details
  • [x] 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)
  • [x] Adopt a license scanning tool, like FOSSA or Snyk

amye avatar Nov 16 '21 17:11 amye

@nyrahul has beaten me to inviting you all in, I have marked off 'contribute'!

amye avatar Nov 16 '21 19:11 amye

DevStats page added.

lukaszgryglicki avatar Nov 17 '21 17:11 lukaszgryglicki

@nyrahul: Anything we can do to help here? We'd like to get everyone completely onboarded by December 15th.

amye avatar Nov 24 '21 20:11 amye

@nyrahul: Anything we can do to help here? We'd like to get everyone completely onboarded by December 15th.

Thanks @amye. We should be able to handle by Dec 15th. (CC: @namdeirf)

We can tick following action items:

  • Understand the project proposal process and reqs: main/process/project_proposals.adoc#introduction

  • Understand the services available for your project at CNCF cncf.io/services-for-projects

  • Review the online programs guidelines: cncf/foundation@master/online-programs-guidelines.md

  • Understand the license allowlist: cncf/foundation@master/allowed-third-party-license-policy.md#approved-licenses-for-allowlist

  • Is your project in its own separate neutral github organization?

  • Create maintainer list + add to aggregated maintainers.cncf.io list by submitting a PR to it (ref: cncf/foundation#257)

  • Provide emails for the maintainers added to maintainers.cncf.io in order to get access to the maintainers mailing list and ServiceDesk

  • GitHub: ensure 'thelinuxfoundation' and 'caniszczyk' are added as initial org owners, this helps us make sure we have continuity of GH ownership

    • sent invitation

nyrahul avatar Nov 25 '21 05:11 nyrahul

@amye Thank you to everyone for moving so quickly!

I am working with the legal team on our side for the trademarks transfer, but when looking at the the pdfs here at cncf/foundation/agreements I do not see editable versions. I downloaded and viewed in Firefox and Preview, so perhaps it is a technical issue on my end? Please let me know if there is an editable version or Docusign version we can fill out.

namdeirf avatar Nov 30 '21 20:11 namdeirf

@amye Thank you to everyone for moving so quickly!

I am working with the legal team on our side for the trademarks transfer, but when looking at the the pdfs here at cncf/foundation/agreements I do not see editable versions. I downloaded and viewed in Firefox and Preview, so perhaps it is a technical issue on my end? Please let me know if there is an editable version or Docusign version we can fill out.

Correct, these are PDFs that can be loaded into docusign. Send me a signed copy from your side, I'll return a fully executed copy.

amye avatar Nov 30 '21 20:11 amye

@amye, we can mark following tasks as done: CC: @namdeirf

  • Ensure your project meets the CNCF IP Policy: cncf/foundation@master/charter.md#11-ip-policy
  • Understand the trademark guidelines: linuxfoundation.org/en/trademark-usage
  • Has your project adopted open governance already? see http://opengovernance.dev (Ref: kubearmor/KubeArmor#516)
  • Have added your project to cncf/contribute (Ref: cncf/contribute#83)
  • Artwork: Submit a pull request to cncf/artwork with your artwork (Ref: cncf/artwork#317)
  • GitHub: ensure DCO or CLA are enabled for all GitHub repositories of the project (Comment: we have now mandated/automated DCO for all commits in the relevant repos)

Thanks

nyrahul avatar Dec 06 '21 16:12 nyrahul

@nyrahul I'll check them for you.

Do you need any assistance with the remaining items?

idvoretskyi avatar Dec 06 '21 17:12 idvoretskyi

@nyrahul I'll check them for you.

Do you need any assistance with the remaining items?

Thanks @idvoretskyi , we are working on getting the domain transfer, trademark and logo asset transfer, analytics transferred. I am not sure how this works but my teammate @namdeirf is working on this and has been raising the doubts. @namdeirf, if you have any pending doubts please let know here. Thanks

nyrahul avatar Dec 07 '21 06:12 nyrahul

@nyrahul Great!

idvoretskyi avatar Dec 07 '21 10:12 idvoretskyi

@idvoretskyi Can add new checkmarks:

Complete

  • [x] Ensure your project meets the CNCF IP Policy: https://github.com/cncf/foundation/blob/master/charter.md#11-ip-policy
  • [x] GitHub: ensure DCO or CLA are enabled for all GitHub repositories of the project
  • [x] CII: Start on a CII best practices badge https://bestpractices.coreinfrastructure.org/en
  • [x] Understand the trademark guidelines: https://www.linuxfoundation.org/en/trademark-usage/
  • [x] Understand the license allowlist: https://github.com/cncf/foundation/blob/master/allowed-third-party-license-policy.md#approved-licenses-for-allowlist
  • [x] Has your project adopted open governance already? see http://opengovernance.dev
  • [x] Have added your project to https://github.com/cncf/contribute | here
  • [x] Artwork: Submit a pull request to https://github.com/cncf/artwork with your artwork | https://github.com/cncf/artwork/pull/317

In progress on LF's end

  • [x] Submitted a Pull request to add your project as a sandbox project to https://landscape.cncf.io | https://github.com/cncf/landscape/pull/2381
  • [ ] Create space for meetings/events on https://community.cncf.io _ We are having some challenges filling out the form behind this link: https://servicedesk.cncf.io/ | @nyrahul

In progress on KubeArmor's end

  • [ ] Website: ensure LF footer is there and website guidelines followed
  • [ ] Adopt a license scanning tool, like FOSSA or Snyk
  • [ ] Trademarks: transfer any trademark and logo mark assets over to the LF - https://github.com/cncf/foundation/tree/master/agreements has agreements
  • [ ] 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)
  • [ ] Website: Analytics transferred to [email protected]

namdeirf avatar Dec 09 '21 06:12 namdeirf

Thanks, @namdeirf!

_ We are having some challenges filling out the form behind this link: https://servicedesk.cncf.io/ | @nyrahul

What's your issue here? I may try to help.

idvoretskyi avatar Dec 09 '21 12:12 idvoretskyi

Thanks @idvoretskyi, the instructions for projects on the community page have us go to this link

To request a community chapter for the CNCF project, please file a ticket to the CNCF ServiceDesk - https://servicedesk.cncf.io

It states it's meant for maintainers so I asked to @nyrahul create the space for us, however, he is getting an error message I shared in a screenshot. Screen Shot 2021-12-09 at 8 37 10 AM

We want to move our regular technical meetings and office hours to the community group as soon as we can.

Thank you for working with us on this!

namdeirf avatar Dec 09 '21 18:12 namdeirf

@idvoretskyi, this came up on our internal call today that I could not answer, so I apologize if these are silly questions

License Scanning Tool ...

  1. is there an existing CNCF license that we should leverage? or create our own.
  2. is there any guidance on choosing between Snyk/FOSSA outside of preference, familiarity? - ie is geared towards one type of project vs. another. I suspect it is a 'it depends' answer.

If the above is easier to answer via a call, I am happy to do that.

namdeirf avatar Dec 09 '21 19:12 namdeirf

Access to servicedesk is fixed now!

Re: license, are you looking for https://github.com/cncf/foundation/blob/master/charter.md#11-ip-policy ?

amye avatar Dec 09 '21 19:12 amye

Thank you @amye for addressing the service desk so quickly! and sorry for the confusion from me, rereading I see it is not as clear as I could be.

Regarding my question on license is was more along the lines of is there an official CNCF Snyk/FOSSA account we leverage for the KubeArmor project for license scanning, or do we simply create one on our own?

namdeirf avatar Dec 09 '21 19:12 namdeirf

Ohhhh, ok yes that is an @idvoretskyi question.

amye avatar Dec 09 '21 19:12 amye

Regarding my question on license is was more along the lines of is there an official CNCF Snyk/FOSSA account we leverage for the KubeArmor project for license scanning, or do we simply create one on our own?

@namdeirf we can provide you with licenses for both tools, just whatever you prefer. Note that FOSSA is mostly a purely license-scanning tool (https://fossa.com/product/open-source-license-compliance), while Snyk is way more feature-rich with the focus on security&vulnerability scanning (https://snyk.io/product/open-source-security-management/), so you can use it for other purposes.

Once you decide, please fille a ServiceDesk ticket and I'll provide you with the further license details :)

idvoretskyi avatar Dec 10 '21 18:12 idvoretskyi

Hope you have a good weekend @idvoretskyi, when you get back, doing the landscape steps: I got this error message https://github.com/cncf/landscape/pull/2385#issuecomment-991372632

Build failed because of: item KubeArmor has an invalid repo https://github.com/kubearmor/KubeArmor/

Anything you can do to point me in the right direction thank you!

namdeirf avatar Dec 10 '21 23:12 namdeirf

@namdeirf please open an issue under the landscape repo, folks will follow up :)

idvoretskyi avatar Dec 11 '21 05:12 idvoretskyi

@idvoretskyi / @amye Hope you all had a good weekend.

License scanning tool: The project leverages Apache SkyWalking Eyes. If this meets the requirements for the Sandbox project we can check that off, if not please let us know. Info in this tool can be found here.

Thanks!

namdeirf avatar Dec 13 '21 16:12 namdeirf

@namdeirf can we see a license scanning report of this tool provided for your project?

idvoretskyi avatar Dec 13 '21 16:12 idvoretskyi

@idvoretskyi here is our generated report: https://gist.github.com/daemon1024/3ed45e9294f5bd4f273d03d90d0a6549

If we need to make changes, etc happy to do it.

namdeirf avatar Dec 13 '21 18:12 namdeirf

@namdeirf ideally, if you could add a badge to the project README, which can point out to the generated report (this is something that FOSSA allows, for instance).

idvoretskyi avatar Dec 13 '21 20:12 idvoretskyi

Updates

Complete

  • Website: ensure LF footer is there and website guidelines followed (see here)
  • Website: Analytics transferred to [email protected] (email sent)
  • Create space for meetings/events (Ticket filed)

In progress:

  • Adopt a license scanning tool, like FOSSA or Snyk (Based on guidance above - The group will most likely agree to adopt Snyk, we are using the opportunity to put our Governance rules to practice at our Thursday meeting)
  • Trademarks: transfer any trademark and logo mark assets over to the LF - https://github.com/cncf/foundation/tree/master/agreements has agreements (Document upload to docusign and waiting signatures, we initially had the wrong destination but since corrected)

namdeirf avatar Dec 14 '21 21:12 namdeirf

Snyk is enabled, checking this off :)

idvoretskyi avatar Dec 15 '21 14:12 idvoretskyi

@namdeirf only Slack and Trademarks are left to check out. I see your comment above on the trademarks, what about Slack?

idvoretskyi avatar Dec 15 '21 14:12 idvoretskyi

re: Slack, @idvoretskyi . We are moving the admin/owner privileges over to me and I'll initiate the transfer ASAP.

namdeirf avatar Dec 15 '21 19:12 namdeirf

I got the Slack message on the export side and uploaded to Drive. to import to CNCF to #kubearmor I do not see the import options so I will need to coordinate with someone who has import permissions to hand them off. We we will want to move all members and all messages from the General channel to the new CNCF channel.

namdeirf avatar Dec 16 '21 21:12 namdeirf

Hey @amye / @idvoretskyi Hope you have a happy new year! Understand people are off for NYE, but when you all get back in, we are trying to resolve that kubearmor.com is 'down'

We transferred the domain name per the sandbox requirements but were intended to still maintain the site. Is this something we can get resolved quickly? Please let me know. If this will take a while can we get it redirected to https://github.com/kubearmor/KubeArmor.

namdeirf avatar Dec 31 '21 22:12 namdeirf