feat: [CCM-26311]: Support disabled field through terraform (#1301)

shivam-thakur12 · Harness · commit 4499a2e4f8f2 · 2025-10-08T05:15:00.000Z
* ebec10 documentation updated

* 0b1fa9 sdk version update

* dd50fc add disabled in example

* 815f4d add disabled in data source

* 78aaf1 tests

* ad77b9 add disabled field support in resource
diff --git a/docs/data-sources/cluster_orchestrator_config.md b/docs/data-sources/cluster_orchestrator_config.md
@@ -29,6 +29,7 @@ data "harness_cluster_orchestrator_config" "example" {
 
 - `binpacking` (Block List, Max: 1) Binpacking preferences for Cluster Orchestrator (see [below for nested schema](#nestedblock--binpacking))
 - `commitment_integration` (Block List, Max: 1) Commitment integration configuration for Cluster Orchestrator (see [below for nested schema](#nestedblock--commitment_integration))
+- `disabled` (Boolean) Whether the cluster orchestrator is disabled
 - `distribution` (Block List, Max: 1) Spot and Ondemand Distribution Preferences for workload replicas (see [below for nested schema](#nestedblock--distribution))
 - `node_preferences` (Block List, Max: 1) Node preferences for Cluster Orchestrator (see [below for nested schema](#nestedblock--node_preferences))
 - `replacement_schedule` (Block List, Max: 1) Replacement schedule for Cluster Orchestrator (see [below for nested schema](#nestedblock--replacement_schedule))
diff --git a/docs/resources/cluster_orchestrator_config.md b/docs/resources/cluster_orchestrator_config.md
@@ -15,6 +15,7 @@ Resource for ClusterOrchestrator Config.
 ```terraform
 resource "harness_cluster_orchestrator_config" "example" {
   orchestrator_id = "orch-cvifpfl9rbg8neldj97g"
+  disabled        = false # Set to true to disable the orchestrator
   distribution {
     base_ondemand_capacity      = 2
     ondemand_replica_percentage = 50
@@ -83,6 +84,7 @@ resource "harness_cluster_orchestrator_config" "example" {
 
 - `binpacking` (Block List, Max: 1) Binpacking preferences for Cluster Orchestrator (see [below for nested schema](#nestedblock--binpacking))
 - `commitment_integration` (Block List, Max: 1) Commitment integration configuration for Cluster Orchestrator (see [below for nested schema](#nestedblock--commitment_integration))
+- `disabled` (Boolean) Whether the cluster orchestrator is disabled
 - `node_preferences` (Block List, Max: 1) Node preferences for Cluster Orchestrator (see [below for nested schema](#nestedblock--node_preferences))
 - `replacement_schedule` (Block List, Max: 1) Replacement schedule for Cluster Orchestrator (see [below for nested schema](#nestedblock--replacement_schedule))
 
diff --git a/examples/resources/harness_cluster_orchestrator_config/resource.tf b/examples/resources/harness_cluster_orchestrator_config/resource.tf
@@ -1,5 +1,6 @@
 resource "harness_cluster_orchestrator_config" "example" {
   orchestrator_id = "orch-cvifpfl9rbg8neldj97g"
+  disabled        = false # Set to true to disable the orchestrator
   distribution {
     base_ondemand_capacity      = 2
     ondemand_replica_percentage = 50
diff --git a/internal/service/platform/cluster_orchestrator/clusterorch_config_data_source.go b/internal/service/platform/cluster_orchestrator/clusterorch_config_data_source.go
@@ -22,6 +22,11 @@ func DataSourceClusterOrchestratorConfig() *schema.Resource {
 				Type:        schema.TypeString,
 				Required:    true,
 			},
+			"disabled": {
+				Description: "Whether the cluster orchestrator is disabled",
+				Type:        schema.TypeBool,
+				Optional:    true,
+			},
 			"distribution": {
 				Description: "Spot and Ondemand Distribution Preferences for workload replicas",
 				Type:        schema.TypeList,
diff --git a/internal/service/platform/cluster_orchestrator/clusterorch_config_resource.go b/internal/service/platform/cluster_orchestrator/clusterorch_config_resource.go
@@ -53,6 +53,12 @@ func ResourceClusterOrchestratorConfig() *schema.Resource {
 				Type:        schema.TypeString,
 				Required:    true,
 			},
+			"disabled": {
+				Description: "Whether the cluster orchestrator is disabled",
+				Type:        schema.TypeBool,
+				Optional:    true,
+				Default:     false,
+			},
 			"distribution": {
 				Description: "Spot and Ondemand Distribution Preferences for workload replicas",
 				Type:        schema.TypeList,
@@ -403,13 +409,27 @@ func resourceClusterOrchestratorConfigCreateOrUpdate(ctx context.Context, d *sch
 		return helpers.HandleApiError(err, d, httpResp)
 	}
 
-	if resp.Success != true {
+	if !resp.Success {
 		return diag.Errorf(strings.Join(resp.Errors, ","))
 	}
+
+	disabled := d.Get("disabled").(bool)
+	if diags := updateClusterOrchestratorStatus(ctx, c, orchID, disabled); diags.HasError() {
+		return diags
+	}
+
 	d.SetId(orchID)
 	return nil
 }
 
+func updateClusterOrchestratorStatus(ctx context.Context, c *nextgen.APIClient, orchID string, disabled bool) diag.Diagnostics {
+	_, httpResp, err := c.CloudCostClusterOrchestratorApi.ToggleClusterOrchestratorState(ctx, c.AccountId, orchID, disabled)
+	if err != nil {
+		return helpers.HandleApiError(err, nil, httpResp)
+	}
+	return nil
+}
+
 func resourceClusterOrchestratorConfigDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	return nil
 }
diff --git a/internal/service/platform/cluster_orchestrator/clusterorch_config_test.go b/internal/service/platform/cluster_orchestrator/clusterorch_config_test.go
@@ -19,7 +19,41 @@ func TestResourceClusterOrchestratorConfig(t *testing.T) {
 			{
 				Config: testClusterOrchConfig(orchID),
 				Check: resource.ComposeTestCheckFunc(
-					resource.TestCheckResourceAttr(resourceName, "orchID", orchID),
+					resource.TestCheckResourceAttr(resourceName, "orchestrator_id", orchID),
+					resource.TestCheckResourceAttr(resourceName, "disabled", "false"),
+				),
+			},
+		},
+	})
+}
+
+func TestResourceClusterOrchestratorConfigDisabled(t *testing.T) {
+	orchID := "terraform-clusterorch-disabled-test"
+	resourceName := "harness_cluster_orchestrator_config.test"
+
+	resource.UnitTest(t, resource.TestCase{
+		PreCheck:          func() { acctest.TestAccPreCheck(t) },
+		ProviderFactories: acctest.ProviderFactories,
+		Steps: []resource.TestStep{
+			{
+				Config: testClusterOrchConfigDisabled(orchID, false),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr(resourceName, "orchestrator_id", orchID),
+					resource.TestCheckResourceAttr(resourceName, "disabled", "false"),
+				),
+			},
+			{
+				Config: testClusterOrchConfigDisabled(orchID, true),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr(resourceName, "orchestrator_id", orchID),
+					resource.TestCheckResourceAttr(resourceName, "disabled", "true"),
+				),
+			},
+			{
+				Config: testClusterOrchConfigDisabled(orchID, false),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr(resourceName, "orchestrator_id", orchID),
+					resource.TestCheckResourceAttr(resourceName, "disabled", "false"),
 				),
 			},
 		},
@@ -30,6 +64,7 @@ func testClusterOrchConfig(orchID string) string {
 	return fmt.Sprintf(`
 	resource "harness_cluster_orchestrator_config" "test" {
 		orchestrator_id = "%s"
+		disabled        = false
 		distribution {
 			base_ondemand_capacity = 1
             ondemand_replica_percentage = 60
@@ -90,3 +125,69 @@ func testClusterOrchConfig(orchID string) string {
 	}
 `, orchID)
 }
+
+func testClusterOrchConfigDisabled(orchID string, disabled bool) string {
+	return fmt.Sprintf(`
+	resource "harness_cluster_orchestrator_config" "test" {
+		orchestrator_id = "%s"
+		disabled        = %t
+		distribution {
+			base_ondemand_capacity = 1
+            ondemand_replica_percentage = 60
+            selector = "ALL"
+            strategy = "COST OPTIMIZED"
+		}
+		binpacking {
+            pod_eviction {
+				threshold {
+					cpu = 60
+					memory = 80
+				}
+			}
+			disruption {
+				criteria = "EmptyOrUnderUtilized"
+                delay = "10m"
+                budget {
+                	reasons = ["Drift","UnderUtilized","Empty"]
+                    nodes = "20"
+					schedule {
+						frequency = "@daily"
+						duration = "10m"
+					}
+                }
+				budget {
+                	reasons = ["Drift","Empty"]
+                    nodes = "1"
+					schedule {
+						frequency = "@monthly"
+						duration = "10m"
+					}
+                }
+			}
+		}
+		node_preferences {
+			ttl = "1h"
+            reverse_fallback_interval = "6h"
+		} 
+		commitment_integration {
+			enabled           = true
+			master_account_id = "dummyAccountId"
+		}
+		replacement_schedule {
+			window_type = "Custom"
+			applies_to {
+			  consolidation        = true
+			  harness_pod_eviction = true
+			  reverse_fallback     = true
+			}
+			window_details {
+			  days       = ["SUN", "WED", "SAT"]
+			  time_zone  = "Asia/Calcutta"
+			  all_day    = false
+			  start_time = "10:30"
+			  end_time   = "11:30"
+			}
+		}
+	}
+`, orchID, disabled)
+}
diff --git a/internal/service/platform/cluster_orchestrator/service.go b/internal/service/platform/cluster_orchestrator/service.go
@@ -191,6 +191,7 @@ func parseTimeInDay(timeInDayStr string, defaultTimeInDay nextgen.TimeInDayForWi
 
 func readClusterOrchConfig(d *schema.ResourceData, orch *nextgen.ClusterOrchestrator) {
 	d.SetId(orch.ID)
+	d.Set("disabled", orch.Disabled)
 	d.Set("distribution", []interface{}{map[string]interface{}{
 		"base_ondemand_capacity":      orch.Config.BaseOnDemandCapacity,
 		"ondemand_replica_percentage": orch.Config.OnDemandSplit,
