NVIPAMPool CRD

- Add CRD definition
- Add Make targets
- Add CR examples based on ConfigMap example

Signed-off-by: Fred Rolland <[email protected]>

Makefile

@@ -143,6 +143,7 @@ PROTOC ?= $(LOCALBIN)/protoc/bin/protoc
 PROTOC_GEN_GO ?= $(LOCALBIN)/protoc-gen-go
 PROTOC_GEN_GO_GRPC ?= $(LOCALBIN)/protoc-gen-go-grpc
 BUF ?= $(LOCALBIN)/buf
+CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
 
 ## Tool Versions
 GOLANGCILINT_VERSION ?= v1.52.2
@@ -152,7 +153,7 @@ PROTOC_VER ?= 23.4
 PROTOC_GEN_GO_VER ?= 1.31.0
 PROTOC_GEN_GO_GRPC_VER ?= 1.3.0
 BUF_VERSION ?= 1.23.1
-
+CONTROLLER_GEN_VERSION ?= v0.13.0
 
 .PHONY: envtest
 envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
@@ -251,3 +252,15 @@ grpc-format: buf  ## Format GRPC files
 	@echo "format protobuf files";
 	cd $(PROTO_DIR) && \
 	$(BUF) format -w --exit-code
+.PHONY: controller-gen
+controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary
+$(CONTROLLER_GEN): | $(LOCALBIN)
+	GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_GEN_VERSION)
+
+.PHONY: generate
+generate: controller-gen
+	$(CONTROLLER_GEN) object:headerFile="./boilerplate.go.txt" paths="./api/..."
+
+.PHONY: manifests
+manifests: controller-gen
+	$(CONTROLLER_GEN) crd paths="./api/..." output:dir="./deploy/crds"

api/v1alpha1/groupversion_info.go

@@ -0,0 +1,33 @@
+/*
+ Copyright 2023, NVIDIA CORPORATION & AFFILIATES
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+     http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+
+// +kubebuilder:object:generate=true
+// +groupName=nv-ipam.nvidia.com
+
+package v1alpha1
+
+import (
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"sigs.k8s.io/controller-runtime/pkg/scheme"
+)
+
+var (
+	// GroupVersion is group version used to register these objects
+	GroupVersion = schema.GroupVersion{Group: "nv-ipam.nvidia.com", Version: "v1alpha1"}
+
+	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
+	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
+
+	// AddToScheme adds the types in this group-version to the given scheme.
+	AddToScheme = SchemeBuilder.AddToScheme
+)

api/v1alpha1/ippool_type.go

@@ -0,0 +1,72 @@
+/*
+ Copyright 2023, NVIDIA CORPORATION & AFFILIATES
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+     http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+
+package v1alpha1
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
+// +kubebuilder:printcolumn:name="Subnet",type="string",JSONPath=`.spec.subnet`
+// +kubebuilder:printcolumn:name="Gateway",type="string",JSONPath=`.spec.gateway`
+// +kubebuilder:printcolumn:name="Block Size",type="integer",JSONPath=`.spec.perNodeBlockSize`
+
+// IPPool contains configuration for IPAM controller
+type IPPool struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+	Spec              IPPoolSpec   `json:"spec"`
+	Status            IPPoolStatus `json:"status,omitempty"`
+}
+
+// IPPoolSpec contains configuration for IP pool
+type IPPoolSpec struct {
+	// subnet of the pool
+	Subnet string `json:"subnet"`
+	// amount of IPs to allocate for each node,
+	// must be less than amount of available IPs in the subnet
+	PerNodeBlockSize int `json:"perNodeBlockSize"`
+	// gateway for the pool
+	Gateway string `json:"gateway"`
+	// selector for nodes, if empty match all nodes
+	NodeSelector *corev1.NodeSelector `json:"nodeSelector,omitempty"`
+}
+
+// IPPoolStatus contains the IP ranges allocated to nodes
+type IPPoolStatus struct {
+	// IP allocations for Nodes
+	Allocations []Allocation `json:"allocations"`
+}
+
+// Allocation contains IP Allocation for a specific Node
+type Allocation struct {
+	NodeName string `json:"nodeName"`
+	StartIP  string `json:"startIP"`
+	EndIP    string `json:"endIP"`
+}
+
+// +kubebuilder:object:root=true
+
+// IPPoolList contains a list of IPPool
+type IPPoolList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []IPPool `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&IPPool{}, &IPPoolList{})
+}

boilerplate.go.txt

@@ -0,0 +1,12 @@
+/*
+ Copyright 2023, NVIDIA CORPORATION & AFFILIATES
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+     http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/