[SANDBOX PROJECT ONBOARDING] Submariner

[amye]

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] Has your project adopted open governance already? see http://opengovernance.dev
• [x] Slack: Are your slack channels migrated to the Kubernetes or CNCF Slack?
• [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

Things that CNCF will need from the project:

• [x] Owners file: Please add a link to your owners file to this issue, this is used to be able to create your maintainers mailing list.
• [x] Create maintainer list + added to aggregated https://maintainers.cncf.io list
• [x] Domain: transfer domain to the CNCF - please send a transfer code to [email protected]
• [ ] 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] Artwork: Ensure logos present on https://github.com/cncf/artwork
• [x] Website: ensure LF footer is there and website guidelines followed
• [x] Website: Analytics transferred to [email protected]
• [x] Adopt a license scanning tool, like FOSSA or Snyk
• [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] 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 community.cncf.io, e.g., https://community.cncf.io/pravega-community/

[amye]

Getting owners file from https://github.com/submariner-io/submariner/blob/devel/CODEOWNERS.in

[amye]

Welcome in @mangelajo, @Oats87, @skitt, @tpantelis! We'll be tracking work in here.

[skitt]

Thanks!

A few items we can check already:

• Slack: our channel is #submariner on the Kubernetes Slack
• The project is in the separate, neutral, Submariner organisation
• We already have GitHub Actions in place to enforce the DCO (see here for example), but I’ve added the DCO bot (and we’ll remove the separate GHA)

[amye]

Marking off those three! Deadline for these is May 27th, so we have some time.

[mangelajo]

Thank you! :)

[lukaszgryglicki]

DevStats test page added, will add prod one soon.

[lukaszgryglicki]

The prod page added as well.

[mangelajo]

Ok, owner invitations sent to 'thelinuxfoundation' and 'caniszczyk' for submariner-io, @amye let me know if those arrive correctly.

[lukaszgryglicki]

All new 6 Sandbox projects added to All CNCF page, also added all of them in Projects health.

[amye]

@skitt, checking back in here! Project side: Understand the project proposal process and reqs: https://github.com/cncf/toc/blob/main/process/project_proposals.adoc#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/ Has your project adopted open governance already? see http://opengovernance.dev Submitted a Pull request to add your project as a sandbox project to https://landscape.cncf.io Domain: transfer domain to the CNCF - please send a transfer code to [email protected] Trademarks: transfer any trademark and logo mark assets over to the LF - https://github.com/cncf/foundation/tree/master/agreements has agreements GitHub: ensure 'thelinuxfoundation' and 'caniszczyk' are added as initial org owners, this helps us make sure we have continuity of GH ownership Artwork: Ensure logos present on https://github.com/cncf/artwork Website: ensure LF footer is there and website guidelines followed Website: Analytics transferred to [email protected] Adopt a license scanning tool, like FOSSA or Snyk CII: Start on a CII best practices badge https://bestpractices.coreinfrastructure.org/en

Thanks!

[dfarrell07]

Hey @amye! Thanks for checking in, be assured we're working to get everything done. We're maintaing details about our progress on https://github.com/submariner-io/submariner/issues/1297. A few things we can check off I think:

• [x] Website: Analytics transferred to [email protected]
  • We don't have analytics. :sweat_smile:
• [x] CII: Start on a CII best practices badge https://bestpractices.coreinfrastructure.org/en
  • We've definitely started, we have a few more TODOs.
  • https://bestpractices.coreinfrastructure.org/en/projects/4865

For this one, I think we need an admin to accept our invite.

• [x] GitHub: ensure 'thelinuxfoundation' and 'caniszczyk' are added as initial org owners, this helps us make sure we have continuity of GH ownership
  • [x] caniszczyk
  • [x] thelinuxfoundation sent but not accepted?

[amye]

Marking those two off, checking on the GH piece.

[skitt]

@amye, regarding the license scanning tool, I’ve been looking at Snyk and FOSSA for a little while but we get a lot of false-positives (bringing back memories of similar efforts on OpenDaylight and discussions with Steve Winslow).

I’m integrating lichen into our CI and local builds for now; this checks the licenses for all the components we end up actually including in the binaries we ship, and fails the build if any component is introduced with an invalid or unknown license. See https://github.com/submariner-io/lighthouse/pull/537 for a merged PR implementing this in one of our projects, and https://github.com/submariner-io/submariner/pull/1326 for proof that this approach catches issues — the PR fails there because we include go-ipify, which doesn’t meet the CNCF’s Allowlist licensing requirements and doesn’t have an exception (we’re working on replacing that).

Could you confirm whether that’s OK or not?

I see this isn’t a requirement for onboarding, but we’ll be adding similar jobs to check for security issues, both periodically across all projects, and on PRs to check that newly-introduced dependencies don’t come with known security issues.

[idvoretskyi]

@skitt I'll let @caniszczyk comment as well, but IMO it's fine to use a different tool as long as it's working properly - https://github.com/cncf/foundation/issues/109#issuecomment-684911295

At the same time, we're using FOSSA across the board for most of our projects, and I'm happy to assist with setting it up for you if needed.

[skitt]

At the same time, we're using FOSSA across the board for most of our projects, and I'm happy to assist with setting it up for you if needed.

Thanks for the offer @idvoretskyi, I’m currently waiting for FOSSA support to get back to me regarding issues I’m having setting my account up there, but I’ll probably take you up on it once that’s sorted out!

[dfarrell07]

I think we can also check these off, as we have a critical mass of the committers signed-off as understanding them:

• [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] 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/

[amye]

Quick check in here, artwork? https://github.com/cncf/artwork/tree/master/projects would be where to submit a PR into.

[dfarrell07]

Quick check in here, artwork?

Yeah, that's one of the last ones still fully TODO, not in review. Was just slowly poking at gimp trying to make it happen.

I guess there's not support for this editing? :sweat_smile: Looking at the project's PRs, it does seem like LF staff create a lot of them.

[caniszczyk]

@dfarrell07 yes we can do it if you point us to some form of graphics

[dfarrell07]

Thank you, that would be a huge help! This is the SVG I was basing everything on: https://submariner.io/images/logo-submariner.svg

And sampling a logo in gimp, I get the color code 2bdfc4 for our green and 3a4747 for the text color.

[skitt]

@dfarrell07 for SVG, Inkscape is a better tool than the Gimp ;-).

@amye, regarding the IP policy:

• (a) is tracked elsewhere;
• (b) / (c): we’ve been requiring DCOs for a long time, the bot is enabled, and all our code is licensed under the Apache Software License, version 2.0;
• (d) see above;
• (e) the licenses of our dependencies comply with the CNCF’s requirements, and this is enforced by license-checking jobs on all our projects producing outgoing binaries (see https://github.com/submariner-io/lighthouse/runs/2663488968?check_suite_focus=true for example; we still have https://github.com/submariner-io/submariner/pull/1326 pending to complete the license check jobs);
• (f) our docs are already licensed under the Creative Commons Attribution 4.0 International License;
• (g) no other licenses are required.

[dfarrell07]

I think we can now check off:

• [x] Ensure your project meets the CNCF IP Policy: https://github.com/cncf/foundation/blob/master/charter.md#11-ip-policy
  • Details in @skitt's comment above
• [x] Website: ensure LF footer is there and website guidelines followed
  • https://github.com/submariner-io/submariner-website/pull/516
  • https://github.com/submariner-io/submariner-website/pull/522
  • https://github.com/submariner-io/submariner-website/pull/523
• [x] Adopt a license scanning tool, like FOSSA or Snyk
  • https://github.com/submariner-io/submariner/pull/1326
  • https://github.com/submariner-io/submariner-operator/pull/1366
  • https://github.com/submariner-io/lighthouse/pull/537

Regarding adding @thelinuxfoundation as an Org owner, our invite had expired but we re-sent it today.

[skitt]

@amye can you confirm that there are the website guidelines? The link in the issue description points to the copyright guidelines.

[caniszczyk]

+1 these are website guidelines: https://github.com/cncf/foundation/blob/master/website-guidelines.md

On Tue, May 25, 2021 at 11:25 AM Stephen Kitt @.***> wrote:

@amye https://github.com/amye can you confirm that there are the website guidelines https://github.com/cncf/foundation/blob/master/website-guidelines.md? The link in the issue description points to the copyright guidelines.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/cncf/toc/issues/649#issuecomment-848022804, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAPSIJ5YR4KKEHHSGP6D2TTPPFOFANCNFSM43VLP52Q .

-- Cheers,

Chris Aniszczyk https://aniszczyk.org

[skitt]

The landscape PR is https://github.com/cncf/landscape/pull/2113

[skitt]

Thanks for the logos BTW! https://github.com/cncf/artwork/blob/master/examples/sandbox.md#submariner-logos :champagne:

[amye]

Marking off, we're so close!

[amye]

Hi all, Last few things! Domain: transfer domain to the CNCF - please send a transfer code to [email protected] Trademarks: transfer any trademark and logo mark assets over to the LF - https://github.com/cncf/foundation/tree/master/agreements has agreements GitHub: ensure 'thelinuxfoundation' and 'caniszczyk' are added as initial org owners, this helps us make sure we have continuity of GH ownership

[skitt]

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

I think this is done, see https://github.com/orgs/submariner-io/people, both users are listed as owners.

[Oats87]

Domain transfer is currently in progress, transfer code has been sent to @amye

Still working on trademark transfer