feat: create resource and data source for host configuration profiles (#2588)

spacegospod · tenthirtyam · web-flow · commit c79b4051319c · 2025-08-20T11:04:19.000-04:00
Signed-off-by: Stoyan Zhelyazkov &lt;stoyan.zhelyazkov@broadcom.com&gt;
Co-authored-by: Ryan Johnson &lt;ryan.johnson@broadcom.com&gt;
diff --git a/docs/data-sources/configuration_profile.md b/docs/data-sources/configuration_profile.md
@@ -0,0 +1,43 @@
+---
+subcategory: "Host and Cluster Management"
+page_title: "VMware vSphere: vsphere_configuration_profile"
+sidebar_current: "docs-vsphere-data-source-config-profile"
+description: |-
+  Provides a vSphere cluster configuration profile data source.
+---
+
+# vsphere_configuration_profile
+
+The `vsphere_configuration_profile` data source can be used to export the configuration and schema
+of a cluster that is already managed via configuration profiles.
+
+## Example Usage
+
+```hcl
+data "vsphere_datacenter" "datacenter" {
+  name = "dc-01"
+}
+
+data "vsphere_compute_cluster" "compute_cluster" {
+  name          = "cluster-01"
+  datacenter_id = data.vsphere_datacenter.datacenter.id
+}
+
+data "vsphere_configuration_profile" "profile" {
+  cluster_id = data.vsphere_compute_cluster.compute_cluster.id
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `cluster_id` - (Required) The identifier of the compute cluster.
+
+## Attribute Reference
+
+The following attributes are exported:
+
+* `id` - A custom identifier for the profile. The value for this attribute is constructed using the `cluster_id` in the following format - `configuration_profile_${cluster_id}`.
+* `schema`- The JSON schema for the profile.
+* `configuration` - The current configuration which is active on the cluster.
diff --git a/docs/resources/configuration_profile.md b/docs/resources/configuration_profile.md
@@ -0,0 +1,114 @@
+---
+subcategory: "Host and Cluster Management"
+page_title: "VMware vSphere: vsphere_configuration_profile"
+sidebar_current: "docs-vsphere-resource-config-profile"
+description: |-
+  Provides a vSphere cluster configuration profile resource.
+---
+
+# vsphere_configuration_profile
+
+The `vsphere_configuration_profile` resource can be used to configure profile-based host management on a vSphere compute cluster.
+The source for the configuration can either be a ESXi host that is part of the compute cluster or a JSON file, but not both at the same time.
+
+It is allowed to switch from one type of configuration source to the other at any time.
+
+Deleting a `vsphere_configuration_profile` resource has no effect on the compute cluster. Once management via configuration
+profiles is turned ot it is not possible to disable it.
+
+~> **NOTE:** This resource requires a vCenter 8 or higher and will not work on
+direct ESXi connections.
+
+## Example Usage
+
+### Creating a profile using an ESXi host as a reference
+
+The following example sets up a configuration profile on a compute cluster using one of its hosts as a reference
+and then propagates that configuration to two additional clusters.
+
+Note that this example assumes that the hosts across all three clusters are compatible with the source configuration. 
+This includes but is not limited to their ESXi versions and hardware capabilities.
+
+```hcl
+data "vsphere_datacenter" "datacenter" {
+  name = "dc-01"
+}
+
+data "vsphere_compute_cluster" "cluster1" {
+  name          = "cluster-01"
+  datacenter_id = data.vsphere_datacenter.datacenter.id
+}
+
+data "vsphere_compute_cluster" "cluster2" {
+  name          = "cluster-02"
+  datacenter_id = data.vsphere_datacenter.datacenter.id
+}
+
+data "vsphere_compute_cluster" "cluster3" {
+  name          = "cluster-03"
+  datacenter_id = data.vsphere_datacenter.datacenter.id
+}
+
+# This host is assumed to be part of "cluster-01"
+data "vsphere_host" "host" {
+  name          = "esxi-01.example.com"
+  datacenter_id = data.vsphere_datacenter.datacenter.id
+}
+
+# Configure a profile on "cluster-01" using one of its hosts as a reference
+resource "vsphere_configuration_profile" "profile1" {
+  cluster_id        = data.vsphere_compute_cluster.cluster1.id
+  reference_host_id = data.vsphere_host.host.id
+}
+
+# Copy the configuration of "cluster-01" onto "cluster-02"
+resource "vsphere_configuration_profile" "profile2" {
+  cluster_id    = data.vsphere_compute_cluster.cluster2.id
+  configuration = vsphere_configuration_profile.profile1.configuration
+}
+
+# Copy the configuration of "cluster-01" onto "cluster-03"
+resource "vsphere_configuration_profile" "profile3" {
+  cluster_id    = data.vsphere_compute_cluster.cluster3.id
+  configuration = vsphere_configuration_profile.profile1.configuration
+}
+```
+
+### Creating a profile using a configuration file
+
+This example sets up a configuration profile on a cluster by reading a configuration from a JSON
+file on the local filesystem. Reading files is natively supported by Terraform.
+
+```hcl
+data "vsphere_datacenter" "datacenter" {
+  name = "dc-01"
+}
+
+data "vsphere_compute_cluster" "cluster1" {
+  name          = "cluster-01"
+  datacenter_id = data.vsphere_datacenter.datacenter.id
+}
+
+resource "vsphere_configuration_profile" "profile1" {
+  cluster_id    = data.vsphere_compute_cluster.cluster1.id
+  configuration = file("/path/to/cluster_config_1.json")
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `cluster_id` - (Required) The identifier of the cluster.
+* `reference_host_id` - (Optional) The identifier of the host to use as a configuration source.
+The host needs to be a member of the cluster identified by `cluster_id`. This argument can only be specified if
+`configuration` is not set.
+* `configuration` - (Optional) The configuration JSON provided as a plain string. This argument can only be specified if `reference_host_id` is not set.
+
+## Attribute Reference
+
+The following attributes are exported:
+
+* `id` - A custom identifier for the profile. The value for this attribute is constructed using the `cluster_id` in the following format - `configuration_profile_${cluster_id}`.
+* `schema`- The JSON schema for the profile.
+* `configuration` - The current configuration which is active on the cluster.
diff --git a/vsphere/data_source_vsphere_configuration_profile.go b/vsphere/data_source_vsphere_configuration_profile.go
@@ -0,0 +1,41 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
+package vsphere
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/vmware/terraform-provider-vsphere/vsphere/internal/helper/configprofile"
+)
+
+func dataSourceVSphereConfigurationProfile() *schema.Resource {
+	return &schema.Resource{
+		ReadContext: dataSourceVSphereConfigurationProfileRead,
+		Schema: map[string]*schema.Schema{
+			"configuration": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The configuration JSON.",
+			},
+			"schema": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The configuration schema.",
+			},
+			"cluster_id": {
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "The identifier of the cluster.",
+			},
+		},
+	}
+}
+
+func dataSourceVSphereConfigurationProfileRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*Client).restClient
+	return configprofile.ReadConfigProfile(ctx, client, d)
+}
diff --git a/vsphere/data_source_vsphere_configuration_profile_test.go b/vsphere/data_source_vsphere_configuration_profile_test.go
@@ -0,0 +1,78 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
+package vsphere
+
+import (
+	"fmt"
+	"os"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+	"github.com/vmware/terraform-provider-vsphere/vsphere/internal/helper/testhelper"
+)
+
+func TestAccDataSourceVSphereConfigProfile(t *testing.T) {
+	// Run this test manually, do not include in automated testing
+	t.Skipf("Skipped due to cleanup problems - https://github.com/vmware/terraform-provider-vsphere/issues/2543")
+	resource.Test(t, resource.TestCase{
+		PreCheck: func() {
+			RunSweepers()
+			testAccPreCheck(t)
+		},
+		Providers: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccDataSourceVSphereConfigProfileConfig(),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttrSet("data.vsphere_config_profile.profile2", "config"),
+					resource.TestCheckResourceAttrSet("data.vsphere_config_profile.profile2", "schema"),
+				),
+			},
+		},
+	})
+}
+
+func testAccDataSourceVSphereConfigProfileConfig() string {
+	return fmt.Sprintf(`
+%s
+
+data "vsphere_host_thumbprint" "thumbprint" {
+  address  = "%s"
+  insecure = true
+}
+
+resource "vsphere_host" "h1" {
+  hostname = "%s"
+  username = "root"
+  password = "%s"
+  thumbprint = data.vsphere_host_thumbprint.thumbprint.id
+
+  datacenter = data.vsphere_datacenter.rootdc1.id
+
+  lifecycle {
+    ignore_changes = ["services"]
+  }
+}
+
+resource "vsphere_compute_cluster" "cluster1" {
+  name            = "cluster1"
+  datacenter_id   = data.vsphere_datacenter.rootdc1.id
+  host_system_ids = [vsphere_host.h1.id]
+}
+
+resource "vsphere_configuration_profile" "profile1" {
+  reference_host_id = vsphere_host.h1.id
+  cluster_id = vsphere_compute_cluster.cluster1.id
+}
+
+data "vsphere_configuration_profile" "profile2" {
+  cluster_id = vsphere_config_profile.profile1.cluster_id
+}
+`,
+		testhelper.ConfigDataRootDC1(),
+		os.Getenv("TF_VAR_VSPHERE_ESXI4"),
+		os.Getenv("TF_VAR_VSPHERE_ESXI4"),
+		os.Getenv("TF_VAR_VSPHERE_ESXI4_PASSWORD"))
+}
diff --git a/vsphere/internal/helper/configprofile/config_profile_helper.go b/vsphere/internal/helper/configprofile/config_profile_helper.go
@@ -0,0 +1,42 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
+package configprofile
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/hashicorp/terraform-plugin-log/tflog"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/vmware/govmomi/vapi/esx/settings/clusters/configuration"
+	"github.com/vmware/govmomi/vapi/rest"
+)
+
+func ReadConfigProfile(ctx context.Context, client *rest.Client, d *schema.ResourceData) diag.Diagnostics {
+	m := configuration.NewManager(client)
+
+	clusterID := d.Get("cluster_id").(string)
+
+	d.SetId(fmt.Sprintf("config_profile_%s", clusterID))
+
+	tflog.Debug(ctx, fmt.Sprintf("reading configuration for cluster: %s", clusterID))
+	config, err := m.GetConfiguration(clusterID)
+	if err != nil {
+		return diag.FromErr(fmt.Errorf("failed to retrieve cluster configuration: %s", err))
+	}
+
+	_ = d.Set("configuration", config.Config)
+
+	tflog.Debug(ctx, fmt.Sprintf("reading configuration schema for cluster: %s", clusterID))
+	configSchema, err := m.GetSchema(clusterID)
+	if err != nil {
+		return diag.FromErr(fmt.Errorf("failed to retrieve configuration schema: %s", err))
+	}
+
+	_ = d.Set("schema", configSchema.Schema)
+
+	return nil
+}
diff --git a/vsphere/provider.go b/vsphere/provider.go
@@ -110,6 +110,7 @@ func Provider() *schema.Provider {
 			"vsphere_compute_cluster_vm_dependency_rule":       resourceVSphereComputeClusterVMDependencyRule(),
 			"vsphere_compute_cluster_vm_group":                 resourceVSphereComputeClusterVMGroup(),
 			"vsphere_compute_cluster_vm_host_rule":             resourceVSphereComputeClusterVMHostRule(),
+			"vsphere_configuration_profile":                    resourceVSphereConfigurationProfile(),
 			"vsphere_content_library":                          resourceVSphereContentLibrary(),
 			"vsphere_content_library_item":                     resourceVSphereContentLibraryItem(),
 			"vsphere_custom_attribute":                         resourceVSphereCustomAttribute(),
@@ -152,6 +153,7 @@ func Provider() *schema.Provider {
 		DataSourcesMap: map[string]*schema.Resource{
 			"vsphere_compute_cluster":            dataSourceVSphereComputeCluster(),
 			"vsphere_compute_cluster_host_group": dataSourceVSphereComputeClusterHostGroup(),
+			"vsphere_configuration_profile":      dataSourceVSphereConfigurationProfile(),
 			"vsphere_content_library":            dataSourceVSphereContentLibrary(),
 			"vsphere_content_library_item":       dataSourceVSphereContentLibraryItem(),
 			"vsphere_custom_attribute":           dataSourceVSphereCustomAttribute(),
diff --git a/vsphere/resource_vsphere_configuration_profile.go b/vsphere/resource_vsphere_configuration_profile.go
diff --git a/vsphere/resource_vsphere_configuration_profile_test.go b/vsphere/resource_vsphere_configuration_profile_test.go
