fix: adding descriptions for device roles

bl4ko · Sep 2, 2024 · a363298 · a363298
1 parent 935f007
commit a363298
Show file tree

Hide file tree

Showing 9 changed files with 62 additions and 46 deletions.
diff --git a/internal/constants/constants.go b/internal/constants/constants.go
@@ -158,20 +158,25 @@ const (
 
 // Device Role constants.
 const (
-	DeviceRoleFirewall      = "Firewall"
-	DeviceRoleFirewallColor = "f57842"
+	DeviceRoleFirewall            = "Firewall"
+	DeviceRoleFirewallDescription = "Device role for marking firewall device."
+	DeviceRoleFirewallColor       = "f57842"
 
-	DeviceRoleSwitch      = "Switch"
-	DeviceRoleSwitchColor = "7aefea"
+	DeviceRoleSwitch            = "Switch"
+	DeviceRoleSwitchDescription = "Device role for marking switch device."
+	DeviceRoleSwitchColor       = "7aefea"
 
-	DeviceRoleServer      = "Server"
-	DeviceRoleServerColor = "00add8"
+	DeviceRoleServer            = "Server"
+	DeviceRoleServerDescription = "Device role for marking server."
+	DeviceRoleServerColor       = "00add8"
 
-	DeviceRoleContainer      = "Container"
-	DeviceRoleContainerColor = "0db7ed"
+	DeviceRoleContainer            = "Container"
+	DeviceRoleContainerDescription = "VM role for separating containers from VMs."
+	DeviceRoleContainerColor       = "0db7ed"
 
-	DeviceRoleVMTemplate      = "VM Template"
-	DeviceRoleVMTemplateColor = "82c1ea"
+	DeviceRoleVMTemplate            = "VM Template"
+	DeviceRoleVMTemplateDescription = "VM role for separating VM templates from VMs."
+	DeviceRoleVMTemplateColor       = "82c1ea"
 )
 
 // Constants used for variables in our contexts.

diff --git a/internal/netbox/objects/dcim.go b/internal/netbox/objects/dcim.go
@@ -117,6 +117,8 @@ type DeviceRole struct {
 	NetboxObject
 	// Name is the name of the device role. This field is required.
 	Name string `json:"name,omitempty"`
+	// Description is the description of the device Role.
+	Description string `json:"description,omitempty"`
 	// URL-friendly unique shorthand. This field is required.
 	Slug string `json:"slug,omitempty"`
 	// Color of the device role. This field is required.

diff --git a/internal/source/fmc/fmc_sync.go b/internal/source/fmc/fmc_sync.go
@@ -43,10 +43,11 @@ func (fmcs *FMCSource) syncDevices(nbi *inventory.NetboxInventory) error {
 			return fmt.Errorf("match host to tenant %s", err)
 		}
 		deviceRole, err := nbi.AddDeviceRole(fmcs.Ctx, &objects.DeviceRole{
-			Name:   constants.DeviceRoleFirewall,
-			Slug:   utils.Slugify(constants.DeviceRoleFirewall),
-			Color:  constants.DeviceRoleFirewallColor,
-			VMRole: false,
+			Name:        constants.DeviceRoleFirewall,
+			Description: constants.DeviceRoleFirewallDescription,
+			Slug:        utils.Slugify(constants.DeviceRoleFirewall),
+			Color:       constants.DeviceRoleFirewallColor,
+			VMRole:      false,
 		})
 		if err != nil {
 			return fmt.Errorf("add DeviceRole: %s", err)

diff --git a/internal/source/fortigate/fortigate_sync.go b/internal/source/fortigate/fortigate_sync.go
@@ -45,10 +45,11 @@ func (fs *FortigateSource) syncDevice(nbi *inventory.NetboxInventory) error {
 	}
 
 	deviceRole, err := nbi.AddDeviceRole(fs.Ctx, &objects.DeviceRole{
-		Name:   constants.DeviceRoleFirewall,
-		Slug:   utils.Slugify(constants.DeviceRoleFirewall),
-		Color:  constants.DeviceRoleFirewallColor,
-		VMRole: false,
+		Name:        constants.DeviceRoleFirewall,
+		Description: constants.DeviceRoleFirewallDescription,
+		Slug:        utils.Slugify(constants.DeviceRoleFirewall),
+		Color:       constants.DeviceRoleFirewallColor,
+		VMRole:      false,
 	})
 	if err != nil {
 		return fmt.Errorf("add DeviceRole: %s", err)

diff --git a/internal/source/ios-xe/iosxe_sync.go b/internal/source/ios-xe/iosxe_sync.go
@@ -40,10 +40,11 @@ func (is *IOSXESource) syncDevice(nbi *inventory.NetboxInventory) error {
 	}
 
 	deviceRole, err := nbi.AddDeviceRole(is.Ctx, &objects.DeviceRole{
-		Name:   constants.DeviceRoleSwitch,
-		Slug:   utils.Slugify(constants.DeviceRoleSwitch),
-		Color:  constants.DeviceRoleSwitchColor,
-		VMRole: false,
+		Name:        constants.DeviceRoleSwitch,
+		Description: constants.DeviceRoleSwitchDescription,
+		Slug:        utils.Slugify(constants.DeviceRoleSwitch),
+		Color:       constants.DeviceRoleSwitchColor,
+		VMRole:      false,
 	})
 	if err != nil {
 		return fmt.Errorf("add device role: %s", err)

diff --git a/internal/source/ovirt/ovirt_sync.go b/internal/source/ovirt/ovirt_sync.go
@@ -288,10 +288,11 @@ func (o *OVirtSource) syncHosts(nbi *inventory.NetboxInventory) error {
 		mem /= (constants.KiB * constants.KiB * constants.KiB) // Value is in Bytes, we convert to GB
 
 		hostDeviceRoleStruct := &objects.DeviceRole{
-			Name:   constants.DeviceRoleServer,
-			Slug:   utils.Slugify(constants.DeviceRoleServer),
-			Color:  constants.DeviceRoleServerColor,
-			VMRole: false,
+			Name:        constants.DeviceRoleServer,
+			Description: constants.DeviceRoleServerDescription,
+			Slug:        utils.Slugify(constants.DeviceRoleServer),
+			Color:       constants.DeviceRoleServerColor,
+			VMRole:      false,
 		}
 		hostDeviceRole, err := nbi.AddDeviceRole(o.Ctx, hostDeviceRoleStruct)
 		if err != nil {

diff --git a/internal/source/paloalto/paloalto_sync.go b/internal/source/paloalto/paloalto_sync.go
@@ -48,10 +48,11 @@ func (pas *PaloAltoSource) syncDevice(nbi *inventory.NetboxInventory) error {
 	}
 
 	deviceRoleStruct := &objects.DeviceRole{
-		Name:   constants.DeviceRoleFirewall,
-		Slug:   utils.Slugify(constants.DeviceRoleFirewall),
-		Color:  constants.DeviceRoleFirewallColor,
-		VMRole: false,
+		Name:        constants.DeviceRoleFirewall,
+		Description: constants.DeviceRoleFirewallDescription,
+		Slug:        utils.Slugify(constants.DeviceRoleFirewall),
+		Color:       constants.DeviceRoleFirewallColor,
+		VMRole:      false,
 	}
 	deviceRole, err := nbi.AddDeviceRole(pas.Ctx, deviceRoleStruct)
 	if err != nil {

diff --git a/internal/source/proxmox/proxmox_sync.go b/internal/source/proxmox/proxmox_sync.go
@@ -97,10 +97,11 @@ func (ps *ProxmoxSource) syncNodes(nbi *inventory.NetboxInventory) error {
 		}
 
 		deviceRoleStruct := &objects.DeviceRole{
-			Name:   constants.DeviceRoleServer,
-			Slug:   utils.Slugify(constants.DeviceRoleServer),
-			Color:  constants.DeviceRoleServerColor,
-			VMRole: false,
+			Name:        constants.DeviceRoleServer,
+			Description: constants.DeviceRoleServerDescription,
+			Slug:        utils.Slugify(constants.DeviceRoleServer),
+			Color:       constants.DeviceRoleServerColor,
+			VMRole:      false,
 		}
 		hostDeviceRole, err := nbi.AddDeviceRole(ps.Ctx, deviceRoleStruct)
 		if err != nil {
@@ -347,10 +348,11 @@ func (ps *ProxmoxSource) syncContainers(nbi *inventory.NetboxInventory) error {
 	if len(ps.Containers) > 0 {
 		// Create container role
 		containerRole, err := nbi.AddDeviceRole(ps.Ctx, &objects.DeviceRole{
-			Name:   constants.DeviceRoleContainer,
-			Slug:   utils.Slugify(constants.DeviceRoleContainer),
-			Color:  constants.DeviceRoleContainerColor,
-			VMRole: true,
+			Name:        constants.DeviceRoleContainer,
+			Description: constants.DeviceRoleContainerDescription,
+			Slug:        utils.Slugify(constants.DeviceRoleContainer),
+			Color:       constants.DeviceRoleContainerColor,
+			VMRole:      true,
 		})
 		if err != nil {
 			return fmt.Errorf("create container role: %s", err)

diff --git a/internal/source/vmware/vmware_sync.go b/internal/source/vmware/vmware_sync.go
@@ -250,10 +250,11 @@ func (vc *VmwareSource) syncHosts(nbi *inventory.NetboxInventory) error {
 		hostMemGB := host.Summary.Hardware.MemorySize / constants.KiB / constants.KiB / constants.KiB
 
 		deviceRoleStruct := &objects.DeviceRole{
-			Name:   constants.DeviceRoleServer,
-			Slug:   utils.Slugify(constants.DeviceRoleServer),
-			Color:  constants.DeviceRoleServerColor,
-			VMRole: false,
+			Name:        constants.DeviceRoleServer,
+			Description: constants.DeviceRoleServerDescription,
+			Slug:        utils.Slugify(constants.DeviceRoleServer),
+			Color:       constants.DeviceRoleServerColor,
+			VMRole:      false,
 		}
 		hostDeviceRole, err := nbi.AddDeviceRole(vc.Ctx, deviceRoleStruct)
 		if err != nil {
@@ -737,10 +738,11 @@ func (vc *VmwareSource) syncVM(nbi *inventory.NetboxInventory, vmKey string, vm
 	var templateRole *objects.DeviceRole
 	if isTemplate {
 		templateRoleStruct := &objects.DeviceRole{
-			Name:   constants.DeviceRoleVMTemplate,
-			Slug:   utils.Slugify(constants.DeviceRoleVMTemplate),
-			Color:  constants.DeviceRoleVMTemplateColor,
-			VMRole: true,
+			Name:        constants.DeviceRoleVMTemplate,
+			Description: constants.DeviceRoleVMTemplateDescription,
+			Slug:        utils.Slugify(constants.DeviceRoleVMTemplate),
+			Color:       constants.DeviceRoleVMTemplateColor,
+			VMRole:      true,
 		}
 		var err error
 		templateRole, err = nbi.AddDeviceRole(vc.Ctx, templateRoleStruct)