Add preserveNamespace flag to DiscoveryVendorProfile (#352)

Co-authored-by: Dan Peachey <[email protected]>

Author: dpeachey

apis/inv/v1alpha1/discoveryvendorprofile_helpers.go

@@ -23,3 +23,10 @@ func (r *GnmiDiscoveryVendorProfileParameters) GetEncoding() Encoding {
 	}
 	return *r.Encoding
 }
+
+func (r *GnmiDiscoveryVendorProfileParameters) GetPreserveNamespace() bool {
+	if r.PreserveNamespace == nil {
+		return false
+	}
+	return *r.PreserveNamespace
+}

apis/inv/v1alpha1/discoveryvendorprofile_types.go

@@ -36,7 +36,10 @@ type GnmiDiscoveryVendorProfileParameters struct {
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="encoding is immutable"
 	// +kubebuilder:validation:Enum=UNKNOWN;JSON;JSON_IETF;PROTO;ASCII;
 	// +kubebuilder:default:=JSON_IETF
-	Encoding *Encoding `json:"encoding,omitempty" yaml:"encoding,omitempty" protobuf:"bytes,5,opt,name=encoding,casttype=Encoding"`
+	Encoding *Encoding `json:"encoding,omitempty" yaml:"encoding,omitempty" protobuf:"bytes,4,opt,name=encoding,casttype=Encoding"`
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="preserveNamespace is immutable"
+	// +kubebuilder:default:=true
+	PreserveNamespace *bool `json:"preserveNamespace,omitempty" yaml:"preserveNamespace,omitempty" protobuf:"varint,5,opt,name=preserveNamespace"`
 }
 
 type DiscoveryPathDefinition struct {

artifacts/inv.sdcio.dev_discoveryvendorprofiles.yaml

@@ -83,6 +83,12 @@ spec:
                       - path
                       type: object
                     type: array
+                  preserveNamespace:
+                    default: true
+                    type: boolean
+                    x-kubernetes-validations:
+                    - message: preserveNamespace is immutable
+                      rule: self == oldSelf
                 required:
                 - organization
                 - paths

crds/inv.sdcio.dev_discoveryvendorprofiles.yaml

@@ -83,6 +83,12 @@ spec:
                       - path
                       type: object
                     type: array
+                  preserveNamespace:
+                    default: true
+                    type: boolean
+                    x-kubernetes-validations:
+                    - message: preserveNamespace is immutable
+                      rule: self == oldSelf
                 required:
                 - organization
                 - paths

example/discoveryvendor-profile/discoveryvendor-profile-arista.yaml

@@ -1,4 +1,4 @@
-# DO NOT UPDATE THESE FILES OR CHANGE THE NAME, RATHER CREATE NEW ONCE
+# DO NOT UPDATE THESE FILES OR CHANGE THE NAME, RATHER CREATE NEW ONES
 # These files have 2 purposes
 # 1. they serve as unit tests
 # 2. they can be used as discovery rules examples

example/discoveryvendor-profile/discoveryvendor-profile-cisco-iosxr.yaml

@@ -0,0 +1,26 @@
+# DO NOT UPDATE THESE FILES OR CHANGE THE NAME, RATHER CREATE NEW ONES
+# These files have 2 purposes
+# 1. they serve as unit tests
+# 2. they can be used as discovery rules examples
+####### HEADER END #######
+apiVersion: inv.sdcio.dev/v1alpha1
+kind: DiscoveryVendorProfile
+metadata:
+  name: iosxr.cisco.sdcio.dev
+  namespace: default
+spec:
+  gnmi:
+    organization: "Cisco Systems, Inc."
+    preserveNamespace: false
+    paths:
+    - key: version
+      path: system/state/software-version
+      regex: ^(\d+\.\d+\.\d+(?:\.\d+[\.\w]*)?)$
+    - key: platform
+      path: components/component[name=Rack 0]/state/part-no
+    - key: hostname
+      path: system/state/hostname
+    - key: serialNumber
+      path: components/component[name=Rack 0]/state/serial-no
+    - key: macAddress
+      path: interfaces/interface[name=MgmtEth0/RP0/CPU0/0]/openconfig-if-ethernet:ethernet/state/mac-address

example/discoveryvendor-profile/discoveryvendor-profile-nokia-srlinux.yaml

@@ -1,4 +1,4 @@
-# DO NOT UPDATE THESE FILES OR CHANGE THE NAME, RATHER CREATE NEW ONCE
+# DO NOT UPDATE THESE FILES OR CHANGE THE NAME, RATHER CREATE NEW ONES
 # These files have 2 purposes
 # 1. they serve as unit tests
 # 2. they can be used as discovery rules examples

example/discoveryvendor-profile/discoveryvendor-profile-nokia-sros.yaml

@@ -1,4 +1,4 @@
-# DO NOT UPDATE THESE FILES OR CHANGE THE NAME, RATHER CREATE NEW ONCE
+# DO NOT UPDATE THESE FILES OR CHANGE THE NAME, RATHER CREATE NEW ONES
 # These files have 2 purposes
 # 1. they serve as unit tests
 # 2. they can be used as discovery rules examples