feat: move clusters from site to scope model

Author: fbreckle

netbox/data_source_netbox_cluster.go

@@ -52,6 +52,14 @@ func dataSourceNetboxCluster() *schema.Resource {
 				Computed: true,
 				Optional: true,
 			},
+			"scope_type": {
+				Type:         schema.TypeString,
+				Computed:     true,
+			},
+			"scope_id": {
+				Type:         schema.TypeInt,
+				Computed:     true,
+			},
 			"custom_fields": {
 				Type:     schema.TypeMap,
 				Computed: true,
@@ -110,11 +118,19 @@ func dataSourceNetboxClusterRead(d *schema.ResourceData, m interface{}) error {
 	}
 	d.Set("comments", result.Comments)
 	d.Set("description", result.Description)
-	if result.Site != nil {
-		d.Set("site_id", result.Site.ID)
+
+	if result.ScopeType != nil {
+		d.Set("scope_type", result.ScopeType)
 	} else {
-		d.Set("site_id", nil)
+		d.Set("scope_type", nil)
 	}
+
+	if result.ScopeID != nil {
+		d.Set("scope_id", result.ScopeID)
+	} else {
+		d.Set("scope_id", nil)
+	}
+
 	if result.CustomFields != nil {
 		d.Set("custom_fields", result.CustomFields)
 	}

netbox/data_source_netbox_devices_test.go

@@ -121,7 +121,8 @@ resource "netbox_cluster_type" "test" {
 resource "netbox_cluster" "test" {
   name = "%[1]s"
   cluster_type_id = netbox_cluster_type.test.id
-  site_id = netbox_site.test.id
+  scope_type = "dcim.site"
+  scope_id = netbox_site.test.id
 }
 
 resource "netbox_location" "test" {

netbox/resource_netbox_cluster.go

@@ -6,8 +6,11 @@ import (
 	"github.com/fbreckle/go-netbox/netbox/client/virtualization"
 	"github.com/fbreckle/go-netbox/netbox/models"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
 )
 
+var resourceNetboxClusterScopeTypeOptions = []string{"dcim.location", "dcim.site", "dcim.sitegroup", "dcim.region"}
+
 func resourceNetboxCluster() *schema.Resource {
 	return &schema.Resource{
 		Create: resourceNetboxClusterCreate,
@@ -16,7 +19,7 @@ func resourceNetboxCluster() *schema.Resource {
 		Delete: resourceNetboxClusterDelete,
 
 		Description: `:meta:subcategory:Virtualization:From the [official documentation](https://docs.netbox.dev/en/stable/features/virtualization/#clusters):
-
+TODO
 > A cluster is a logical grouping of physical resources within which virtual machines run. A cluster must be assigned a type (technological classification), and may optionally be assigned to a cluster group, site, and/or tenant. Each cluster must have a unique name within its assigned group and/or site, if any.
 >
 > Physical devices may be associated with clusters as hosts. This allows users to track on which host(s) a particular virtual machine may reside. However, NetBox does not support pinning a specific VM within a cluster to a particular host device.`,
@@ -42,14 +45,21 @@ func resourceNetboxCluster() *schema.Resource {
 				Type:     schema.TypeString,
 				Optional: true,
 			},
-			"site_id": {
-				Type:     schema.TypeInt,
-				Optional: true,
-			},
 			"tenant_id": {
 				Type:     schema.TypeInt,
 				Optional: true,
 			},
+			"scope_type": {
+				Type:         schema.TypeString,
+				Optional:     true,
+				ValidateFunc: validation.StringInSlice(resourceNetboxClusterScopeTypeOptions, false),
+				Description:  buildValidValueDescription(resourceNetboxClusterScopeTypeOptions),
+			},
+			"scope_id": {
+				Type:         schema.TypeInt,
+				Optional:     true,
+				RequiredWith: []string{"scope_type"},
+			},
 			tagsKey: tagsSchema,
 		},
 		Importer: &schema.ResourceImporter{
@@ -69,6 +79,14 @@ func resourceNetboxClusterCreate(d *schema.ResourceData, m interface{}) error {
 	clusterTypeID := int64(d.Get("cluster_type_id").(int))
 	data.Type = &clusterTypeID
 
+	if scopeType, ok := d.GetOk("scope_type"); ok {
+		data.ScopeType = strToPtr(scopeType.(string))
+	}
+
+	if scopeID, ok := d.GetOk("scope_id"); ok {
+		data.ScopeID = int64ToPtr(int64(scopeID.(int)))
+	}
+
 	if clusterGroupIDValue, ok := d.GetOk("cluster_group_id"); ok {
 		clusterGroupID := int64(clusterGroupIDValue.(int))
 		data.Group = &clusterGroupID
@@ -77,11 +95,6 @@ func resourceNetboxClusterCreate(d *schema.ResourceData, m interface{}) error {
 	data.Comments = getOptionalStr(d, "comments", false)
 	data.Description = getOptionalStr(d, "description", false)
 
-	if siteIDValue, ok := d.GetOk("site_id"); ok {
-		siteID := int64(siteIDValue.(int))
-		data.Site = &siteID
-	}
-
 	if tenantIDValue, ok := d.GetOk("tenant_id"); ok {
 		tenantID := int64(tenantIDValue.(int))
 		data.Tenant = &tenantID
@@ -121,28 +134,32 @@ func resourceNetboxClusterRead(d *schema.ResourceData, m interface{}) error {
 		return err
 	}
 
-	d.Set("name", res.GetPayload().Name)
-	d.Set("cluster_type_id", res.GetPayload().Type.ID)
+	cluster := res.GetPayload()
 
-	if res.GetPayload().Group != nil {
-		d.Set("cluster_group_id", res.GetPayload().Group.ID)
+	d.Set("name", cluster.Name)
+	d.Set("cluster_type_id", cluster.Type.ID)
+
+	if cluster.Group != nil {
+		d.Set("cluster_group_id", cluster.Group.ID)
 	} else {
 		d.Set("cluster_group_id", nil)
 	}
 
-	d.Set("comments", res.GetPayload().Comments)
-	d.Set("description", res.GetPayload().Description)
+	d.Set("comments", cluster.Comments)
+	d.Set("description", cluster.Description)
 
-	if res.GetPayload().Site != nil {
-		d.Set("site_id", res.GetPayload().Site.ID)
+	if cluster.Tenant != nil {
+		d.Set("tenant_id", cluster.Tenant.ID)
 	} else {
-		d.Set("site_id", nil)
+		d.Set("tenant_id", nil)
 	}
 
-	if res.GetPayload().Tenant != nil {
-		d.Set("tenant_id", res.GetPayload().Tenant.ID)
-	} else {
-		d.Set("tenant_id", nil)
+	if cluster.ScopeType != nil {
+		d.Set("scope_type", cluster.ScopeType)
+	}
+
+	if cluster.ScopeID != nil {
+		d.Set("scope_id", cluster.ScopeID)
 	}
 
 	api.readTags(d, res.GetPayload().Tags)
@@ -169,16 +186,19 @@ func resourceNetboxClusterUpdate(d *schema.ResourceData, m interface{}) error {
 	data.Comments = getOptionalStr(d, "comments", true)
 	data.Description = getOptionalStr(d, "description", true)
 
-	if siteIDValue, ok := d.GetOk("site_id"); ok {
-		siteID := int64(siteIDValue.(int))
-		data.Site = &siteID
-	}
-
 	if tenantIDValue, ok := d.GetOk("tenant_id"); ok {
 		tenantID := int64(tenantIDValue.(int))
 		data.Tenant = &tenantID
 	}
 
+	if scopeType, ok := d.GetOk("scope_type"); ok {
+		data.ScopeType = strToPtr(scopeType.(string))
+	}
+
+	if scopeID, ok := d.GetOk("scope_id"); ok {
+		data.ScopeID = int64ToPtr(int64(scopeID.(int)))
+	}
+
 	tags, _ := getNestedTagListFromResourceDataSet(api, d.Get(tagsAllKey))
 	data.Tags = tags