sandbox
sandbox copied to clipboard
cncf
[PROJECT ONBOARDING] Spin & SpinKube
Welcome to CNCF Project Onboarding
Sandbox Reference Issue: https://github.com/cncf/sandbox/issues/116 | https://github.com/cncf/sandbox/issues/90
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.
REQUIRED BEFORE PROCEEDING WITH ONBOARDING
A "Project Contribution Agreement" must be completed and any existing trademarks MUST be transferred to the Linux Foundation BEFORE CNCF staff onboarding tasks can be completed.
- [ ] Review and understand the CNCF IP Policy. Ensure you are using a CNCF compatible license; inbound projects must use the Apache 2.0 license or seek approval for exceptions. Licenses for dependencies are covered separately below.
- [ ] Review and understand the LF trademark guidelines.
- [x] Transfer any trademark and logo assets to the Linux Foundation via the Contribution Agreement. CNCF staff will send this document to the contact emails listed in the Sandbox application.
Review and understand other documents
- [ ] 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 dependency license allowlist.
- [ ] The online program guidelines.
- [ ] The telemetry data collection and usage policy.
- [ ] Book time with CNCF staff to understand project benefits and event resources.
Contribute and transfer other materials
- [x] 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.
- [x] Accept the invite to join the CNCF GitHub Enterprise account. We'll then add
thelinuxfoundationas an organization owner to ensure neutral hosting of your project. - [x] Migrate your Slack channels (if any) to the Kubernetes or CNCF Slack workspace. CNCF staff can help.
- [ ] Join the #maintainers-circle Slack channel.
- [ ] Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected]. The "Project" is CNCF.
- [x] Submit a pull request with your artwork.
- [ ] Transfer website analytics to [email protected]. CNCF staff can help.
Update and document project details
- [ ] Ensure that DCO (preferred) or CLA are enabled for all GitHub repositories of the project.
- [x] Ensure that that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's
README.mdon GitHub. - [ ] 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.mdfile). The project-specific footer text you should use will be provided in the Contribution Agreement instructions. - [ ] Create a maintainer list and add it to the aggregated CNCF maintainer list via pull request.
- [ ] Provide emails for the maintainers to get access to the maintainers mailing list and Service Desk. Email them to [email protected].
- [x] Start working on written, open governance and consider adding this to a
GOVERNANCE.mdfile at the root of your repo. - [ ] Start on an OpenSSF Best Practices Badge.
CNCF staff tasks to support the project
- [x] Add the project to DevStats.
- [x] Add the project to CLOmonitor.
- [x] Add the project to LFX Insights. This is done by adding a read-only app to your GitHub organization once it's in CNCF GHE.
- [x] Add the project to LFX Project Control Center.
- [ ] Add the project to the Cloud Native Landscape by updating landscape.yml following these instructions.
- [ ] Add a license scanning tool, like FOSSA or Snyk.
- [ ] Send a welcome email to confirm maintainer list access.
Welcome to the CNCF Sandbox Spin and SpinKube team!
CNCF staff is working on the first step, which is to create and share the Contribution Agreement with you shortly.
I'll send an email to the contacts listed on the Sandbox application. The Contribution Agreement can be signed by the contributing organization listed there, or a group of individuals.
Is this 1 or 2 projects? I mean should I add a single DevStats instance for this or two separate ones?
@lukaszgryglicki it will be a single project consolidating on a single GitHub organization.
Welcome again to the CNCF Sandbox! We're creating the Contribution Agreement document for you now and should have it to you shortly.
In the meantime, there are a few generic tasks in this checklist that you can work on that don't have a hard dependency on the CA, such as reviewing documents, documenting any governance you may already have, and preparing your maintainer lists to share.
The Contribution Agreement has just been sent by email to the folks listed on the Sandbox application.
@krook a couple of logistical questions here, as we work through the tasks. Our web properties are undergoing some changes ASAP to align with CNCF governance, namely separating Spin out from any of the web and documentation structure than ties into other projects and services.
Web assets hosting (Wasm edition)
- Transfer your domain to the CNCF. The "LF Stakeholder email" is [email protected]. The "Project" is CNCF.
Aside from domain ownership, are we reuired to transfer/move the site hosting?
We run Spin as a WebAssembly tool that runs on WebAssembly tools (i.e. Spin web assets are a Spin app). The docs are written in Markdown and generated into a website with Bartholomew, an open source tool that Fermyon released in 2022 (Apache 2.0). Bartholomew renders the website into a Spin app, which is then deployed to Fermyon Cloud.
This differs from the Markdown > Hugo site > Netlify approach I've seen on other projects, but the overall model is very similar - Markdown > Bartholomew site > Fermyon Cloud (free). We want to assess if we can keep things running this way.
Web analytics
- Transfer website analytics to [email protected]. CNCF staff can help.
In the past on CNCF projects, we've used Google Analytics and transferred that. Broadly this practice has shifted towards cookie-less tools in recent years for more accurate (it's common for cookie blockers to remove about 1/3 of traffic from analytics). We've been using Plausible.io for our analytics for Spin and Spinkube, for which we pay for an account - does the CNCF use this (or similar) tooling?
@krook I will follow up on that contribution agreement this week. Thank you.
Just so everyone is on the same page: We're tracking progress for onboarding on this project board. The agreements are currently being reviewed. Repos are transferred over to the new github org: spinframework and there are multiple folks involved in getting all the right bits into place but it may take some time.
Update: We've reviewed the contribution agreement and are now just waiting on a Docusign link!
Just so everyone is on the same page: We're tracking progress for onboarding on this project board. The agreements are currently being reviewed. Repos are transferred over to the new github org:
spinframeworkand there are multiple folks involved in getting all the right bits into place but it may take some time.
Thanks @michelleN! I'll sync the checklist here with the updates as they happen in your project board.
We're a bit blocked on releases at the moment since we don't have access to larger runners in the new spinframework github org. My understanding is we would get access to those once the spinframework github org is added to the CNCF GitHub Enterprise account. Is that correct @krook ?
We're a bit blocked on releases at the moment since we don't have access to larger runners in the new
spinframeworkgithub org. My understanding is we would get access to those once thespinframeworkgithub org is added to the CNCF GitHub Enterprise account. Is that correct @krook ?
What size are the runners @michelleN? FYI: @jeefy @idvoretskyi @RobertKielty
The test suites previously had access to 4-core Ubuntu and 8-core Windows Server.
We're still blocked on github runners @krook @jeefy @idvoretskyi @RobertKielty. If someone could help us out with that, would really appreciate it! For more context, we also don't have an invite to the CNCF GitHub Enterprise account yet. Thank you.
Now that your project is in the CNCF GitHub Enterprise account we're going to do these two tasks on our side:
- Add
thelinuxfoundationas an an organization owner, if it's not already one. - Use that id to install the "LFX CM" GitHub app which will feed read-only, public activity to LFX Insights.
Create a maintainer list and add it to the aggregated CNCF maintainer list via pull request.
https://github.com/cncf/foundation/pull/979
Provide emails for the maintainers to get access to the maintainers mailing list and Service Desk. Email them to [email protected].
I've sent the email first to [email protected] as instructed in 979 above and then forwarded to [email protected]. Origin email is the current Spinframework maintainer email of [email protected]. Thanks!
Web analytics
- Transfer website analytics to [email protected]. CNCF staff can help.
In the past on CNCF projects, we've used Google Analytics and transferred that. Broadly this practice has shifted towards cookie-less tools in recent years for more accurate (it's common for cookie blockers to remove about 1/3 of traffic from analytics). We've been using Plausible.io for our analytics for Spin and Spinkube, for which we pay for an account - does the CNCF use this (or similar) tooling?
@flynnduism good question. The CNCF itself uses plausible for cncf.io for similar reasons. @nate-double-u @chalin do you have thoughts here?
While we did experiment with the use of Plausible for cncf.io, we are no longer using it.
That being said, I see that:
-
spinkube.dev is using Plausible, but
-
developer.fermyon.com/spin still seems to have (at least) Google Analytics (GA) under the hood, as we can see here:
In that case, open a Service Desk ticket for the GA transfer, and we'll discuss options there. We might as well use the same ticket to discuss what to do with Plausible.
- Add
thelinuxfoundationas an an organization owner, if it's not already one.- Use that id to install the "LFX CM" GitHub app which will feed read-only, public activity to LFX Insights.
This has now been done by CNCF staff.
@flynnduism - please reissue a Plausible invite (I was OOO and could not process the invites in time). Just to be clear, which websites are we referring to for this analytics transfer, both spinkube.dev and spinframework.dev?
@cynthia-sg wrote:
@cynthia-sg - could you add spinkube.dev as the website for https://clomonitor.io/projects/cncf/spinkube? /cc @flynnduism
@flynnduism - please reissue a Plausible invite (I was OOO and could not process the invites in time). Just to be clear, which websites are we referring to for this analytics transfer, both spinkube.dev and spinframework.dev?
Invites for both Plausible properties have been re-sent!
@flynnduism - I confirm that we have Guest Editor access to the two websites:
/cc @krook
Hi @flynnduism can you let me know if the project team have a preference to use FOSSA or Snyk to for license scanning?
