k8gb-io / k8gb

A cloud native Kubernetes Global Balancer
https://www.k8gb.io
Apache License 2.0
854 stars 92 forks source link

WIP: Incubation Application #1662

Open elohmrow opened 1 month ago

elohmrow commented 1 month ago

WIP


name: Project Incubation Application about: This template provides the project with a framework to inform the TOC of their conformance to the Incubation Level Criteria. title: "[Incubation] k8gb Incubation Application" labels: incubation

k8gb Incubation Application

v1.5 This template provides the project with a framework to inform the TOC of their conformance to the Incubation Level Criteria.

Project Repo(s): https://github.com/k8gb-io/k8gb Project Site: https://github.com/k8gb-io/k8gb Sub-Projects: None Communication: https://cloud-native.slack.com/archives/C021P656HGB

Project points of contacts: Yury Tsarev, yury@upbound.io

Incubation Criteria Summary for k8gb

Adoption Assertion

Application Process Principles

Suggested

N/A

Required

- [ ] **All project metadata and resources are [vendor-neutral](https://contribute.cncf.io/maintainers/community/vendor-neutrality/).** - See issues on #1641 tagged `(vendor-neutrality)` - Notes: - Project website: [k8gb.io](http://k8gb.io/) is self-hosted - GitHub Repo: https://github.com/k8gb-io/k8gb is self-hosted - Slack: [#k8gb](https://cloud-native.slack.com/archives/C021P656HGB) is CNCF-hosted - Mailing-list: [cncf-k8gb-maintainers@lists.cncf.io](mailto:cncf-k8gb-maintainers@lists.cncf.io) is CNCF-hosted - LinkedIn: https://www.linkedin.com/company/k8gb/ is self-hosted - Twitter / X: https://x.com/k8gb_io is self-hosted - [x] **Review and acknowledgement of expectations for [Sandbox](https://sandbox.cncf.io) projects and requirements for moving forward through the CNCF Maturity levels.** - [No sandbox application can be found](https://github.com/cncf/sandbox/issues), but, according to https://www.cncf.io/projects/k8gb/, k8gb was accepted to CNCF on March 30, 2021 at the Sandbox maturity level. Reference to Onboarding PR https://github.com/cncf/toc/issues/628 - [ ] **Due Diligence Review.** - TBD by TOC Sponsor Completion of this due diligence document, resolution of concerns raised, and presented for public comment satisfies the Due Diligence Review criteria. - [x] **Additional documentation as appropriate for project type, e.g.: installation documentation, end user documentation, reference implementation and/or code samples.** - Installation: - k8gb requires a single Gslb CRD to enable Global Load Balancing. - Quick Start: https://github.com/k8gb-io/k8gb?tab=readme-ov-file#quick-start - Other integrations: https://github.com/k8gb-io/k8gb?tab=readme-ov-file#installation-and-configuration-tutorials - End user documentation: - https://www.k8gb.io/ - https://www.k8gb.io/#installation-and-configuration-tutorials - Blog posts: ## Governance and Maintainers Note: this section may be augmented by the completion of a Governance Review from TAG Contributor Strategy. ### Suggested - [x] **Clear and discoverable project governance documentation.** - See https://github.com/k8gb-io/k8gb/blob/master/GOVERNANCE.md - [ ] **Governance has continuously been iterated upon by the project as a result of their experience applying it, with the governance history demonstrating evolution of maturity alongside the project's maturity evolution.** - [ ] **Governance is up to date with actual project activities, including any meetings, elections, leadership, or approval processes.** - [ ] **Governance clearly documents [vendor-neutrality](https://contribute.cncf.io/maintainers/community/vendor-neutrality/) of project direction.** - [ ] **Document how the project makes decisions on leadership, contribution acceptance, requests to the CNCF, and changes to governance or project goals.** - [ ] **Document how role, function-based members, or sub-teams are assigned, onboarded, and removed for specific teams (example: Security Response Committee).** - [ ] **Document a complete maintainer lifecycle process (including roles, onboarding, offboarding, and emeritus status).** - [ ] **Demonstrate usage of the maintainer lifecycle with outcomes, either through the addition or replacement of maintainers as project events have required.** - [x] **If the project has subprojects: subproject leadership, contribution, maturity status documented, including add/remove process.** - No subprojects ### Required - [x] **Document complete list of current maintainers, including names, contact information, domain of responsibility, and affiliation.** - See https://github.com/k8gb-io/k8gb/blob/master/GOVERNANCE.md#maintainers - [x] **A number of active maintainers which is appropriate to the size and scope of the project.** - 5 active maintainers from Upbound, openSUSE, Absa Group, and Kedify. - [x] **Code and Doc ownership in Github and elsewhere matches documented governance roles.** - [x] **Document agreement that project will adopt CNCF Code of Conduct.** - See https://github.com/k8gb-io/k8gb/blob/master/CODE_OF_CONDUCT.md - [x] **CNCF Code of Conduct is cross-linked from other governance documents.** - Linked from docs in this PR https://github.com/k8gb-io/k8gb/pull/1638/files - [x] **All subprojects, if any, are listed.** - No subprojects ## Contributors and Community Note: this section may be augmented by the completion of a Governance Review from TAG Contributor Strategy. ### Suggested - [ ] **Contributor ladder with multiple roles for contributors.** ### Required - [x] **Clearly defined and discoverable process to submit issues or changes.** - See https://github.com/k8gb-io/k8gb/blob/master/CONTRIBUTING.md - [x] **Project must have, and document, at least one public communications channel for users and/or contributors.** - See https://www.k8gb.io/ "[Join #k8gb on CNCF Slack](https://cloud-native.slack.com/archives/C021P656HGB)" - [x] **List and document all project communication channels, including subprojects (mail list/slack/etc.). List any non-public communications channels and what their special purpose is.** - Project website: [k8gb.io](http://k8gb.io/) - GitHub Repo: https://github.com/k8gb-io/k8gb - Slack: [#k8gb](https://cloud-native.slack.com/archives/C021P656HGB) - Mailing-list: [cncf-k8gb-maintainers@lists.cncf.io](mailto:cncf-k8gb-maintainers@lists.cncf.io) - LinkedIn: https://www.linkedin.com/company/k8gb/ - [ ] **Up-to-date public meeting schedulers and/or integration with CNCF calendar.** - [x] **Documentation of how to contribute, with increasing detail as the project matures.** - See https://github.com/k8gb-io/k8gb/blob/master/CONTRIBUTING.md - [ ] **Demonstrate contributor activity and recruitment.** ## Engineering Principles ### Suggested - [x] **Roadmap change process is documented.** - See https://github.com/orgs/k8gb-io/projects/2/views/2 - [x] **History of regular, quality releases.** - k8gb has had 31 releases: https://github.com/k8gb-io/k8gb/releases ### Required - [x] **Document project goals and objectives that illustrate the project’s differentiation in the Cloud Native landscape as well as outlines how this project fulfills an outstanding need and/or solves a problem differently.** - See https://www.k8gb.io/#key-differentiators - [x] **Document what the project does, and why it does it - including viable cloud native use cases.** - See https://www.k8gb.io/ and https://www.k8gb.io/#motivation-and-architecture - [x] **Document and maintain a public roadmap or other forward looking planning document or tracking mechanism.** - See https://github.com/orgs/k8gb-io/projects/2/views/2 - [x] **Document overview of project architecture and software design that demonstrates viable cloud native use cases, as part of the project's documentation.** - See the extended architecture documentation [here](https://www.k8gb.io/docs/) - Internal k8gb architecture and its components are described [here](https://www.k8gb.io/docs/components.html) - [x] **Document the project's release process.** - See https://github.com/k8gb-io/k8gb/blob/master/CONTRIBUTING.md#release-process ## Security Note: this section may be augmented by a joint-assessment performed by TAG Security. ### Suggested N/A ### Required - [ ] **Clearly defined and discoverable process to report security issues.** - [ ] **Enforcing Access Control Rules to secure the code base against attacks (Example: two factor authentication enforcement, and/or use of ACL tools.)** - [ ] **Document assignment of security response roles and how reports are handled.** - [x] **Document Security Self-Assessment.** - See https://github.com/k8gb-io/k8gb/blob/master/SECURITY.md and https://github.com/k8gb-io/k8gb/blob/master/SECURITY-INSIGHTS.yml - [ ] **Achieve the Open Source Security Foundation (OpenSSF) Best Practices passing badge.** ## Ecosystem ### Suggested N/A ### Required - [x] **Publicly documented list of adopters, which may indicate their adoption level (dev/trialing, prod, etc.)** - See https://github.com/k8gb-io/k8gb/blob/master/ADOPTERS.md - [x] **Used in appropriate capacity by at least 3 independent + indirect/direct adopters, (these are not required to be in the publicly documented list of adopters)** - See https://github.com/k8gb-io/k8gb/blob/master/ADOPTERS.md The project provided the TOC with a list of adopters for verification of use of the project at the level expected, i.e. production use for graduation, dev/test for incubation. - [ ] **TOC verification of adopters.** Refer to the Adoption portion of this document. - [ ] **Clearly documented integrations and/or compatibility with other CNCF projects as well as non-CNCF projects.** ## Additional Information
ytsarev commented 1 month ago

Can't find initial Sandbox PR/application. Leaving reference to Onboarding PR https://github.com/cncf/toc/issues/628 that might be potentially useful