Add tag support for IPAM/Prefix resources

api/v1/ipaddress_types.go

@@ -36,6 +36,10 @@ type IpAddressSpec struct {
 	//+kubebuilder:validation:XValidation:rule="self == oldSelf",message="Field 'tenant' is immutable"
 	Tenant string `json:"tenant,omitempty"`
 
+	// A list of tags that will be assigned to the resource in NetBox.
+	// Each tag must define exactly one of the `name` or `slug` fields.
+	Tags []Tag `json:"tags,omitempty"`
+
 	// The NetBox Custom Fields that should be added to the resource in NetBox.
 	// Note that currently only Text Type is supported (GitHub #129)
 	// More info on NetBox Custom Fields:

api/v1/ipaddressclaim_types.go

@@ -36,6 +36,10 @@ type IpAddressClaimSpec struct {
 	//+kubebuilder:validation:XValidation:rule="self == oldSelf",message="Field 'tenant' is immutable"
 	Tenant string `json:"tenant,omitempty"`
 
+	// A list of tags that will be assigned to the NetBox resource.
+	// Each tag must define exactly one of the `name` or `slug` fields.
+	Tags []Tag `json:"tags,omitempty"`
+
 	// The NetBox Custom Fields that should be added to the resource in NetBox.
 	// Note that currently only Text Type is supported (GitHub #129)
 	// More info on NetBox Custom Fields:

api/v1/iprange_types.go

@@ -44,6 +44,10 @@ type IpRangeSpec struct {
 	//+kubebuilder:validation:XValidation:rule="self == oldSelf",message="Field 'tenant' is immutable"
 	Tenant string `json:"tenant,omitempty"`
 
+	// A list of tags that will be assigned to the resource in NetBox.
+	// Each tag must define exactly one of the `name` or `slug` fields.
+	Tags []Tag `json:"tags,omitempty"`
+
 	// The NetBox Custom Fields that should be added to the resource in NetBox.
 	// Note that currently only Text Type is supported (GitHub #129)
 	// More info on NetBox Custom Fields:

api/v1/iprangeclaim_types.go

@@ -47,6 +47,10 @@ type IpRangeClaimSpec struct {
 	//+kubebuilder:validation:XValidation:rule="self == oldSelf",message="Field 'tenant' is immutable"
 	Tenant string `json:"tenant,omitempty"`
 
+	// A list of tags that will be assigned to the NetBox resource.
+	// Each tag must define exactly one of the `name` or `slug` fields.
+	Tags []Tag `json:"tags,omitempty"`
+
 	// The NetBox Custom Fields that should be added to the resource in NetBox.
 	// Note that currently only Text Type is supported (GitHub #129)
 	// More info on NetBox Custom Fields:

api/v1/prefix_types.go

@@ -42,6 +42,13 @@ type PrefixSpec struct {
 	//+kubebuilder:validation:XValidation:rule="self == oldSelf",message="Field 'tenant' is immutable"
 	Tenant string `json:"tenant,omitempty"`
 
+	// A list of tags that will be assigned to the resource in NetBox.
+	// Each tag may contain either the `name` or `slug` field (one of them is required).
+	// Example:
+	//   - name: tag1
+	//   - slug: tag2
+	Tags []Tag `json:"tags,omitempty"`
+
 	// The NetBox Custom Fields that should be added to the resource in NetBox.
 	// Note that currently only Text Type is supported (GitHub #129)
 	// More info on NetBox Custom Fields:

api/v1/prefixclaim_types.go

@@ -61,6 +61,10 @@ type PrefixClaimSpec struct {
 	//+kubebuilder:validation:XValidation:rule="self == oldSelf",message="Field 'tenant' is immutable"
 	Tenant string `json:"tenant,omitempty"`
 
+	// A list of tags that will be assigned to the NetBox resource.
+	// Each tag must define exactly one of the `name` or `slug` fields.
+	Tags []Tag `json:"tags,omitempty"`
+
 	// Description that should be added to the resource in NetBox
 	// Field is mutable, not required
 	Description string `json:"description,omitempty"`

api/v1/tag_types.go

@@ -0,0 +1,28 @@
+/*
+Copyright 2024 Swisscom (Schweiz) AG.
+
+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 v1
+
+// +kubebuilder:validation:XValidation:rule="has(self.name) != has(self.slug)",message="exactly one of name or slug must be specified"
+type Tag struct {
+	// +optional
+	// Name of the tag
+	Name string `json:"name,omitempty"`
+
+	// +optional
+	// Slug of the tag
+	Slug string `json:"slug,omitempty"`
+}

config/crd/bases/netbox.dev_ipaddressclaims.yaml

@@ -105,6 +105,23 @@ spec:
                   recreated in Kubernetes)
                   Field is mutable, not required
                 type: boolean
+              tags:
+                description: |-
+                  A list of tags that will be assigned to the NetBox resource.
+                  Each tag must define exactly one of the `name` or `slug` fields.
+                items:
+                  properties:
+                    name:
+                      description: Name of the tag
+                      type: string
+                    slug:
+                      description: Slug of the tag
+                      type: string
+                  type: object
+                  x-kubernetes-validations:
+                  - message: exactly one of name or slug must be specified
+                    rule: has(self.name) != has(self.slug)
+                type: array
               tenant:
                 description: |-
                   The NetBox Tenant to be assigned to this resource in NetBox. Use the `name` value instead of the `slug` value

config/crd/bases/netbox.dev_ipaddresses.yaml

@@ -104,6 +104,23 @@ spec:
                   recreated in Kubernetes)
                   Field is mutable, not required
                 type: boolean
+              tags:
+                description: |-
+                  A list of tags that will be assigned to the resource in NetBox.
+                  Each tag must define exactly one of the `name` or `slug` fields.
+                items:
+                  properties:
+                    name:
+                      description: Name of the tag
+                      type: string
+                    slug:
+                      description: Slug of the tag
+                      type: string
+                  type: object
+                  x-kubernetes-validations:
+                  - message: exactly one of name or slug must be specified
+                    rule: has(self.name) != has(self.slug)
+                type: array
               tenant:
                 description: |-
                   The NetBox Tenant to be assigned to this resource in NetBox. Use the `name` value instead of the `slug` value

config/crd/bases/netbox.dev_iprangeclaims.yaml

@@ -118,6 +118,23 @@ spec:
                 x-kubernetes-validations:
                 - message: Field 'size' is immutable
                   rule: self == oldSelf
+              tags:
+                description: |-
+                  A list of tags that will be assigned to the NetBox resource.
+                  Each tag must define exactly one of the `name` or `slug` fields.
+                items:
+                  properties:
+                    name:
+                      description: Name of the tag
+                      type: string
+                    slug:
+                      description: Slug of the tag
+                      type: string
+                  type: object
+                  x-kubernetes-validations:
+                  - message: exactly one of name or slug must be specified
+                    rule: has(self.name) != has(self.slug)
+                type: array
               tenant:
                 description: |-
                   The NetBox Tenant to be assigned to this resource in NetBox. Use the `name` value instead of the `slug` value

config/crd/bases/netbox.dev_ipranges.yaml

@@ -117,6 +117,23 @@ spec:
                 x-kubernetes-validations:
                 - message: Field 'startAddress' is immutable
                   rule: self == oldSelf
+              tags:
+                description: |-
+                  A list of tags that will be assigned to the resource in NetBox.
+                  Each tag must define exactly one of the `name` or `slug` fields.
+                items:
+                  properties:
+                    name:
+                      description: Name of the tag
+                      type: string
+                    slug:
+                      description: Slug of the tag
+                      type: string
+                  type: object
+                  x-kubernetes-validations:
+                  - message: exactly one of name or slug must be specified
+                    rule: has(self.name) != has(self.slug)
+                type: array
               tenant:
                 description: |-
                   The NetBox Tenant to be assigned to this resource in NetBox. Use the `name` value instead of the `slug` value

config/crd/bases/netbox.dev_prefixclaims.yaml

@@ -140,6 +140,23 @@ spec:
                 x-kubernetes-validations:
                 - message: Field 'site' is immutable
                   rule: self == oldSelf
+              tags:
+                description: |-
+                  A list of tags that will be assigned to the NetBox resource.
+                  Each tag must define exactly one of the `name` or `slug` fields.
+                items:
+                  properties:
+                    name:
+                      description: Name of the tag
+                      type: string
+                    slug:
+                      description: Slug of the tag
+                      type: string
+                  type: object
+                  x-kubernetes-validations:
+                  - message: exactly one of name or slug must be specified
+                    rule: has(self.name) != has(self.slug)
+                type: array
               tenant:
                 description: |-
                   The NetBox Tenant to be assigned to this resource in NetBox. Use the `name` value instead of the `slug` value

config/crd/bases/netbox.dev_prefixes.yaml

@@ -112,6 +112,26 @@ spec:
                 x-kubernetes-validations:
                 - message: Field 'site' is required once set
                   rule: self == oldSelf || self != ''
+              tags:
+                description: |-
+                  A list of tags that will be assigned to the resource in NetBox.
+                  Each tag may contain either the `name` or `slug` field (one of them is required).
+                  Example:
+                    - name: tag1
+                    - slug: tag2
+                items:
+                  properties:
+                    name:
+                      description: Name of the tag
+                      type: string
+                    slug:
+                      description: Slug of the tag
+                      type: string
+                  type: object
+                  x-kubernetes-validations:
+                  - message: exactly one of name or slug must be specified
+                    rule: has(self.name) != has(self.slug)
+                type: array
               tenant:
                 description: |-
                   The NetBox Tenant to be assigned to this resource in NetBox. Use the `name` value instead of the `slug` value

config/samples/netbox_v1_ipaddress.yaml

@@ -11,4 +11,6 @@ spec:
   description: "some description"
   comments: "your comments"
   preserveInNetbox: true
+  tags:
+    - name: host-alpha
   ipAddress: "2.0.0.100/32"

config/samples/netbox_v1_ipaddressclaim.yaml

@@ -11,4 +11,6 @@ spec:
   description: "some description"
   comments: "your comments"
   preserveInNetbox: true
+  tags:
+    - name: claim-alpha
   parentPrefix: "2.0.0.0/16"

config/samples/netbox_v1_iprange.yaml

@@ -11,5 +11,7 @@ spec:
   description: "some description"
   comments: "your comments"
   preserveInNetbox: true
+  tags:
+    - name: range-alpha
   startAddress: "2.0.0.200/32"
   endAddress: "2.0.0.202/32"

config/samples/netbox_v1_iprangeclaim.yaml

@@ -11,5 +11,7 @@ spec:
   description: "some description"
   comments: "your comments"
   preserveInNetbox: true
+  tags:
+    - name: range-claim-alpha
   parentPrefix: "2.0.0.0/16"
   size: 3

config/samples/netbox_v1_prefix.yaml

@@ -13,3 +13,7 @@ spec:
   comments: "your comments"
   preserveInNetbox: true
   prefix: "2.0.0.0/24"
+  tags:
+    - name: Alpha
+    - slug: golf
+    - name: Bravo

config/samples/netbox_v1_prefixclaim.yaml

@@ -12,5 +12,7 @@ spec:
   description: "some description"
   comments: "your comments"
   preserveInNetbox: true
+  tags:
+    - name: alpha
   parentPrefix: "2.0.0.0/16"
   prefixLength: "/28"

config/samples/netbox_v1_prefixclaim_parentprefixselector.yaml

@@ -12,6 +12,8 @@ spec:
   description: "some description"
   comments: "your comments"
   preserveInNetbox: true
+  tags:
+    - name: selector-alpha
   prefixLength: "/31"
   parentPrefixSelector:
     tenant: "MY_TENANT"

config/samples/netbox_v1_prefixclaim_parentprefixselector_bool_int.yaml

@@ -12,6 +12,8 @@ spec:
   description: "some description"
   comments: "your comments"
   preserveInNetbox: true
+  tags:
+    - name: selector-bool
   prefixLength: "/31"
   parentPrefixSelector:
     # should return a prefix in 3.0.0.0/24 with the sample data