We plan to provide a series of stability guarantees, policies, and a stable governance via CNCF, for kube-rs going forward.
This is an umbrella issue tracking progress and major outstanding work before we mark ourselves as stable. It pertains to the Stability category on the roadmap.
Background
This is part of a set of stable client requirements plus extra requirements that we would like to provide on top so that users can feel safe choosing kube-rs as a reliable set of libraries to build upon kubernetes.
There's been a lot of introductory work in this area already as part of our in-progress CNCF setup (#584), along with stability work in #508 (which this issue replaces).
A lot of this is document pertains to process/policy writing that needs to be argued for/against, and then their subsequent implementations and enforcement of these proposed processes through continuous integration.
Tasks
Community & Governance
Policies & Clarity:
Security:
Continuous Integration:
We plan to provide a series of stability guarantees, policies, and a stable governance via CNCF, for kube-rs going forward.
This is an umbrella issue tracking progress and major outstanding work before we mark ourselves as stable. It pertains to the
Stabilitycategory on the roadmap.Background
This is part of a set of stable client requirements plus extra requirements that we would like to provide on top so that users can feel safe choosing
kube-rsas a reliable set of libraries to build upon kubernetes.There's been a lot of introductory work in this area already as part of our
in-progressCNCF setup (#584), along with stability work in #508 (which this issue replaces).A lot of this is document pertains to process/policy writing that needs to be argued for/against, and then their subsequent implementations and enforcement of these proposed processes through continuous integration.
Tasks
Community & Governance
Policies & Clarity:
#[deny(missing_docs)]at root of repos#[allow(missing_docs)]overrides - purge last missing_docs allows + fix docs errors #728doctest readme- doc = include_str! readme #736try_flatten_applied) - Policies for stability website#18Security:
cargo denymultiple-versions - cargo deny mutliple-fields ban #711cargo denyunknown git sources - deny.toml stricten unknown sources + bump tokio for rustsec issue #727cargo denystrict licenses and rustsec vulnerabilities - Add cargo-deny, clippy and rustfmt to CI - try #2 #611kubeas a super-crate facade - kube super-crate #651re-export generated structs from? - maybe post k8s-pbkube#[forbid(unsafe_code)]forcargo-geiger🔒 - deny(unsafe_code) -> forbid(unsafe_code) #734Continuous Integration:
extend e2e test matrix job to be able to run on both k3d and extra cluster- we would need one firstuse cloud clusters to point to in CI?(maybe sponsored or / cncf service / cncf community)