toc
toc copied to clipboard
cncf
[SANDBOX PROJECT ONBOARDING] Logging Operator
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.md#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] Is your project working on written, open governance? see https://contribute.cncf.io/maintainers/governance/
- [x] 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] Artwork: Submit a pull request to https://github.com/cncf/artwork with your artwork
- [ ] 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 - [email protected] is the best email to send those to
- [ ] 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 that we will onboard to our GitHub Enterprise instance: https://github.com/enterprises/cncf
- [x] GitHub: ensure DCO or CLA are enabled for all GitHub repositories of the project
- [x] GitHub: ensure that that the CNCF Code of Conduct (or your adopted version of it) are explicitly referenced at the project's README on GitHub
- [x] Website: ensure LF footer is there and website guidelines followed (if your project doesn't have a dedicated website, please adopt those guidelines to the README file of your project on GitHub).
- [x] Website: Analytics transferred to [email protected]
- [x] OpenSSF Best Practices Badge: Start on an OpenSSF 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
- [ ] Book time with the team with http://project-meetings.cncf.io
- [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
Also added to All CNCF (example of commits dashboards with 5 new Sandbox projects selected) DevStats instance, here are Project Health(s) dashboards: link 1, link 2.
Progress report from the project side:
- Proposal process read and understood ✅
- Services available read and understood ✅
- IP policy read and understood ✅
- Online programs read and understood ✅
- Trademark usage read and understood ✅
- License allowlist read and understood (project is under Apache 2.0) ✅
- Project is in its own organization (@kube-logging) ✅
- 'thelinuxfoundation' and 'caniszczyk' are added as owners ✅
- DCO is enabled ✅
- No analytics on the website at the moment ✅
❓ Questions:
- The documentation is licensed under Apache 2.0 at the moment. Do we need to change it to CCA 4.0?
- Who do we coordinate with for the Slack import?
- The project is currently maintained by two companies, each holding accounts/logos. Do both of them have to fill the trademark agreement (there are no registered trademarks)?
We've created an onboarding project under the GitHub organization to track the remaining items: https://github.com/orgs/kube-logging/projects/5/views/1
(1) Who do we coordinate with for the Slack import? - servicedesk.cncf.io is a great place to start for that! We'll be able to get more team members to coordinate in there. (2) Typically, we have the contributing company sign this over. You've listed "https://opensource.cisco.com/" on your sandbox application.
Hi @sagikazarmark ! I went ahead and updated the checklist with the completed tasks! Did you have any other questions you needed help with?
Progress report:
- ✅ PR sent to maintainers list: https://github.com/cncf/foundation/pull/684
- ✅ Email sent to
[email protected]for ServiceDesk access - ✅ OpenSSF Best Practices in progress
- ✅ Code of Conduct linked from the README: https://github.com/kube-logging/logging-operator#contributing
- 🔄 I'm talking to Cisco Legal about signing the trademark agreement
- 🔄 Artwork and landscape PR are in progress
- 🔄 Waiting for ServiceDesk access for the rest
Progress report:
- ✅ Artwork PR submitted (and merged)
- ✅ Website footer updated
- 🔄 Landscape PR submitted (https://github.com/cncf/landscape/pull/3684) (see question below)
- 🔄 I'm still talking to Cisco Legal about signing the trademark agreement
- 🔄 Working on governance docs
❓ Questions:
There seems to be some ambiguity around the name of the project. The organization is called "Kube Logging", the lead project is called "Logging Operator" (we have other projects as well).
We submitted the artwork PR as "Kube Logging" (because that's what the logo says), but most other references use the name "Logging Operator". Can we get some guidance on how we should refer to the project (particularly in places like the landscape).
I've sent an email to [email protected] a while ago asking for mailing list and Service Desk access (as per the above checklist). I also sent a followup email recently, but never received any reply to any of the emails.
Is there a better channel to reach out and get access to those resources?
Some of the other items (Snyk license scan, domain transfer, Slack channel) are blocked by that.
I don't think CLO monitor has been set up for the project (or at least I haven't seen it). I left its field in the landscape as TODO. Where can we ask for CLO monitor setup?
What are the next steps of the onboarding? We've completed a fair amount of items on the list above and we were wondering what comes next.
Thanks in advance!
There seems to be some ambiguity around the name of the project. The organization is called "Kube Logging", the lead project is called "Logging Operator" (we have other projects as well).
We submitted the artwork PR as "Kube Logging" (because that's what the logo says), but most other references use the name "Logging Operator". Can we get some guidance on how we should refer to the project (particularly in places like the landscape).
This is directly related to the name that was used to apply: https://github.com/cncf/sandbox/issues/42
@sagikazarmark ! I have updated the list and it should be current as of today! The next big thing Logging Operator needs to tackle is trademark transfer
@Cmierly thank you!
I believe the mailing list and Service Desk has also been sorted out.
I received word from the Cisco legal department yesterday that they have started reviewing the agreement.
Also, we decided not to migrate the existing Slack channel. We created new ones on the CNCF Slack: #logging-operator and #logging-operator-dev
@Cmierly a few additional checkbox done:
- Written governance -> https://github.com/kube-logging/.github/blob/main/GOVERNANCE.md
- Snyk had been requested over the CNCF service desk and is now enabled and used to check vulnerabilities as well as open source licenses periodically and on each PR
@Cmierly We've (maintainers) also read the project services and would like to book a meeting with the project team soon
@nate-double-u I don't have access to that Service Desk portal. Can you get me added there?
@nate-double-u I don't have access to that Service Desk portal. Can you get me added there?
I think that'll be @Cmierly (I don't think I have permissions to add folks).