Skip to content

Commit bf6f6c2

Browse files
committed
Review updates
Signed-off-by: Andrew Stoycos <[email protected]>
1 parent 0a5b4c2 commit bf6f6c2

File tree

5 files changed

+7
-7
lines changed

5 files changed

+7
-7
lines changed

RELEASE.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
The Network Policy API project is has the following two main release components:
66
- Kubernetes Custom Resource Definitions (CRDs)
7-
- Corresponding Go API in the form of `sigs.k8s.io/network-policy-api` Go package
7+
- Corresponding Go bindings for the API (`sigs.k8s.io/network-policy-api` Go package)
88

99
This repository is the home for both of the above components.
1010

@@ -14,6 +14,8 @@ documentation].
1414

1515
[the release documentation]: site-src/versioning.md
1616

17+
Adapted with :blue_heart: from the [gateway api project release documentation](https://gateway-api.sigs.k8s.io/)
18+
1719
## Releasing a new version
1820

1921
### Writing a Changelog

apis/v1alpha1/adminnetworkpolicy_types.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ import (
3131
// +kubebuilder:printcolumn:name="Priority",type=string,JSONPath=".spec.priority"
3232
// +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
3333
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
34-
// +kubebuilder:metadata:annotations="api-approved.kubernetes.io=https://github.com/kubernetes/enhancements/pull/2522"
3534
// AdminNetworkPolicy is a cluster level resource that is part of the
3635
// AdminNetworkPolicy API.
3736
type AdminNetworkPolicy struct {

apis/v1alpha1/baselineadminnetworkpolicy_types.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ import (
2626
// +kubebuilder:resource:shortName=banp,scope=Cluster
2727
// +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
2828
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
29-
// +kubebuilder:metadata:annotations="api-approved.kubernetes.io=https://github.com/kubernetes/enhancements/pull/2522"
3029
// +kubebuilder:validation:XValidation:rule="self.metadata.name == 'default'",message="Only one baseline admin network policy with metadata.name=\"default\" can be created in the cluster"
3130
// BaselineAdminNetworkPolicy is a cluster level resource that is part of the
3231
// AdminNetworkPolicy API.

site-src/api-overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Api Object Overview
22

3-
Prior to the Network Policy API the original NetworkPolicy Resource was the only
3+
Prior to the Network Policy API the original NetworkPolicy V1 Resource was the only
44
way for k8s users to apply security rules to their kubernetes workloads. One of the
55
main drawbacks to this API was that it was designed exclusively for use by the
66
Application Developer, although in reality it is used by many different cluster
@@ -9,8 +9,8 @@ Contrast, each resource in the Network Policy API is designed to be used by a
99
specific persona.
1010

1111
With the advent of the AdminNetworkPolicy and BaselineAdminNetworkPolicy
12-
resources Cluster Admins will now have the ability to apply policy on in-cluster
13-
workloads with only a few simple policy objects that can be applied globally.
12+
resources Cluster Admins will now have the ability to apply policy globally with
13+
only a few simple policy objects.
1414

1515
## Roles and personas
1616

site-src/implementations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ implementations, the versions they cover, and documentation to help users get st
1010

1111
Updated: 05-08-2023
1212

13-
- [Ovn-Kubernetes CNI](https://github.com/ovn-org/ovn-kubernetes/pull/3489) (work in progress)
13+
- [OVN-Kubernetes CNI](https://github.com/ovn-org/ovn-kubernetes/pull/3489) (work in progress)
1414
- [Antrea CNI](https://github.com/antrea-io/antrea/pull/4537) (work in progress)
1515
- [Cilium CNI](https://github.com/cilium/cilium/issues/23380) (tracking issue)
1616
- [Calico CNI](https://github.com/projectcalico/calico/issues/7578) (tracking issue)

0 commit comments

Comments
 (0)