STACKITRCO-187 - Add option iaas API param agent

Adds a terraform `stackit_server` option for the iaas ( _create server_ ) API param:
`"agent": {"provisioned": true}`

ref STACKITRCO-187

ref: stackitcloud/stackit-cli#1213

review url: stackitcloud#1113

---

Tests:
* ran `make fmt`, `make generate-docs`, `make lint`

* ran unit tests
```
[~/terraform-provider-stackit] go test stackit/internal/services/iaas/server/*
ok      command-line-arguments  15.005s
[~/terraform-provider-stackit] make test
...
ok      github.com/stackitcloud/terraform-provider-stackit/stackit/internal/services/iaas/server       15.006s  coverage: 33.0% of statements
...
[~/terraform-provider-stackit]
```

* Tested: with a locally-configured terraform, by adding, changing, deleting `agent`-related parts of a tf config.

Signed-off-by: Adrian Nackov <adrian.nackov@digits.schwarz>

Author: Adrian Nackov

docs/data-sources/server.md

@@ -34,6 +34,7 @@ data "stackit_server" "example" {
 ### Read-Only
 
 - `affinity_group` (String) The affinity group the server is assigned to.
+- `agent` (Attributes) STACKIT Server Agent as setup on the server (see [below for nested schema](#nestedatt--agent))
 - `availability_zone` (String) The availability zone of the server.
 - `boot_volume` (Attributes) The boot volume for the server (see [below for nested schema](#nestedatt--boot_volume))
 - `created_at` (String) Date-time when the server was created
@@ -48,6 +49,14 @@ data "stackit_server" "example" {
 - `updated_at` (String) Date-time when the server was updated
 - `user_data` (String) User data that is passed via cloud-init to the server.
 
+<a id="nestedatt--agent"></a>
+### Nested Schema for `agent`
+
+Read-Only:
+
+- `provisioned` (Boolean) Whether a STACKIT Server Agent is provisioned at the server
+
+
 <a id="nestedatt--boot_volume"></a>
 ### Nested Schema for `boot_volume`
 

docs/resources/server.md

@@ -404,6 +404,7 @@ import {
 ### Optional
 
 - `affinity_group` (String) The affinity group the server is assigned to.
+- `agent` (Attributes) The STACKIT Server Agent configured for the server (see [below for nested schema](#nestedatt--agent))
 - `availability_zone` (String) The availability zone of the server.
 - `boot_volume` (Attributes) The boot volume for the server (see [below for nested schema](#nestedatt--boot_volume))
 - `desired_status` (String) The desired status of the server resource. Possible values are: `active`, `inactive`, `deallocated`.
@@ -422,6 +423,18 @@ import {
 - `server_id` (String) The server ID.
 - `updated_at` (String) Date-time when the server was updated
 
+<a id="nestedatt--agent"></a>
+### Nested Schema for `agent`
+
+Optional:
+
+- `provisioning_policy` (String) Agent provisioning policy: "ALWAYS", "NEVER", or "INHERIT". "INHERIT" follows the image default value.
+
+Read-Only:
+
+- `provisioned` (Boolean) Whether a STACKIT Server Agent should be provisioned at the server
+
+
 <a id="nestedatt--boot_volume"></a>
 ### Nested Schema for `boot_volume`
 

stackit/internal/services/iaas/iaas_acc_test.go

@@ -2223,6 +2223,8 @@ func TestAccServerMin(t *testing.T) {
 					resource.TestCheckResourceAttrSet("stackit_server.server", "created_at"),
 					resource.TestCheckResourceAttrSet("stackit_server.server", "launched_at"),
 					resource.TestCheckResourceAttrSet("stackit_server.server", "updated_at"),
+					resource.TestCheckResourceAttr("stackit_server.server", "agent.provisioning_policy", "INHERIT"),
+					resource.TestCheckNoResourceAttr("stackit_server.server", "agent.provisioned"),
 				),
 			},
 			// Data source
@@ -2275,6 +2277,7 @@ func TestAccServerMin(t *testing.T) {
 					resource.TestCheckResourceAttrSet("data.stackit_server.server", "created_at"),
 					resource.TestCheckResourceAttrSet("data.stackit_server.server", "launched_at"),
 					resource.TestCheckResourceAttrSet("data.stackit_server.server", "updated_at"),
+					resource.TestCheckNoResourceAttr("data.stackit_server.server", "agent.provisioned"),
 				),
 			},
 			// Import
@@ -2294,7 +2297,7 @@ func TestAccServerMin(t *testing.T) {
 				},
 				ImportState:             true,
 				ImportStateVerify:       true,
-				ImportStateVerifyIgnore: []string{"boot_volume", "network_interfaces"}, // Field is not mapped as it is only relevant on creation
+				ImportStateVerifyIgnore: []string{"boot_volume", "network_interfaces", "agent"}, // Field is not mapped as it is only relevant on creation
 			},
 			// Update
 			{
@@ -2328,6 +2331,8 @@ func TestAccServerMin(t *testing.T) {
 					resource.TestCheckResourceAttrSet("stackit_server.server", "created_at"),
 					resource.TestCheckResourceAttrSet("stackit_server.server", "launched_at"),
 					resource.TestCheckResourceAttrSet("stackit_server.server", "updated_at"),
+					resource.TestCheckResourceAttr("stackit_server.server", "agent.provisioning_policy", "INHERIT"),
+					resource.TestCheckNoResourceAttr("stackit_server.server", "agent.provisioned"),
 				),
 			},
 			// Deletion is done by the framework implicitly
@@ -2425,6 +2430,10 @@ func TestAccServerMax(t *testing.T) {
 					resource.TestCheckResourceAttr("stackit_key_pair.key_pair", "name", testutil.ConvertConfigVariable(testConfigServerVarsMax["name_not_updated"])),
 					resource.TestCheckResourceAttr("stackit_key_pair.key_pair", "public_key", testutil.ConvertConfigVariable(testConfigServerVarsMax["public_key"])),
 
+					// Agent
+					resource.TestCheckResourceAttr("stackit_server.server", "agent.provisioning_policy", "ALWAYS"),
+					resource.TestCheckResourceAttr("stackit_server.server", "agent.provisioned", "true"),
+
 					// Service account attachment
 					resource.TestCheckResourceAttrPair(
 						"stackit_server_service_account_attach.attached_service_account", "project_id",
@@ -2500,6 +2509,7 @@ func TestAccServerMax(t *testing.T) {
 						"stackit_key_pair.key_pair", "name",
 						"data.stackit_server.server", "keypair_name",
 					),
+					resource.TestCheckResourceAttr("data.stackit_server.server", "agent.provisioned", "true"),
 					// All network interface which was are attached appear here
 					resource.TestCheckResourceAttr("data.stackit_server.server", "network_interfaces.#", "2"),
 					resource.TestCheckTypeSetElemAttrPair(
@@ -2787,6 +2797,11 @@ func TestAccServerMax(t *testing.T) {
 					resource.TestCheckResourceAttr("stackit_key_pair.key_pair", "name", testutil.ConvertConfigVariable(testConfigServerVarsMaxUpdated["name_not_updated"])),
 					resource.TestCheckResourceAttr("stackit_key_pair.key_pair", "public_key", testutil.ConvertConfigVariable(testConfigServerVarsMaxUpdated["public_key"])),
 
+					// Agent
+					resource.TestCheckResourceAttr("stackit_server.server", "agent.provisioning_policy", "NEVER"),
+					resource.TestCheckResourceAttr("stackit_server.server", "agent.provisioned", "false"),
+					resource.TestCheckResourceAttrSet("stackit_server.server", "server_id"),
+
 					// Service account attachment
 					resource.TestCheckResourceAttrPair(
 						"stackit_server_service_account_attach.attached_service_account", "project_id",

stackit/internal/services/iaas/server/datasource.go

@@ -35,6 +35,7 @@ type DataSourceModel struct {
 	ServerId          types.String `tfsdk:"server_id"`
 	MachineType       types.String `tfsdk:"machine_type"`
 	Name              types.String `tfsdk:"name"`
+	Agent             types.Object `tfsdk:"agent"`
 	AvailabilityZone  types.String `tfsdk:"availability_zone"`
 	BootVolume        types.Object `tfsdk:"boot_volume"`
 	ImageId           types.String `tfsdk:"image_id"`
@@ -53,6 +54,10 @@ var bootVolumeDataTypes = map[string]attr.Type{
 	"delete_on_termination": basetypes.BoolType{},
 }
 
+var agentDataTypes = map[string]attr.Type{
+	"provisioned": basetypes.BoolType{},
+}
+
 // NewServerDataSource is a helper function to simplify the provider implementation.
 func NewServerDataSource() datasource.DataSource {
 	return &serverDataSource{}
@@ -124,6 +129,16 @@ func (d *serverDataSource) Schema(_ context.Context, _ datasource.SchemaRequest,
 				MarkdownDescription: "Name of the type of the machine for the server. Possible values are documented in [Virtual machine flavors](https://docs.stackit.cloud/products/compute-engine/server/basics/machine-types/)",
 				Computed:            true,
 			},
+			"agent": schema.SingleNestedAttribute{
+				Description: "STACKIT Server Agent as setup on the server",
+				Computed:    true,
+				Attributes: map[string]schema.Attribute{
+					"provisioned": schema.BoolAttribute{
+						Description: "Whether a STACKIT Server Agent is provisioned at the server",
+						Computed:    true,
+					},
+				},
+			},
 			"availability_zone": schema.StringAttribute{
 				Description: "The availability zone of the server.",
 				Computed:    true,
@@ -305,6 +320,25 @@ func mapDataSourceFields(ctx context.Context, serverResp *iaas.Server, model *Da
 		model.BootVolume = types.ObjectNull(bootVolumeDataTypes)
 	}
 
+	if serverResp.Agent != nil && serverResp.Agent.Provisioned != nil {
+		agent, diags := types.ObjectValue(agentDataTypes, map[string]attr.Value{
+			"provisioned": types.BoolPointerValue(serverResp.Agent.Provisioned),
+		})
+		if diags.HasError() {
+			return fmt.Errorf("failed to map agent: %w", core.DiagsToError(diags))
+		}
+		model.Agent = agent
+	} else {
+		// return a null object so user's code like 'agent.provisioned' doesn't crash
+		agent, diags := types.ObjectValue(agentDataTypes, map[string]attr.Value{
+			"provisioned": types.BoolNull(),
+		})
+		if diags.HasError() {
+			return fmt.Errorf("failed to map agent (null case): %w", core.DiagsToError(diags))
+		}
+		model.Agent = agent
+	}
+
 	if serverResp.UserData != nil && len(*serverResp.UserData) > 0 {
 		model.UserData = types.StringValue(string(*serverResp.UserData))
 	}

stackit/internal/services/iaas/server/datasource_test.go

@@ -7,9 +7,14 @@ import (
 	"github.com/google/go-cmp/cmp"
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/stackitcloud/stackit-sdk-go/core/utils"
 	"github.com/stackitcloud/stackit-sdk-go/services/iaas"
 )
 
+var expectedNullAgentData, _ = types.ObjectValue(agentDataTypes, map[string]attr.Value{
+	"provisioned": types.BoolNull(),
+})
+
 func TestMapDataSourceFields(t *testing.T) {
 	type args struct {
 		state  DataSourceModel
@@ -40,6 +45,7 @@ func TestMapDataSourceFields(t *testing.T) {
 				ServerId:          types.StringValue("sid"),
 				Name:              types.StringNull(),
 				AvailabilityZone:  types.StringNull(),
+				Agent:             expectedNullAgentData,
 				Labels:            types.MapNull(types.StringType),
 				ImageId:           types.StringNull(),
 				NetworkInterfaces: types.ListNull(types.StringType),
@@ -77,12 +83,15 @@ func TestMapDataSourceFields(t *testing.T) {
 							NicId: new("nic2"),
 						},
 					},
-					KeypairName:   new("keypair_name"),
-					AffinityGroup: new("group_id"),
-					CreatedAt:     new(testTimestamp()),
-					UpdatedAt:     new(testTimestamp()),
-					LaunchedAt:    new(testTimestamp()),
-					Status:        new("active"),
+					KeypairName: utils.Ptr("keypair_name"),
+					Agent: &iaas.ServerAgent{
+						Provisioned: utils.Ptr(true),
+					},
+					AffinityGroup: utils.Ptr("group_id"),
+					CreatedAt:     utils.Ptr(testTimestamp()),
+					UpdatedAt:     utils.Ptr(testTimestamp()),
+					LaunchedAt:    utils.Ptr(testTimestamp()),
+					Status:        utils.Ptr("active"),
 				},
 				region: "eu02",
 			},
@@ -100,7 +109,10 @@ func TestMapDataSourceFields(t *testing.T) {
 					types.StringValue("nic1"),
 					types.StringValue("nic2"),
 				}),
-				KeypairName:   types.StringValue("keypair_name"),
+				KeypairName: types.StringValue("keypair_name"),
+				Agent: types.ObjectValueMust(agentDataTypes, map[string]attr.Value{
+					"provisioned": types.BoolValue(true),
+				}),
 				AffinityGroup: types.StringValue("group_id"),
 				CreatedAt:     types.StringValue(testTimestampValue),
 				UpdatedAt:     types.StringValue(testTimestampValue),
@@ -131,6 +143,7 @@ func TestMapDataSourceFields(t *testing.T) {
 				Labels:            types.MapValueMust(types.StringType, map[string]attr.Value{}),
 				ImageId:           types.StringNull(),
 				NetworkInterfaces: types.ListNull(types.StringType),
+				Agent:             expectedNullAgentData,
 				KeypairName:       types.StringNull(),
 				AffinityGroup:     types.StringNull(),
 				UserData:          types.StringNull(),