feat: rename NetworkContainer to MultiTenantNetworkContainer (#892)

Author: feiskyer

cns/multitenantcontroller/multitenantoperator/multitenantcrdcontroller.go

@@ -9,7 +9,7 @@ import (
 	"github.com/Azure/azure-container-networking/cns/cnsclient/httpapi"
 	"github.com/Azure/azure-container-networking/cns/logger"
 	"github.com/Azure/azure-container-networking/cns/restserver"
-	ncapi "github.com/Azure/azure-container-networking/networkcontainer/api/v1alpha1"
+	ncapi "github.com/Azure/azure-container-networking/crds/multitenantnetworkcontainer/api/v1alpha1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"

cns/multitenantcontroller/multitenantoperator/multitenantcrdreconciler.go

@@ -8,7 +8,7 @@ import (
 	"github.com/Azure/azure-container-networking/cns"
 	"github.com/Azure/azure-container-networking/cns/cnsclient"
 	"github.com/Azure/azure-container-networking/cns/logger"
-	ncapi "github.com/Azure/azure-container-networking/networkcontainer/api/v1alpha1"
+	ncapi "github.com/Azure/azure-container-networking/crds/multitenantnetworkcontainer/api/v1alpha1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/runtime"
 	ctrl "sigs.k8s.io/controller-runtime"
@@ -34,7 +34,7 @@ type multiTenantCrdReconciler struct {
 // Reconcile is called on multi-tenant CRD status changes.
 func (r *multiTenantCrdReconciler) Reconcile(request reconcile.Request) (reconcile.Result, error) {
 	ctx := context.Background()
-	var nc ncapi.NetworkContainer
+	var nc ncapi.MultiTenantNetworkContainer
 
 	if err := r.KubeClient.Get(ctx, request.NamespacedName, &nc); err != nil {
 		if apierrors.IsNotFound(err) {
@@ -124,7 +124,7 @@ func (r *multiTenantCrdReconciler) Reconcile(request reconcile.Request) (reconci
 // SetupWithManager Sets up the reconciler with a new manager, filtering using NodeNetworkConfigFilter
 func (r *multiTenantCrdReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
-		For(&ncapi.NetworkContainer{}).
+		For(&ncapi.MultiTenantNetworkContainer{}).
 		WithEventFilter(r.predicate()).
 		Complete(r)
 }
@@ -147,7 +147,7 @@ func (r *multiTenantCrdReconciler) predicate() predicate.Predicate {
 }
 
 func (r *multiTenantCrdReconciler) equalNode(o runtime.Object) bool {
-	nc, ok := o.(*ncapi.NetworkContainer)
+	nc, ok := o.(*ncapi.MultiTenantNetworkContainer)
 	if ok {
 		return strings.EqualFold(nc.Spec.Node, r.NodeName)
 	}

cns/multitenantcontroller/multitenantoperator/multitenantcrdreconciler_test.go

@@ -6,7 +6,7 @@ import (
 	"github.com/Azure/azure-container-networking/cns"
 	"github.com/Azure/azure-container-networking/cns/logger"
 	"github.com/Azure/azure-container-networking/cns/multitenantcontroller/mockclients"
-	ncapi "github.com/Azure/azure-container-networking/networkcontainer/api/v1alpha1"
+	ncapi "github.com/Azure/azure-container-networking/crds/multitenantnetworkcontainer/api/v1alpha1"
 	"github.com/golang/mock/gomock"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
@@ -69,11 +69,11 @@ var _ = Describe("multiTenantCrdReconciler", func() {
 		})
 
 		It("Should succeed when the NC is in Terminated state", func() {
-			var nc ncapi.NetworkContainer = ncapi.NetworkContainer{
+			var nc ncapi.MultiTenantNetworkContainer = ncapi.MultiTenantNetworkContainer{
 				ObjectMeta: metav1.ObjectMeta{
 					DeletionTimestamp: &metav1.Time{},
 				},
-				Status: ncapi.NetworkContainerStatus{
+				Status: ncapi.MultiTenantNetworkContainerStatus{
 					State: "Terminated",
 				},
 			}
@@ -85,8 +85,8 @@ var _ = Describe("multiTenantCrdReconciler", func() {
 		})
 
 		It("Should succeed when the NC is not in Initialized state", func() {
-			var nc ncapi.NetworkContainer = ncapi.NetworkContainer{
-				Status: ncapi.NetworkContainerStatus{
+			var nc ncapi.MultiTenantNetworkContainer = ncapi.MultiTenantNetworkContainer{
+				Status: ncapi.MultiTenantNetworkContainerStatus{
 					State: "Pending",
 				},
 			}
@@ -99,11 +99,11 @@ var _ = Describe("multiTenantCrdReconciler", func() {
 
 		It("Should succeed when the NC is in Initialized state and it has already been persisted in CNS", func() {
 			var uuid = "uuid"
-			var nc ncapi.NetworkContainer = ncapi.NetworkContainer{
-				Spec: ncapi.NetworkContainerSpec{
+			var nc ncapi.MultiTenantNetworkContainer = ncapi.MultiTenantNetworkContainer{
+				Spec: ncapi.MultiTenantNetworkContainerSpec{
 					UUID: uuid,
 				},
-				Status: ncapi.NetworkContainerStatus{
+				Status: ncapi.MultiTenantNetworkContainerStatus{
 					State: "Initialized",
 				},
 			}
@@ -117,11 +117,11 @@ var _ = Describe("multiTenantCrdReconciler", func() {
 
 		It("Should fail when the NC subnet isn't in correct format", func() {
 			var uuid = "uuid"
-			var nc ncapi.NetworkContainer = ncapi.NetworkContainer{
-				Spec: ncapi.NetworkContainerSpec{
+			var nc ncapi.MultiTenantNetworkContainer = ncapi.MultiTenantNetworkContainer{
+				Spec: ncapi.MultiTenantNetworkContainerSpec{
 					UUID: uuid,
 				},
-				Status: ncapi.NetworkContainerStatus{
+				Status: ncapi.MultiTenantNetworkContainerStatus{
 					State:    "Initialized",
 					IPSubnet: "1.2.3.4.5",
 				},
@@ -137,11 +137,11 @@ var _ = Describe("multiTenantCrdReconciler", func() {
 
 		It("Should succeed when the NC subnet is in correct format", func() {
 			var uuid = "uuid"
-			var nc ncapi.NetworkContainer = ncapi.NetworkContainer{
-				Spec: ncapi.NetworkContainerSpec{
+			var nc ncapi.MultiTenantNetworkContainer = ncapi.MultiTenantNetworkContainer{
+				Spec: ncapi.MultiTenantNetworkContainerSpec{
 					UUID: uuid,
 				},
-				Status: ncapi.NetworkContainerStatus{
+				Status: ncapi.MultiTenantNetworkContainerStatus{
 					State:    "Initialized",
 					IPSubnet: "1.2.3.0/24",
 				},

networkcontainer/Makefile renamed to crds/multitenantnetworkcontainer/Makefile

@@ -0,0 +1,3 @@
+# MultiTenantNetworkContainer CRDs
+
+This package contains the CRD definitions for MultiTenantNetworkContainer, which would be consumed in CNS.

crds/multitenantnetworkcontainer/README.md

@@ -22,8 +22,8 @@ import (
 // NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
 // Important: Run "make" to regenerate code after modifying this file
 
-// NetworkContainerSpec defines the desired state of NetworkContainer
-type NetworkContainerSpec struct {
+// MultiTenantNetworkContainerSpec defines the desired state of MultiTenantNetworkContainer
+type MultiTenantNetworkContainerSpec struct {
 	// UUID - network container UUID
 	UUID string `json:"uuid,omitempty"`
 	// Network - customer VNet GUID
@@ -38,8 +38,8 @@ type NetworkContainerSpec struct {
 	ReservationID string `json:"reservationID,omitempty"`
 }
 
-// NetworkContainerStatus defines the observed state of NetworkContainer
-type NetworkContainerStatus struct {
+// MultiTenantNetworkContainerStatus defines the observed state of MultiTenantNetworkContainer
+type MultiTenantNetworkContainerStatus struct {
 	// The IP address
 	IP string `json:"ip,omitempty"`
 	// The gateway IP address
@@ -53,24 +53,24 @@ type NetworkContainerStatus struct {
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 
-// NetworkContainer is the Schema for the networkcontainers API
-type NetworkContainer struct {
+// MultiTenantNetworkContainer is the Schema for the MultiTenantnetworkcontainers API
+type MultiTenantNetworkContainer struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
-	Spec   NetworkContainerSpec   `json:"spec,omitempty"`
-	Status NetworkContainerStatus `json:"status,omitempty"`
+	Spec   MultiTenantNetworkContainerSpec   `json:"spec,omitempty"`
+	Status MultiTenantNetworkContainerStatus `json:"status,omitempty"`
 }
 
 // +kubebuilder:object:root=true
 
-// NetworkContainerList contains a list of NetworkContainer
-type NetworkContainerList struct {
+// MultiTenantNetworkContainerList contains a list of MultiTenantNetworkContainer
+type MultiTenantNetworkContainerList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`
-	Items           []NetworkContainer `json:"items"`
+	Items           []MultiTenantNetworkContainer `json:"items"`
 }
 
 func init() {
-	SchemeBuilder.Register(&NetworkContainer{}, &NetworkContainerList{})
+	SchemeBuilder.Register(&MultiTenantNetworkContainer{}, &MultiTenantNetworkContainerList{})
 }

networkcontainer/api/v1alpha1/groupversion_info.go renamed to crds/multitenantnetworkcontainer/api/v1alpha1/groupversion_info.go

@@ -6,20 +6,21 @@ metadata:
   annotations:
     controller-gen.kubebuilder.io/version: v0.3.0
   creationTimestamp: null
-  name: networkcontainers.networking.azure.com
+  name: multitenantnetworkcontainers.networking.azure.com
 spec:
   group: networking.azure.com
   names:
-    kind: NetworkContainer
-    listKind: NetworkContainerList
-    plural: networkcontainers
-    singular: networkcontainer
+    kind: MultiTenantNetworkContainer
+    listKind: MultiTenantNetworkContainerList
+    plural: multitenantnetworkcontainers
+    singular: multitenantnetworkcontainer
   scope: Namespaced
   subresources:
     status: {}
   validation:
     openAPIV3Schema:
-      description: NetworkContainer is the Schema for the networkcontainers API
+      description: MultiTenantNetworkContainer is the Schema for the MultiTenantnetworkcontainers
+        API
       properties:
         apiVersion:
           description: 'APIVersion defines the versioned schema of this representation
@@ -34,7 +35,8 @@ spec:
         metadata:
           type: object
         spec:
-          description: NetworkContainerSpec defines the desired state of NetworkContainer
+          description: MultiTenantNetworkContainerSpec defines the desired state of
+            MultiTenantNetworkContainer
           properties:
             interfaceName:
               description: InterfaceName - the interface name for consuming Pod
@@ -56,7 +58,8 @@ spec:
               type: string
           type: object
         status:
-          description: NetworkContainerStatus defines the observed state of NetworkContainer
+          description: MultiTenantNetworkContainerStatus defines the observed state
+            of MultiTenantNetworkContainer
           properties:
             gateway:
               description: The gateway IP address