Ginkgo testing

.gitignore

@@ -8,6 +8,7 @@
 *.so
 *.dylib
 bin/*
+private.md
 
 # Test binary, built with `go test -c`
 *.test

Makefile

@@ -1,6 +1,5 @@
 VERSION ?= latest
-REGISTRY ?= yndd
-#REGISTRY ?= gcr.io/jbelamaric-public
+REGISTRY ?= europe-docker.pkg.dev/srlinux/eu.gcr.io
 PROJECT ?= ipam
 
 KPT_BLUEPRINT_CFG_DIR ?= blueprint/fn-config
@@ -9,8 +8,6 @@ KPT_BLUEPRINT_PKG_DIR ?= blueprint/${PROJECT}
 
 # Image URL to use all building/pushing image targets
 IMG ?= $(REGISTRY)/${PROJECT}-controller:$(VERSION)
-# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
-ENVTEST_K8S_VERSION = 1.25.0
 
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
 ifeq (,$(shell go env GOBIN))
@@ -20,6 +17,7 @@ GOBIN=$(shell go env GOBIN)
 endif
 
 # Setting SHELL to bash allows bash commands to be executed by recipes.
+# This is a requirement for 'setup-envtest.sh' in the test target.
 # Options are set to exit when a recipe line exits non-zero or a piped command fails.
 SHELL = /usr/bin/env bash -o pipefail
 .SHELLFLAGS = -ec
@@ -77,7 +75,7 @@ vet: ## Run go vet against code.
 
 .PHONY: test
 test: manifests generate fmt vet envtest ## Run tests.
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... -coverprofile cover.out
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" go test ./... -coverprofile cover.out
 
 ##@ Build
 
@@ -157,6 +155,8 @@ PROTOC_GO_FAST ?= $(LOCALBIN)/protoc-gen-gofast
 PROTOC_GO_GRPC ?= $(LOCALBIN)/protoc-gen-go-grpc
 
 ## Tool Versions
+# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
+ENVTEST_K8S_VERSION = 1.25.0
 KUSTOMIZE_VERSION ?= v3.8.7
 CONTROLLER_TOOLS_VERSION ?= v0.9.2
 KPT_VERSION ?= main
@@ -193,10 +193,10 @@ $(KPTGEN): $(LOCALBIN)
 .PHONY: protoc-gen-gofast
 protoc-gen-gofast: $(PROTOC_GO_FAST) ## Download protoc-gen-gofast locally if necessary.
 $(PROTOC_GO_FAST): $(LOCALBIN)
-	GOBIN=$(LOCALBIN) go install github.com/gogo/protobuf/protoc-gen-gofast@$(PROTOC_GO_FAST_VERSION)
+	test -s $(LOCALBIN)/protoc-gen-gofast || GOBIN=$(LOCALBIN) go install -v github.com/gogo/protobuf/protoc-gen-gofast@$(PROTOC_GO_FAST_VERSION)
 
 .PHONY: protoc-gen-go-grpc
 protoc-gen-gogrpc: $(PROTOC_GO_GRPC) ## Download protoc-gen-golang-grpc locally if necessary.
 $(PROTOC_GO_GRPC): $(LOCALBIN)
-	GOBIN=$(LOCALBIN) go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@$(PROTOC_GO_GRPC_VERSION)
+	test -s $(LOCALBIN)/protoc-gen-go-grpc || GOBIN=$(LOCALBIN) go install -v google.golang.org/grpc/cmd/protoc-gen-go-grpc@$(PROTOC_GO_GRPC_VERSION)
 

README.md

@@ -16,12 +16,12 @@ The IPAM is a kubernetes native IP address management, which supports:
 ![ipam architecture](ipam-architecture.jpg)
 
 ## ipam logic and terminology
-
+◊
 The IPAM has multiple network contexts (implemented as network-instances) that can have multiple prefixes that can be nested. The top prefix of a nested hierarchy is called an aggregated prefix. At the bottom layer we can have IP ranges or IP addresses that are allocated from within a prefix.
 
 ![ipam hierarchy](ipam-hierarchy.jpg)
 
-Prefix - A subnet defined within an aggregate prefix. Prefixes extend the hierarchy by nesting within one another. (For example, 2000:1:1::/64 will appear within 2000:1::/48.) 
+Prefix - A subnet defined within an aggregate prefix. Prefixes extend the hierarchy by nesting within one another. (For example, 2000:1:1::/64 will appear within 2000:1::/48.)
 
 IP Range - An arbitrary range of individual IP addresses within a prefix, all sharing the same mask. (out of scope for now)
 

apis/ipam/v1alpha1/LabelKeys.go

@@ -17,19 +17,36 @@ limitations under the License.
 package v1alpha1
 
 const (
-	NephioNetworkInstanceKey = "nephio.org/network-instance"
-	NephioPrefixKindKey      = "nephio.org/prefix-kind"
-	NephioPrefixLengthKey    = "nephio.org/prefix-length"
-	NephioAddressFamilyKey   = "nephio.org/address-family"
-	NephioIPPrefixNameKey    = "nephio.org/prefix-name"
-	NephioNetworkNameKey     = "nephio.org/network-name"
-	NephioNetworkKey         = "nephio.org/network"
-	//NephioParentNetKey          = "nephio.org/parent-net"
-	NephioParentPrefixLengthKey = "nephio.org/parent-prefix-length"
-	NephioIPAllocactionNameKey  = "nephio.org/allocation-name"
-	NephioPoolKey               = "nephio.org/pool"
-	NephioGatewayKey            = "nephio.org/gateway"
-	NephioInterfaceKey          = "nephio.org/interface"
-	NephioApplicationPartOfKey  = "app.kubernetes.io/part-of"
-	NephioOriginKey             = "nephio.org/origin"
+	// ipam system defined
+	//NephioNetworkInstanceKey    = "nephio.org/network-instance"
+	NephioPrefixKindKey = "nephio.org/prefix-kind"
+	//NephioPrefixKey             = "nephio.org/prefix"
+	//NephioPrefixLengthKey       = "nephio.org/prefix-length"
+	NephioAddressFamilyKey = "nephio.org/address-family"
+	NephioSubnetKey        = "nephio.org/subnet" // this is the subnet in prefix annotation used for GW selection
+	//NephioParentPrefixLengthKey = "nephio.org/parent-prefix-length"
+	NephioPoolKey              = "nephio.org/pool"
+	NephioGatewayKey           = "nephio.org/gateway"
+	NephioOwnerGvkKey          = "nephio.org/owner-gvk"
+	NephioOwnerNsnNameKey      = "nephio.org/owner-nsn-name"
+	NephioOwnerNsnNamespaceKey = "nephio.org/owner-nsn-namespace"
+	NephioGvkKey               = "nephio.org/gvk"
+	NephioNsnNameKey           = "nephio.org/nsn-name"
+	NephioNsnNamespaceKey      = "nephio.org/nsn-namespace"
+	//NephioIPAllocactionNameKey  = "nephio.org/allocation-name"
+	//NephioIPContributingRouteKey = "nephio.org/contributing-route"
+	//NephioReplacementNameKey     = "nephio.org/replacement-name"
+	//NephioSubnetNameKey         = "nephio.org/subnet-name" // this is the subnet string or name given in the spec/selector
+	//ipam user defined
+	NephioInterfaceKey         = "nephio.org/interface"
+	NephioNetworkNameKey       = "nephio.org/network-name"
+	NephioPurposeKey           = "nephio.org/purpose"
+	NephioApplicationPartOfKey = "app.kubernetes.io/part-of"
+	NephioIndexKey             = "nephio.org/index"
+	NephioSiteKey              = "nephio.org/site"
+	NephioRegionKey            = "nephio.org/region"
+	NephioAvailabilityZoneKey  = "nephio.org/availability-zone"
+	// ipam status
+	NephioAllocatedPrefix  = "nephio.org/allocated-prefix"
+	NephioAllocatedGateway = "nephio.org/allocated-gateway"
 )

apis/ipam/v1alpha1/ipallocation_types.go

@@ -19,6 +19,8 @@ package v1alpha1
 import (
 	"reflect"
 
+	"github.com/nokia/k8s-ipam/internal/meta"
+	"github.com/nokia/k8s-ipam/internal/utils/iputil"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 )
@@ -27,31 +29,47 @@ import (
 type IPAllocationSpec struct {
 	// +kubebuilder:validation:Enum=`network`;`loopback`;`pool`;`aggregate`
 	// +kubebuilder:default=network
-	PrefixKind string `json:"kind"`
+	PrefixKind PrefixKind `json:"kind" yaml:"kind"`
+	// NetworkInstanceRef identifies the networkInstance for this prefix
+	NetworkInstanceRef *NetworkInstanceReference `json:"networkInstanceRef"`
 	// +kubebuilder:validation:Enum=`ipv4`;`ipv6`
-	AddressFamily string `json:"addressFamily,omitempty"`
+	AddressFamily iputil.AddressFamily `json:"addressFamily,omitempty" yaml:"addressFamily,omitempty"`
 	// Prefix allows the client to indicate the prefix that was already allocated and validate if the allocation is still consistent
 	// +kubebuilder:validation:Pattern=`(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])/(([0-9])|([1-2][0-9])|(3[0-2]))|((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))`
-	Prefix string `json:"prefix,omitempty"`
+	Prefix string `json:"prefix,omitempty" yaml:"prefix,omitempty"`
 	// PrefixLength allows to client to indicate the prefixLength he wants for the allocation
-	PrefixLength uint8 `json:"prefixLength,omitempty"`
+	// used for prefixes, if not supplied we use eother /32 for ipv4 and /128 for ipv6
+	PrefixLength uint8 `json:"prefixLength,omitempty" yaml:"prefixLength,omitempty"`
+	// index is used for deterministic allocation
+	Index uint32 `json:"index,omitempty" yaml:"index,omitempty"`
 	// Label selector for selecting the context from which the IP prefix/address gets allocated
-	Selector *metav1.LabelSelector `json:"selector,omitempty"`
+	Selector *metav1.LabelSelector `json:"selector,omitempty" yaml:"selector,omitempty"`
+	// Labels provide metadata to the prefix. They are part of the spec since the allocation
+	// selector will use these labels for allocation more specific prefixes/addresses within this prefix
+	// As such we distinguish clearly between the metadata labels and the labels used in the spec
+	Labels map[string]string `json:"labels,omitempty" yaml:"labels,omitempty"`
+	// indicates a prefix has to be created which is not an address
+	CreatePrefix bool `json:"createPrefix,omitempty" yaml:"createPrefix,omitempty"`
+	// expiryTime indicated when the allocation expires
+	ExpiryTime string `json:"expiryTime,omitempty" yaml:"expiryTime,omitempty"`
 }
 
 // IPAllocationStatus defines the observed state of IPAllocation
 type IPAllocationStatus struct {
-	ConditionedStatus `json:",inline"`
+	ConditionedStatus `json:",inline" yaml:",inline"`
 	// AllocatedPrefix identifies the prefix that was allocated by the IPAM system
-	AllocatedPrefix string `json:"prefix,omitempty"`
+	AllocatedPrefix string `json:"prefix,omitempty" yaml:"prefix,omitempty"`
 	// Gateway identifies the gatway IP for the network
-	Gateway string `json:"gateway,omitempty"`
+	Gateway string `json:"gateway,omitempty" yaml:"gateway,omitempty"`
+	// expiryTime indicated when the allocation expires
+	ExpiryTime string `json:"expiryTime,omitempty" yaml:"expiryTime,omitempty"`
 }
 
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 // +kubebuilder:printcolumn:name="SYNC",type="string",JSONPath=".status.conditions[?(@.kind=='Synced')].status"
 // +kubebuilder:printcolumn:name="STATUS",type="string",JSONPath=".status.conditions[?(@.kind=='Ready')].status"
+// +kubebuilder:printcolumn:name="NETWORK-INSTANCE",type="string",JSONPath=".spec.networkInstance"
 // +kubebuilder:printcolumn:name="KIND",type="string",JSONPath=".spec.kind"
 // +kubebuilder:printcolumn:name="AF",type="string",JSONPath=".spec.addressFamily"
 // +kubebuilder:printcolumn:name="PREFIXLENGTH",type="string",JSONPath=".spec.prefixLength"
@@ -62,20 +80,20 @@ type IPAllocationStatus struct {
 // +kubebuilder:resource:categories={nephio,ipam}
 // IPAllocation is the Schema for the ipallocations API
 type IPAllocation struct {
-	metav1.TypeMeta   `json:",inline"`
-	metav1.ObjectMeta `json:"metadata,omitempty"`
+	metav1.TypeMeta   `json:",inline" yaml:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`
 
-	Spec   IPAllocationSpec   `json:"spec,omitempty"`
-	Status IPAllocationStatus `json:"status,omitempty"`
+	Spec   IPAllocationSpec   `json:"spec,omitempty" yaml:"spec,omitempty"`
+	Status IPAllocationStatus `json:"status,omitempty" yaml:"status,omitempty"`
 }
 
 //+kubebuilder:object:root=true
 
 // IPAllocationList contains a list of IPAllocation
 type IPAllocationList struct {
-	metav1.TypeMeta `json:",inline"`
-	metav1.ListMeta `json:"metadata,omitempty"`
-	Items           []IPAllocation `json:"items"`
+	metav1.TypeMeta `json:",inline" yaml:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`
+	Items           []IPAllocation `json:"items" yaml:"items"`
 }
 
 func init() {
@@ -87,4 +105,9 @@ var (
 	IPAllocationGroupKind        = schema.GroupKind{Group: GroupVersion.Group, Kind: IPAllocationKind}.String()
 	IPAllocationKindAPIVersion   = IPAllocationKind + "." + GroupVersion.String()
 	IPAllocationGroupVersionKind = GroupVersion.WithKind(IPAllocationKind)
+	IPAllocationKindGVKString    = meta.GVKToString(&schema.GroupVersionKind{
+		Group:   GroupVersion.Group,
+		Version: GroupVersion.Version,
+		Kind:    IPAllocationKind,
+	})
 )