Skip to content

Commit 6ba68c7

Browse files
shaneuttk8s-ci-robot
authored andcommitted
docs: cleanup and add links to SIG Network charter
There were a couple things that were inaccurate, a couple things out-of-date, and generally missing helpful links for newcomers to find their way around. Signed-off-by: Shane Utt <[email protected]>
1 parent 518149a commit 6ba68c7

File tree

1 file changed

+33
-13
lines changed

1 file changed

+33
-13
lines changed

sig-network/charter.md

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,29 +21,31 @@ The following topics fall under ownership of this SIG:
2121
- Cluster connectivity.
2222
- Cross-cutting concerns such as scalability.
2323
- Metrics and monitoring associated with networking components.
24+
- Multi-cluster networking (shared responsibility with [sig-multicluster]).
2425

2526
#### Code, Binaries and Services
2627

2728
- Services
28-
- APIs for defining and grouping networking endpoints.
29-
- APIs for defining L3/4 loadbalancing.
30-
- Reference implementation (kube-proxy).
29+
- APIs for defining and grouping network endpoints (i.e. [EndpointSlices], or the older [Endpoints] API)
30+
- APIs for defining L3/4 loadbalancing (i.e. [Service], [Gateway API])
31+
- Reference implementations (i.e. [kube-proxy]).
3132
- Ingress
32-
- APIs for defining L7 loadbalancing.
33-
- APIs for defining network policy.
33+
- APIs for defining ingress loadbalancing (i.e. [Ingress], [Gateway API])
34+
- Reference implementations (i.e. [ingress-nginx])
35+
- Network Policy
36+
- APIs for defining network policies (i.e. [NetworkPolicy], [AdminNetworkPolicy], [BaselineAdminNetworkPolicy])
37+
- Reference implementations (i.e. [kube-network-policies])
3438
- Cluster DNS.
35-
- Integration points with networking implementations (e.g. CNI integration).
36-
- Container runtime interface (CRI) (With [sig-node]).
39+
- Integration points with networking implementations (i.e. [Container Network Interface (CNI)][CNI]).
40+
- [Container Runtime Interface (CRI)][CRI] (With [sig-node]).
3741
- Cloud provider network integrations (With [sig-cloud-provider]).
3842

3943
#### Cross-cutting and Externally Facing Processes
4044

4145
### Out of scope
4246

43-
- The CNI specification itself, which is maintained outside the Kubernetes project
44-
- Particular implementations of the CNI specification
45-
- Particular implementations of the NetworkPolicy API
46-
- Particular implementations of the Ingress API
47+
- The [CNI] specification itself, which is maintained outside the Kubernetes project
48+
- Particular implementations of the [CNI] specification
4749

4850
## Roles and Organization Management
4951

@@ -66,9 +68,27 @@ and opts-in to updates and modifications to [sig-governance].
6668

6769
SIG Technical Leads
6870

71+
[Kubernetes Charter README]: https://github.com/kubernetes/community/blob/master/committee-steering/governance/README.md
72+
6973
[sig-cloud-provider]: https://github.com/kubernetes/community/tree/master/sig-cloud-provider
7074
[sig-node]: https://github.com/kubernetes/community/tree/master/sig-node
71-
7275
[sig-governance]: https://github.com/kubernetes/community/blob/master/committee-steering/governance/sig-governance.md
7376
[sig-subprojects]: https://github.com/kubernetes/community/blob/master/sig-network/README.md#subprojects
74-
[Kubernetes Charter README]: https://github.com/kubernetes/community/blob/master/committee-steering/governance/README.md
77+
[sig-multicluster]: https://github.com/kubernetes/community/blob/master/sig-multicluster/README.md
78+
79+
[EndpointSlices]: https://kubernetes.io/docs/concepts/services-networking/endpoint-slices/
80+
[Endpoints]: https://kubernetes.io/docs/concepts/services-networking/service/#endpoints
81+
[Service]: https://kubernetes.io/docs/concepts/services-networking/service/
82+
[kube-proxy]: https://kubernetes.io/docs/concepts/overview/components/#kube-proxy
83+
84+
[Ingress]: https://kubernetes.io/docs/concepts/services-networking/ingress/
85+
[Gateway API]: https://gateway-api.sigs.k8s.io/
86+
[ingress-nginx]: https://github.com/kubernetes/ingress-nginx/
87+
88+
[NetworkPolicy]: https://kubernetes.io/docs/concepts/services-networking/network-policies/
89+
[AdminNetworkPolicy]: https://network-policy-api.sigs.k8s.io/api-overview/#the-adminnetworkpolicy-resource
90+
[BaselineAdminNetworkPolicy]: https://network-policy-api.sigs.k8s.io/api-overview/#the-baselineadminnetworkpolicy-resource
91+
[kube-network-policies]: https://github.com/kubernetes-sigs/kube-network-policies
92+
93+
[CNI]: https://kubernetes.io/docs/concepts/cluster-administration/networking/#how-to-implement-the-kubernetes-network-model
94+
[CRI]: https://kubernetes.io/docs/concepts/architecture/cri/

0 commit comments

Comments
 (0)