Add description field to VMs, Devices, Clusters Resource/Data

[tagur87]

We were missing the ability to add a descriptions to devices, VMs, and
clusters. There are also corresponding data sources that do not have the
description field.

These fields were not available prior to netbox 3.4.3.

This adds the description field, following the example of the comment
field. The code was also slightly modified to be simpler to understand.

[fbreckle]

Note that, for VM things, you might also have to update the primary_ip_address resource.
I think right now the primary ip will just update the whole VM with all its attributes. Possibly this behavior can be fixed by using the Partial version of the api in

terraform-provider-netbox/netbox/resource_netbox_primary_ip.go

Line 162 in 6434dee

_, err = api.Virtualization.VirtualizationVirtualMachinesUpdate(updateParams, nil)

[tagur87]

Note that, for VM things, you might also have to update the primary_ip_address resource. I think right now the primary ip will just update the whole VM with all its attributes. Possibly this behavior can be fixed by using the Partial version of the api in

terraform-provider-netbox/netbox/resource_netbox_primary_ip.go

Line 162 in 6434dee

_, err = api.Virtualization.VirtualizationVirtualMachinesUpdate(updateParams, nil)

I had actually started to play with that. If we want to use partial, we may have to use omitempty on the parameter structs more, so that only the fields we want are sent.

[tagur87]

@fbreckle - i have updated this per your recommendation. Can you please review now?

[fbreckle]

Tests are failing

[tagur87]

Tests are failing

Yes but only on old versions. It works fine on newest version of netbox. Not sure what the difference could be?

[fbreckle]

Maybe similar to this? #427
I.e. the field was just not there in older versions? :D

[tagur87]

Maybe similar to this? #427 I.e. the field was just not there in older versions? :D

Gotcha....

according to netbox-community/netbox#11488 there were lots of description fields missing in the API. It was fixed in 3.4.3 it seems.

I agree the versioning problem is hard...seems like we should be able to release a new version with compatibility for version 3.4.3 and above, or something like that, and remove the tests for older versions. If people are running older netbox versions, they need to use the older provider.

[fbreckle]

Yes, that's the general idea. But that also means that people using older provider versions miss some features and bugfixes, so I do not want to cut them off just willy-nilly.
Since several resources are affected now and we can go ahead as you suggested. I plan to implement 3.5 support with 4.0, so that will be another cutoff anyway.

[tagur87]

Yes, that's the general idea. But that also means that people using older provider versions miss some features and bugfixes, so I do not want to cut them off just willy-nilly.
Since several resources are affected now and we can go ahead as you suggested. I plan to implement 3.5 support with 4.0, so that will be another cutoff anyway.

Ok, sounds good. I can submit a PR to remove the old versions and will see if there are other description fields missing that I can update at the same time as well.

[tagur87]

depends on #433

[fbreckle]

With #433 merged, bump.

[tagur87]

@fbreckle - all tests have passed.

[tagur87]

Sorry about all the tab issues! Vscode being dumb.

[tagur87]

@fbreckle - i added few things to this. It should be ready now.