kubernetes / community

Kubernetes community content
Apache License 2.0
12.03k stars 5.17k forks source link

SIG Network: add best practices guide for API extensions #8104

Open shaneutt opened 1 month ago

shaneutt commented 1 month ago

This PR is a follow up to a mailing list discussion about the trend of new APIs being developed as CRDs in upstream.

This adds a guide to our community pages which provides help, insights and best practices for future CRD-based API developments based on the experiences of those who have done it previously (like Network Policy and Gateway API). The intention is to help make developing these CRD-based APIs easier for developers, but (most importantly) making the experience for end-users easier, and more consistent.

Note: this is in draft as there are several sections not yet filled out. It's not ready for general review yet. If you're interested helping with this doc, please feel to message me on Slack, or put a PR into my fork it would be great to collaborate with others on it!

k8s-ci-robot commented 1 month ago

Skipping CI for Draft Pull Request. If you want CI signal for your change, please convert it to an actual PR. You can still manually trigger a test run with /test all

k8s-ci-robot commented 1 month ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: shaneutt

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[sig-network/OWNERS](https://github.com/kubernetes/community/blob/master/sig-network/OWNERS)~~ [shaneutt] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
aojea commented 4 weeks ago

/hold

after more closely reviewed on this topic it is clear that there are still a lot of details to flesh out on gateway design of CRD

We should work closely with API machinery on this topic