cncf
[PROJECT ONBOARDING] Cozystack
Welcome to CNCF Project Onboarding
Sandbox Application reference issue: https://github.com/cncf/sandbox/issues/322
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. Other tasks can be done by projects in the meantime.
- [x] 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.
- [x] Review and understand the LF trademark guidelines. Let the TOC know if you plan to change your project name.
- [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
- [x] The Technical Leadership Principles that outlines the expected behavior for any maintainer in a leadership role.
- [x] The project proposal process and requirements.
- [x] The services available for your project at the CNCF.
- [x] The dependency license allowlist.
- [x] The online program guidelines.
- [x] The telemetry data collection and usage policy.
- [x] Optional: 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.
- [x] Join the #maintainers-circle Slack channel.
- [x] 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.
- [x] Transfer website analytics to [email protected]. CNCF staff can help.
Update and document project details
- [x] 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. - [x] 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. - [x] Create a maintainer list and add it to the aggregated CNCF maintainer list via pull request.
- [x] Provide emails for the maintainers to get access to the maintainers mailing list and Service Desk. Email them to [email protected].
- [ ] Start working on written, open governance and consider adding this to a
GOVERNANCE.mdfile at the root of your repo. - [x] 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.
- [x] 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 CNCF Project Onboarding
Sandbox Application reference issue: #322
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. Other tasks can be done by projects in the meantime.
- [x] 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.
- [x] Review and understand the LF trademark guidelines. Let the TOC know if you plan to change your project name.
- [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
- [x] The Technical Leadership Principles that outlines the expected behavior for any maintainer in a leadership role.
- [x] The project proposal process and requirements.
- [x] The services available for your project at the CNCF.
- [x] The dependency license allowlist.
- [x] The online program guidelines.
- [x] The telemetry data collection and usage policy.
- [x] Optional: 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.
- [x] Join the #maintainers-circle Slack channel.
- [x] 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.
- [x] Transfer website analytics to [email protected]. CNCF staff can help.
Update and document project details
- [x] 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. - [x] 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. - [x] Create a maintainer list and add it to the aggregated CNCF maintainer list via pull request.
- [x] 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. - [x] 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.
- [x] Add the project to the Cloud Native Landscape by updating landscape.yml following these instructions.
- [x] Add a license scanning tool, like FOSSA or Snyk.
- [x] Send a welcome email to confirm maintainer list access.
Welcome to the CNCF Sandbox!
We’re preparing your Contribution Agreement (CA) and will email it to the contacts on your Sandbox application soon. Here’s a preview of a generic CA, which sets up a legal entity for the project and assigns trademarks and logos to the Linux Foundation.
In the meantime, you can tackle some onboarding tasks that don’t depend on the CA, like reviewing documents, outlining any existing governance, and preparing your maintainer lists.
Cozystack Logos submitted to cncf/artwork repo PR: https://github.com/cncf/artwork/pull/542
The Landscape entry is updated - https://github.com/cncf/landscape/pull/4262
Just submitted pr for adding core maintainers to https://github.com/cncf/foundation/pull/974 And e-mail to [email protected].
Created a ticket for cozystack.io domain transfer https://jira.linuxfoundation.org/plugins/servlet/desk/portal/2/IT-27923
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.
Add thelinuxfoundation as an an organization owner, if it's not already one
Done already, pending invition:
Also:
- [x] DCO has been enabled
@mrbobbytables could you please replace subject for this issue CozyStack --> Cozystack
I see that people are using incorrect notation for the rest tasks in this issue
@tym83 the Contribution Agreement draft has just been sent by email to the folks listed on the Sandbox application for review. Please let us know if there are any changes (like contact info and additional trademarks) that should be included.
@tym83 the Contribution Agreement draft has just been sent by email to the folks listed on the Sandbox application for review. Please let us know if there are any changes (like contact info and additional trademarks) that should be included.
@kvaps left his comments in agreement draft.
- 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.
@krook we've just prepared a draft for project governance rules: https://github.com/cozystack/cozystack/pull/733. It seems all points were passed for now.
It seems all points were passed for now.
Fantastic, thank you. Yes, all tasks are done on your side. We just need to send the welcome email and set you up with FOSSA/Snyk (@RobertKielty)
I've sent out FOSSA invites to the registered maintainers, @tym83 if you would rather use Snyk let me know. After accepting the invitations I MUST add you to the Cozystack team on FOSSA then you can do a quick import to have your repos scanned.
I've sent out FOSSA invites to the registered maintainers, @tym83 if you would rather use Snyk let me know. After accepting the invitations I MUST add you to the Cozystack team on FOSSA then you can do a quick import to have your repos scanned.
Tnaks, @RobertKielty! Unfortunately I didn't see Cozystack in FOSSA panel and I cannot add it myself. Maybe I did something wrong
@tym83 No you're good, I just need to add you to the team as Team Admin.
You're a Team Admin now @tym83 on https://app.fossa.com/account/settings/organization/teams/83877
Check out the https://docs.fossa.com/docs/quick-import#get-started page, you can do a Quick Import following the instructions on that page. I reccomend that you always start from the Team Page (URL above) and click on Add Projects.
@RobertKielty thanks! It works perfect now
upd: I cannot invite my teammembers to FOSSA. Is it ok?
@tym83 I can see that all 9 Cozystack repos are imported as projects into you new team FOSSA, thank you for doing that. I can mark this task as complete.
I sent out invites to @kvaps @gecube. It looks like they expired, do you want me to re-send the invtes to them?
@tym83 I can see that all 9 Cozystack repos are imported as projects into you new team FOSSA, thank you for doing that. I can mark this task as complete.
I sent out invites to @kvaps @gecube. It looks like they expired, do you want me to re-send the invtes to them?
Yes, it would be helpful. And if you could add two other maintainers who mostly work with such issues classification etc it would be great too.
@tym83 I can see that all 9 Cozystack repos are imported as projects into you new team FOSSA, thank you for doing that. I can mark this task as complete. I sent out invites to @kvaps @gecube. It looks like they expired, do you want me to re-send the invtes to them?
Yes, it would be helpful. And if you could add two other maintainers who mostly work with such issues classification etc it would be great too.
@tym83, I'm good to add other contributors to the FOSSA Team. On cloud-native Slack, DM me their email addresses. (Don't share thier email addrs here)
Note also that FOSSA has multiple team roles
https://docs.fossa.com/docs/role-based-access-control#team-roles
I make regsistered maintainer's like you @gecube and @kvaps, Team Admins.
For non-maintainers you have the option to choose from Team Viewer or Team Editor.
EDIT: I've noticed that the public maintainer list now has more maintainers there than we do with our internal records.
If you haven't already done so already can you please send in the email addresses to [email protected] and we will record that internally. cc @krook
Yes, please resend.
Done. Either I or @tym83 MUST add you to the team after you have accepted. Then you can work on viewing the reported license issues in the repos that @tym83 imported.