Skip to content

Commit 268dff4

Browse files
kgubembuechse
andauthored
Apply suggestions from code review
Co-authored-by: Matthias Büchse <[email protected]> Signed-off-by: kgube <[email protected]>
1 parent 2e1f07d commit 268dff4

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

Standards/scs-0219-v1-kaas-networking.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ track: KaaS
77

88
## Introduction
99

10-
Kubernetes defines a networking model that needs to be implented by a separate CNI plugin.
10+
Kubernetes defines a networking model that needs to be implemented by a separate CNI plugin.
1111
Beyond basic connectivity within the cluster, however, there are many networking features that are specified but optional.
1212
Some of these optional features provide vital functionality, such as the NetworkPolicy API and the Ingress API.
1313

14-
This standard specifies a minimal set of networking features that users can expect in clusters created by an SCS complient KaaS provider.
14+
This standard specifies a minimal set of networking features that users can expect in clusters created by an SCS-compliant KaaS provider.
1515

1616
## Terminology
1717

@@ -28,17 +28,17 @@ The following terms are used throughout this document:
2828
## Motivation
2929

3030
KaaS providers will typically support aditional networking functionality beyond basic Kubernetes networking.
31-
The specific range features depends on the used CNI plugin, but may also be extended by additional operators.
31+
The specific range of features depends on the used CNI plugin, but may also be extended by additional operators.
3232
Users may expect certain optional functionality, so we should define a baseline feature set that has to be available in an SCS-compliant KaaS cluster.
3333

3434
## Design Considerations
3535

36-
The Kubernetes API is arbitrary extensible.
36+
The Kubernetes API can be extended arbitrarily.
3737
Many CNI plugins will define custom resources to enable functionality that is not covered in the official [API specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/).
3838
Sometimes they will even reuse names from different API groups, such as `NetworkPolicy`, which exists in the basic `networking.k8s.io/v1` API, but also in `projectcalico.org/v3`.
3939

4040
To avoid any ambiguity, we should therefore be explicit about the API groups and versions of resources.
41-
We should also avoid mandating third party API extensions, to avoid dependencies on specific third party software and keep the standard as generic as possible.
41+
We should also avoid mandating third-party API extensions, to avoid dependencies on specific third-party software and keep the standard as generic as possible.
4242

4343
### Options considered
4444

@@ -49,7 +49,7 @@ The policy rules can filter based on port and address ranges, but also on Kubern
4949
They must be implemented by the CNI plugin, and though they are widely supported, they are still technically optional, and there are some lightweight networking plugins, such as Flannel, that are not enforcing them.
5050

5151
Nonetheless, network policies are widely used and most users will expect them in a managed Kubernetes cluster.
52-
The wide support among CNI plugins makes them a good target for SCS standardization.
52+
The wide, but varying support among CNI plugins makes them a good target for SCS standardization.
5353

5454
#### Default Network Policies in Namespaces
5555

@@ -67,7 +67,7 @@ CSP-provided network policies should thus only be viewed as a safety default, an
6767
An alternative to automatically created default network policies are API extensions that allow cluster-wide networking rules.
6868
Some CNI plugins have implemented such extensions, e.g. Calico's `GlobalNetworkPolicy` and Cilium's `CiliumClusterwideNetworkPolicy`.
6969

70-
The Kubernetes Network Policy Special Interest Group is currently working on an [official API extension](https://network-policy-api.sigs.k8s.io/api-overview/) to cover this functionality.
70+
The Kubernetes Network Special Interest Group is currently working on an [official API extension](https://network-policy-api.sigs.k8s.io/api-overview/) to cover this functionality.
7171
This API extension introduces the new `AdminNetworkPolicy` and `BaselineAdminNetworkPolicy` resources, which represent cluster-wide network policies with respectively higher or lower precedence than namespaced network policies.
7272

7373
This API is also a good candidate for standardization because it consolidates a number of vendor-specific workarounds to limitations of the NetworkPolicy API.

Standards/scs-0219-w1-kaas-networking.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ supplements:
88
---
99
## List of compliant CNI Plugins
1010

11-
The Kubernetes Network Policy SIG maintains a [list of work-in-progress implementations](https://network-policy-api.sigs.k8s.io/implementations/) of the AdminNetworkPolicy and BaselineAdminNetworkPolicy resources.
12-
Besides their own validation implementation of [kube-network-policies](https://github.com/kubernetes-sigs/kube-network-policies), at the time of writing they list the following CNI plugins:
11+
The Kubernetes Network Policy API working group maintains a [list of work-in-progress implementations](https://network-policy-api.sigs.k8s.io/implementations/) of the AdminNetworkPolicy and BaselineAdminNetworkPolicy resources.
12+
Besides their own proof-of-concept implementation of [kube-network-policies](https://github.com/kubernetes-sigs/kube-network-policies), at the time of writing they list the following CNI plugins:
1313

1414
- [OVN-Kubernetes](https://github.com/ovn-org/ovn-kubernetes/)
1515
- [Antrea](https://github.com/antrea-io/antrea/)

0 commit comments

Comments
 (0)