Add description field to VRF resource (#114)

Author: felix-kaestner

api/core/v1alpha1/vrf_types.go

@@ -26,6 +26,12 @@ type VRFSpec struct {
 	// +kubebuilder:validation:MaxLength=32
 	Name string `json:"name"`
 
+	// Description provides a human-readable description of the VRF.
+	// +optional
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:MaxLength=255
+	Description string `json:"description,omitempty"`
+
 	// VNI is the VXLAN Network Identifier for the VRF (always an L3).
 	// +optional
 	// +kubebuilder:validation:Minimum=1

charts/network-operator/templates/crd/networking.metal.ironcore.dev_vrfs.yaml

@@ -60,6 +60,12 @@ spec:
               spec defines the desired state of VRF
               More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
             properties:
+              description:
+                description: Description provides a human-readable description of
+                  the VRF.
+                maxLength: 255
+                minLength: 1
+                type: string
               deviceRef:
                 description: |-
                   DeviceName is the name of the Device this object belongs to. The Device object must exist in the same namespace.

config/crd/bases/networking.metal.ironcore.dev_vrfs.yaml

@@ -54,6 +54,12 @@ spec:
               spec defines the desired state of VRF
               More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
             properties:
+              description:
+                description: Description provides a human-readable description of
+                  the VRF.
+                maxLength: 255
+                minLength: 1
+                type: string
               deviceRef:
                 description: |-
                   DeviceName is the name of the Device this object belongs to. The Device object must exist in the same namespace.

internal/provider/cisco/nxos/provider.go

@@ -1567,6 +1567,9 @@ func (p *Provider) DeleteSyslog(ctx context.Context) error {
 func (p *Provider) EnsureVRF(ctx context.Context, req *provider.VRFRequest) error {
 	v := new(VRF)
 	v.Name = req.VRF.Spec.Name
+	if req.VRF.Spec.Description != "" {
+		v.Descr = NewOption(req.VRF.Spec.Description)
+	}
 
 	if req.VRF.Spec.VNI > 0 {
 		v.L3Vni = true

internal/provider/cisco/nxos/testdata/vrf.json

@@ -5,6 +5,7 @@
         "encap": "vxlan-101",
         "l3vni": true,
         "name": "CC-CLOUD01",
+        "descr": "CC-CLOUD01 VRF",
         "dom-items": {
           "Dom-list": [
             {

internal/provider/cisco/nxos/testdata/vrf.json.txt

@@ -1,5 +1,6 @@
 vrf context CC-CLOUD01
   vni 101 l3
+  description CC-CLOUD01 VRF
   rd 4269539332:101
   address-family ipv4 unicast
     route-target import 65148:1101

internal/provider/cisco/nxos/vrf.go

@@ -11,10 +11,11 @@ const DefaultVRFName = "default"
 var _ gnmiext.Configurable = (*VRF)(nil)
 
 type VRF struct {
-	Encap    string       `json:"encap"`
-	L3Vni    bool         `json:"l3vni"`
-	Name     string       `json:"name"`
-	DomItems *VRFDomItems `json:"dom-items,omitempty"`
+	Encap    string         `json:"encap"`
+	L3Vni    bool           `json:"l3vni"`
+	Name     string         `json:"name"`
+	Descr    Option[string] `json:"descr"`
+	DomItems *VRFDomItems   `json:"dom-items,omitempty"`
 }
 
 func (*VRF) IsListItem() {}

internal/provider/cisco/nxos/vrf_test.go

@@ -43,6 +43,7 @@ func init() {
 		Name:     "CC-CLOUD01",
 		L3Vni:    true,
 		Encap:    "vxlan-101",
+		Descr:    NewOption("CC-CLOUD01 VRF"),
 		DomItems: &VRFDomItems{DomList: []*VRFDom{dom}},
 	}