CNCF Sandbox Onboarding

[dfarrell07]

Submariner's CNCF Sandbox application was accepted by the CNCF TOC! 🥳 We now need to complete the Sandbox onboarding process.

We need to show our results on the TOC's Issue (cncf/sandbox#244). I've copied the chunks that need action from us, so we can add details and collectively edit to check boxes/add lines.

Read:

Should all the Project Owners + me (CNCF driver) review these and ACK?

• Understand the project proposal process and reqs: https://github.com/cncf/toc/blob/main/process/project_proposals.adoc#introduction
  • @dfarrell07
  • @skitt
  • @tpantelis
  • @mangelajo
  • Resulting requirement: "List their sandbox status prominently on website/readme" in the Sandbox criteria
    • Document that Submariner is a CNCF sandbox project #1349
    • Document that Submariner is a CNCF sandbox project submariner-website#517
• Understand the services available for your project at CNCF https://www.cncf.io/services-for-projects/
  • @dfarrell07
  • @skitt
  • @tpantelis
  • @mangelajo
• Review the online programs guidelines: https://github.com/cncf/foundation/blob/master/online-programs-guidelines.md
  • @dfarrell07
  • @skitt
  • @tpantelis
  • @mangelajo
• Understand the trademark guidelines: https://www.linuxfoundation.org/en/trademark-usage/
  • @dfarrell07
  • @skitt
  • @tpantelis
  • @mangelajo

Do:

• Has your project adopted open governance already? see http://opengovernance.dev
  • We have https://submariner.io/community/contributor-roles/ (based on K8s governance), but we should add GOVERNCE.md files and maybe adopt other good practices from the examples provided in the TOC's PR.
  • Add GOVERNANCE.md, answer open gov checklist Add GOVERNANCE.md, answer open gov checklist #1327
  • Document participants in security disclosures Document participates in security disclosures submariner-website#518
  • Add Project Owner responsibilities Add Project Owner responsibilities submariner-website#520
  • Update Owner removal docs in governance summary Update Owner removal docs in governance summary #1391
• CII: Start on a CII best practices badge https://bestpractices.coreinfrastructure.org/en
  • Achieve CII Passing status Achieve CII Passing status #798
    • https://bestpractices.coreinfrastructure.org/en/projects/4865
  • Document test policy for CII Best Practices Document test policy for CII Best Practices submariner-website#515
    issues
  • Add CII badges
    • Add CII badge, remove PR-triggered badges #1343
    • Add CII badge, remove PR-triggered badges submariner-operator#1370
    • Add CII badge, remove PR-triggered badges admiral#221
    • Add CII badge, remove PR-triggered badges enhancements#31
    • Add CII badge, remove PR-triggered badges lighthouse#538
    • Add CII badge, remove PR-triggered badges releases#140
    • Refactor badges in README shipyard#559
    • Add CII and merged-CI badges to README submariner-charts#142
    • Add CII badge, remove PR-triggered badges cloud-prepare#44
  • Add pull request template
    • Add pull request template #1342
    • Add pull request template submariner-operator#1372
    • Add pull request template submariner-charts#143
    • Add pull request template shipyard#561
    • Add pull request template releases#142
    • Add pull request template lighthouse#541
    • Add pull request template coastguard#28
    • Add pull request template admiral#223
    • Add pull request template cloud-prepare#45
• Domain: transfer domain to the CNCF - please send a transfer code to amye@linuxfoundation.org
  • @Oats87 is working on getting transfer code sent to @amye.
• Trademarks: transfer any trademark and logo mark assets over to the LF - https://github.com/cncf/foundation/tree/master/agreements has agreements
  • @Oats87 is working on the trademark transfer agreement.
• GitHub: ensure 'thelinuxfoundation' and 'caniszczyk' are added as initial org owners, this helps us make sure we have continuity of GH ownership
  • Now that we’ve switched to a paid plan, this requires buying more user capacity
  • Org Owners
  • caniszczyk
  • thelinuxfoundation
• Artwork: Ensure logos present on https://github.com/cncf/artwork
  • Create 18 SubM logos versions for cncf/artwork Create 18 SubM logos versions for cncf/artwork #1311
  • Contini add submariner cncf/artwork#250
  • Add stacked Submariner logos cncf/artwork#251
• Website: ensure LF footer is there and website guidelines (corrected link from OP) followed
  • If there is a copyright notice at the bottom of the page, copyright should be to the project authors or to CNCF, not the origin company. For details, see Copyright notices.
    • Add copyright notice to footer Add copyright notice to footer submariner-website#516
  • "CNCF requests that graduated and incubating projects include the sentence “We are a Cloud Native Computing Foundation project.” and the CNCF logo near the bottom of their project homepage. Sandbox-level projects should include the sentence “We are a Cloud Native Computing Foundation sandbox project.” and the CNCF logo. We also appreciate a link to KubeCon + CloudNativeCon as the events approach."
    • Document that Submariner is a CNCF sandbox project submariner-website#517
    • Add CNCF logo and Sandbox statement to menu footer submariner-website#523
  • "Website footers must include trademark guidelines by either linking to Trademark Usage (directly or via a "Terms of service" page), or by including the following text: "The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see Trademark Usage"."
    • Add Linux Foundation trademark guidelines submariner-website#522
• Code copyright notices (not listed in requirements but should be?)
  • Change Copyright Notices to CNCF-recommended format Change Copyright Notices to CNCF-recommended format #1322
  • Update the copyright statements to match CNCF recs
    • Update the copyright statements to match CNCF recs #1335
    • Update the copyright statements to match CNCF recs submariner-operator#1373
    • Update the copyright statements to match CNCF recs lighthouse#539
    • Update the copyright statements to match CNCF recs admiral#224
    • Update the copyright statements to match CNCF recs cloud-prepare#46
    • Update the copyright statements to match CNCF recs shipyard#558
• Website: Analytics transferred to amye@linuxfoundation.org
  • I don't think we have any sort of analytics.
• Adopt a license scanning tool, like FOSSA or Snyk
  • Add dependency license scanning linting Add dependency license scanning linting #801
  • Add a license-checking job
    • Add a license-checking job #1326
    • Add a license-checking job submariner-operator#1366
    • Add a license-checking job lighthouse#537
  • Don't use go-ipify
• Submitted a Pull request to add your project as a sandbox project to https://landscape.cncf.io
  • This should likely be one of the last steps.
  • Cloud Native Networking section https://landscape.cncf.io/card-mode?category=cloud-native-network&grouping=category
  • Tentative commit: skitt/landscape@f13480a
  • Add Submariner to Cloud Native Network cncf/landscape#2113

Not-required extras we've assigned ourselves:

• WIP: Security scanning
  • Will use to https://github.com/sonatype-nexus-community/nancy to provide in-CI and local security scanning
  • Also plan to track our real dependencies, and whenever a PR adds any, check that they don’t bring in their own security

[dfarrell07]

/me wonders if this should be an epic 🤔 It tracks many things like an epic, but it's due in less than one sprint.

[amye]

Yesss! It is kindof an epic but it'll go quick.

[dfarrell07]

@Oats87 Any update or timeline on the trademark agreement and domain transfer? Would also appreciate your review on submariner-io/submariner-website#520. I think it's the last pending task for the open governance checkmark.

[dfarrell07]

I think we're basically done, as I understand it we only need:

• @thelinuxfoundation to accept our invite to be an Org Owner.
• @Oats87 to submit trademark docs.
• @Oats87 to send domain transfer.
• @Oats87 to review Add Project Owner responsibilities submariner-website#520.

[Oats87]

@dfarrell07 I am currently in discussion with SUSE Legal over transfer of the trademark agreement. Unfortunately things aren't as "simple" as they used to be when we were independently Rancher.

Regarding the domain transfer, I am navigating the department within SUSE that is responsible for that as well.

[skitt]

Stacked logos added: cncf/artwork#251 (this is what I used for the landscape PR).

[stale]

This issue has been automatically marked as stale because it has not had activity for 60 days. It will be closed if no further activity occurs. Please make a comment if this issue/pr is still valid. Thank you for your contributions.

[dfarrell07]

To update here, we're still waiting on SUSE to send the trademark transfer docs to the CNCF. I've been periodically pinging @Oats87 to check in, and he's been pinging SUSE Legal in turn. They are aware of the issue and seem to want to make progress, but clearly are not making good progress.

[stale]

This issue has been automatically marked as stale because it has not had activity for 60 days. It will be closed if no further activity occurs. Please make a comment if this issue/pr is still valid. Thank you for your contributions.

[amye]

Dropping a note here to cause activity and keep this open. ✨

[dfarrell07]

We're still periodically pinging Suse's legal team to check on this, they tell us it's still work-in-progress.

[amye]

Same thing out here :)

[skitt]

The trademarks were transferred.