Issue667 - Add global_data_tags to fleet agent policies

CHANGELOG.md

@@ -8,6 +8,7 @@
 - Fix namespaces inconsistency when creating elasticstack_kibana_data_view resources ([#1011](https://github.com/elastic/terraform-provider-elasticstack/pull/1011))
 - Update rule ID documentation. ([#1047](https://github.com/elastic/terraform-provider-elasticstack/pull/1047))
 - Mark `elasticstack_kibana_action_connector.secrets` as sensitive. ([#1045](https://github.com/elastic/terraform-provider-elasticstack/pull/1045))
+- Add `global_data_tags` to fleet agent policies. ([#1044](https://github.com/elastic/terraform-provider-elasticstack/pull/1044))
 
 ## [0.11.13] - 2025-01-09
 

docs/resources/fleet_agent_policy.md

@@ -24,6 +24,15 @@ resource "elasticstack_fleet_agent_policy" "test_policy" {
   sys_monitoring  = true
   monitor_logs    = true
   monitor_metrics = true
+
+  global_data_tags = {
+    first_tag = {
+      string_value = "tag_value"
+    },
+    second_tag = {
+      number_value = 1.2
+    }
+  }
 }
 ```
 
@@ -41,6 +50,7 @@ resource "elasticstack_fleet_agent_policy" "test_policy" {
 - `description` (String) The description of the agent policy.
 - `download_source_id` (String) The identifier for the Elastic Agent binary download server.
 - `fleet_server_host_id` (String) The identifier for the Fleet server host.
+- `global_data_tags` (Attributes Map) User-defined data tags to apply to all inputs. Values can be strings (string_value) or numbers (number_value) but not both. Example -- key1 = {string_value = value1}, key2 = {number_value = 42} (see [below for nested schema](#nestedatt--global_data_tags))
 - `monitor_logs` (Boolean) Enable collection of agent logs.
 - `monitor_metrics` (Boolean) Enable collection of agent metrics.
 - `monitoring_output_id` (String) The identifier for monitoring output.
@@ -52,6 +62,14 @@ resource "elasticstack_fleet_agent_policy" "test_policy" {
 
 - `id` (String) The ID of this resource.
 
+<a id="nestedatt--global_data_tags"></a>
+### Nested Schema for `global_data_tags`
+
+Optional:
+
+- `number_value` (Number) Number value for the field. If this is set, string_value must not be defined.
+- `string_value` (String) String value for the field. If this is set, number_value must not be defined.
+
 ## Import
 
 Import is supported using the following syntax:

examples/resources/elasticstack_fleet_agent_policy/resource.tf

@@ -9,4 +9,13 @@ resource "elasticstack_fleet_agent_policy" "test_policy" {
   sys_monitoring  = true
   monitor_logs    = true
   monitor_metrics = true
+
+  global_data_tags = {
+    first_tag = {
+      string_value = "tag_value"
+    },
+    second_tag = {
+      number_value = 1.2
+    }
+  }
 }

generated/kbapi/transform_schema.go

@@ -838,6 +838,12 @@ func transformFleetPaths(schema *Schema) {
 		agentPolicyPath.Put.Set(fmt.Sprintf("requestBody.content.application/json.schema.properties.%s.x-omitempty", key), true)
 	}
 
+	schema.Components.CreateRef(schema, "agent_policy_global_data_tags_item", "schemas.agent_policy.properties.global_data_tags.items")
+
+	// Define the value types for the GlobalDataTags
+	agentPoliciesPath.Post.Set("requestBody.content.application/json.schema.properties.global_data_tags.items.$ref", "#/components/schemas/agent_policy_global_data_tags_item")
+	agentPolicyPath.Put.Set("requestBody.content.application/json.schema.properties.global_data_tags.items.$ref", "#/components/schemas/agent_policy_global_data_tags_item")
+
 	// Enrollment api keys
 	// https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts
 	// https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts

internal/fleet/agent_policy/create.go

@@ -22,7 +22,16 @@ func (r *agentPolicyResource) Create(ctx context.Context, req resource.CreateReq
 		return
 	}
 
-	body := planModel.toAPICreateModel()
+	sVersion, e := r.client.ServerVersion(ctx)
+	if e != nil {
+		return
+	}
+
+	body, diags := planModel.toAPICreateModel(ctx, sVersion)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
 
 	sysMonitoring := planModel.SysMonitoring.ValueBool()
 	policy, diags := fleet.CreateAgentPolicy(ctx, client, body, sysMonitoring)
@@ -31,7 +40,11 @@ func (r *agentPolicyResource) Create(ctx context.Context, req resource.CreateReq
 		return
 	}
 
-	planModel.populateFromAPI(policy)
+	diags = planModel.populateFromAPI(ctx, policy)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
 
 	resp.State.Set(ctx, planModel)
 	resp.Diagnostics.Append(diags...)

internal/fleet/agent_policy/models.go

@@ -1,13 +1,25 @@
 package agent_policy
 
 import (
+	"context"
+	"fmt"
 	"slices"
 
 	"github.com/elastic/terraform-provider-elasticstack/generated/kbapi"
 	"github.com/elastic/terraform-provider-elasticstack/internal/utils"
+
+	"github.com/hashicorp/go-version"
+	"github.com/hashicorp/terraform-plugin-framework/attr"
+	"github.com/hashicorp/terraform-plugin-framework/diag"
+	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 )
 
+type globalDataTagsItemModel struct {
+	StringValue types.String  `tfsdk:"string_value"`
+	NumberValue types.Float32 `tfsdk:"number_value"`
+}
+
 type agentPolicyModel struct {
 	ID                 types.String `tfsdk:"id"`
 	PolicyID           types.String `tfsdk:"policy_id"`
@@ -22,11 +34,12 @@ type agentPolicyModel struct {
 	MonitorMetrics     types.Bool   `tfsdk:"monitor_metrics"`
 	SysMonitoring      types.Bool   `tfsdk:"sys_monitoring"`
 	SkipDestroy        types.Bool   `tfsdk:"skip_destroy"`
+	GlobalDataTags     types.Map    `tfsdk:"global_data_tags"` //> globalDataTagsModel
 }
 
-func (model *agentPolicyModel) populateFromAPI(data *kbapi.AgentPolicy) {
+func (model *agentPolicyModel) populateFromAPI(ctx context.Context, data *kbapi.AgentPolicy) diag.Diagnostics {
 	if data == nil {
-		return
+		return nil
 	}
 
 	model.ID = types.StringValue(data.Id)
@@ -54,10 +67,39 @@ func (model *agentPolicyModel) populateFromAPI(data *kbapi.AgentPolicy) {
 	model.MonitoringOutputId = types.StringPointerValue(data.MonitoringOutputId)
 	model.Name = types.StringValue(data.Name)
 	model.Namespace = types.StringValue(data.Namespace)
+	if utils.Deref(data.GlobalDataTags) != nil {
+		diags := diag.Diagnostics{}
+		var map0 = make(map[string]globalDataTagsItemModel)
+		for _, v := range utils.Deref(data.GlobalDataTags) {
+			maybeFloat, error := v.Value.AsAgentPolicyGlobalDataTagsItemValue1()
+			if error != nil {
+				maybeString, error := v.Value.AsAgentPolicyGlobalDataTagsItemValue0()
+				if error != nil {
+					diags.AddError("Failed to unmarshal global data tags", error.Error())
+				}
+				map0[v.Name] = globalDataTagsItemModel{
+					StringValue: types.StringValue(maybeString),
+				}
+			} else {
+				map0[v.Name] = globalDataTagsItemModel{
+					NumberValue: types.Float32Value(float32(maybeFloat)),
+				}
+			}
+		}
+
+		model.GlobalDataTags = utils.MapValueFrom(ctx, map0, getGlobalDataTagsAttrTypes().(attr.TypeWithElementType).ElementType(), path.Root("global_data_tags"), &diags)
+		if diags.HasError() {
+			return diags
+		}
+
+	}
+
+	return nil
 }
 
-func (model agentPolicyModel) toAPICreateModel() kbapi.PostFleetAgentPoliciesJSONRequestBody {
+func (model *agentPolicyModel) toAPICreateModel(ctx context.Context, serverVersion *version.Version) (kbapi.PostFleetAgentPoliciesJSONRequestBody, diag.Diagnostics) {
 	monitoring := make([]kbapi.PostFleetAgentPoliciesJSONBodyMonitoringEnabled, 0, 2)
+
 	if model.MonitorLogs.ValueBool() {
 		monitoring = append(monitoring, kbapi.PostFleetAgentPoliciesJSONBodyMonitoringEnabledLogs)
 	}
@@ -77,10 +119,47 @@ func (model agentPolicyModel) toAPICreateModel() kbapi.PostFleetAgentPoliciesJSO
 		Namespace:          model.Namespace.ValueString(),
 	}
 
-	return body
+	if len(model.GlobalDataTags.Elements()) > 0 {
+		var diags diag.Diagnostics
+		if serverVersion.LessThan(MinVersionGlobalDataTags) {
+			diags.AddError("global_data_tags ES version error", fmt.Sprintf("Global data tags are only supported in Elastic Stack %s and above", MinVersionGlobalDataTags))
+			return kbapi.PostFleetAgentPoliciesJSONRequestBody{}, diags
+		}
+
+		items := utils.MapTypeToMap(ctx, model.GlobalDataTags, path.Root("global_data_tags"), &diags,
+			func(item globalDataTagsItemModel, meta utils.MapMeta) kbapi.AgentPolicyGlobalDataTagsItem {
+				var value kbapi.AgentPolicyGlobalDataTagsItem_Value
+				var err error
+				if item.StringValue.ValueStringPointer() != nil {
+					err = value.FromAgentPolicyGlobalDataTagsItemValue0(*item.StringValue.ValueStringPointer())
+				} else {
+					err = value.FromAgentPolicyGlobalDataTagsItemValue1(*item.NumberValue.ValueFloat32Pointer())
+				}
+				if err != nil {
+					diags.AddError("global_data_tags validation_error_converting_values", err.Error())
+					return kbapi.AgentPolicyGlobalDataTagsItem{}
+				}
+				return kbapi.AgentPolicyGlobalDataTagsItem{
+					Name:  meta.Key,
+					Value: value,
+				}
+			})
+
+		if diags.HasError() {
+			return kbapi.PostFleetAgentPoliciesJSONRequestBody{}, diags
+		}
+
+		itemsList := make([]kbapi.AgentPolicyGlobalDataTagsItem, 0, len(items))
+		for _, v := range items {
+			itemsList = append(itemsList, v)
+		}
+		body.GlobalDataTags = &itemsList
+	}
+
+	return body, nil
 }
 
-func (model agentPolicyModel) toAPIUpdateModel() kbapi.PutFleetAgentPoliciesAgentpolicyidJSONRequestBody {
+func (model *agentPolicyModel) toAPIUpdateModel(ctx context.Context, serverVersion *version.Version) (kbapi.PutFleetAgentPoliciesAgentpolicyidJSONRequestBody, diag.Diagnostics) {
 	monitoring := make([]kbapi.PutFleetAgentPoliciesAgentpolicyidJSONBodyMonitoringEnabled, 0, 2)
 	if model.MonitorLogs.ValueBool() {
 		monitoring = append(monitoring, kbapi.Logs)
@@ -100,5 +179,47 @@ func (model agentPolicyModel) toAPIUpdateModel() kbapi.PutFleetAgentPoliciesAgen
 		Namespace:          model.Namespace.ValueString(),
 	}
 
-	return body
+	if len(model.GlobalDataTags.Elements()) > 0 {
+		var diags diag.Diagnostics
+		if serverVersion.LessThan(MinVersionGlobalDataTags) {
+			diags.AddError("global_data_tags ES version error", fmt.Sprintf("Global data tags are only supported in Elastic Stack %s and above", MinVersionGlobalDataTags))
+			return kbapi.PutFleetAgentPoliciesAgentpolicyidJSONRequestBody{}, diags
+		}
+
+		items := utils.MapTypeToMap(ctx, model.GlobalDataTags, path.Root("global_data_tags"), &diags,
+			func(item globalDataTagsItemModel, meta utils.MapMeta) kbapi.AgentPolicyGlobalDataTagsItem {
+
+				var value kbapi.AgentPolicyGlobalDataTagsItem_Value
+				var err error
+				if item.StringValue.ValueStringPointer() != nil {
+					err = value.FromAgentPolicyGlobalDataTagsItemValue0(*item.StringValue.ValueStringPointer())
+				} else {
+					err = value.FromAgentPolicyGlobalDataTagsItemValue1(*item.NumberValue.ValueFloat32Pointer())
+				}
+				if err != nil {
+					diags.AddError("global_data_tags validation_error_converting_values", err.Error())
+					return kbapi.AgentPolicyGlobalDataTagsItem{}
+				}
+				return kbapi.AgentPolicyGlobalDataTagsItem{
+					Name:  meta.Key,
+					Value: value,
+				}
+			})
+		if diags.HasError() {
+			return kbapi.PutFleetAgentPoliciesAgentpolicyidJSONRequestBody{}, diags
+		}
+
+		itemsList := make([]kbapi.AgentPolicyGlobalDataTagsItem, 0, len(items))
+		for _, v := range items {
+			itemsList = append(itemsList, v)
+		}
+		body.GlobalDataTags = &itemsList
+	} else {
+		if serverVersion.GreaterThanOrEqual(MinVersionGlobalDataTags) {
+			itemsList := make([]kbapi.AgentPolicyGlobalDataTagsItem, 0)
+			body.GlobalDataTags = &itemsList
+		}
+	}
+
+	return body, nil
 }

internal/fleet/agent_policy/read.go

@@ -34,7 +34,11 @@ func (r *agentPolicyResource) Read(ctx context.Context, req resource.ReadRequest
 		return
 	}
 
-	stateModel.populateFromAPI(policy)
+	diags = stateModel.populateFromAPI(ctx, policy)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
 
 	resp.State.Set(ctx, stateModel)
 	resp.Diagnostics.Append(diags...)

internal/fleet/agent_policy/resource.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 
 	"github.com/elastic/terraform-provider-elasticstack/internal/clients"
+	"github.com/hashicorp/go-version"
 	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 )
@@ -15,6 +16,8 @@ var (
 	_ resource.ResourceWithImportState = &agentPolicyResource{}
 )
 
+var MinVersionGlobalDataTags = version.Must(version.NewVersion("8.15.0"))
+
 // NewResource is a helper function to simplify the provider implementation.
 func NewResource() resource.Resource {
 	return &agentPolicyResource{}