feat(baremetal): add user attributes to baremetal server (#1582)

Author: Codelax

docs/resources/baremetal_server.md

@@ -38,8 +38,12 @@ The following arguments are supported:
   Use [this endpoint](https://developers.scaleway.com/en/products/baremetal/api/#get-87598a) to find the right OS ID.
   ~> **Important:** Updates to `os` will reinstall the server.
 - `ssh_key_ids` - (Required) List of SSH keys allowed to connect to the server.
-  ~> **Important:** Updates to `ssh_key_ids` will not take effect on the server, it requires to reinstall it. To do so please set 'reinstall_on_ssh_key_changes' argument to true.
-- `reinstall_on_ssh_key_changes` - (Optional) If True, this boolean allows to reinstall the server on SSH key IDs changes.
+- `user` - (Optional) User used for the installation.
+- `password` - (Optional) Password used for the installation. May be required depending on used os.
+- `service_user` - (Optional) User used for the service to install.
+- `service_password` - (Optional) Password used for the service to install. May be required depending on used os.
+- `reinstall_on_config_changes` - (Optional) If True, this boolean allows to reinstall the server on install config changes.
+  ~> **Important:** Updates to `ssh_key_ids`, `user`, `password`, `service_user` or `service_password` will not take effect on the server, it requires to reinstall it. To do so please set 'reinstall_on_config_changes' argument to true.
 - `name` - (Optional) The name of the server.
 - `hostname` - (Optional) The hostname of the server.
 - `description` - (Optional) A description for the server.

scaleway/resource_baremetal_server.go

@@ -2,7 +2,9 @@ package scaleway
 
 import (
 	"context"
+	"fmt"
 
+	"github.com/hashicorp/go-cty/cty"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
@@ -73,11 +75,35 @@ func resourceScalewayBaremetalServer() *schema.Resource {
 **NOTE** : If you are attempting to update your SSH key IDs, it will induce the reinstall of your server. 
 If this behaviour is wanted, please set 'reinstall_on_ssh_key_changes' argument to true.`,
 			},
-			"reinstall_on_ssh_key_changes": {
+			"user": {
+				Type:        schema.TypeString,
+				Optional:    true,
+				Computed:    true,
+				Description: "User used for the installation.",
+			},
+			"password": {
+				Type:        schema.TypeString,
+				Optional:    true,
+				Sensitive:   true,
+				Description: "Password used for the installation.",
+			},
+			"service_user": {
+				Type:        schema.TypeString,
+				Optional:    true,
+				Computed:    true,
+				Description: "User used for the service to install.",
+			},
+			"service_password": {
+				Type:        schema.TypeString,
+				Optional:    true,
+				Sensitive:   true,
+				Description: "Password used for the service to install.",
+			},
+			"reinstall_on_config_changes": {
 				Type:        schema.TypeBool,
 				Optional:    true,
 				Default:     false,
-				Description: "If True, this boolean allows to reinstall the server on SSH key IDs changes",
+				Description: "If True, this boolean allows to reinstall the server on SSH key IDs, user or password changes",
 			},
 			"description": {
 				Type:         schema.TypeString,
@@ -149,6 +175,9 @@ func resourceScalewayBaremetalServerCreate(ctx context.Context, d *schema.Resour
 		}
 		offerID = newZonedID(zone, o.ID)
 	}
+	if diags := validateInstallConfig(ctx, d, meta); len(diags) > 0 {
+		return diags
+	}
 
 	server, err := baremetalAPI.CreateServer(&baremetal.CreateServerRequest{
 		Zone:        zone,
@@ -170,11 +199,15 @@ func resourceScalewayBaremetalServerCreate(ctx context.Context, d *schema.Resour
 	}
 
 	_, err = baremetalAPI.InstallServer(&baremetal.InstallServerRequest{
-		Zone:      server.Zone,
-		ServerID:  server.ID,
-		OsID:      expandZonedID(d.Get("os")).ID,
-		Hostname:  expandStringWithDefault(d.Get("hostname"), server.Name),
-		SSHKeyIDs: expandStrings(d.Get("ssh_key_ids")),
+		Zone:            server.Zone,
+		ServerID:        server.ID,
+		OsID:            expandZonedID(d.Get("os")).ID,
+		Hostname:        expandStringWithDefault(d.Get("hostname"), server.Name),
+		SSHKeyIDs:       expandStrings(d.Get("ssh_key_ids")),
+		User:            expandStringPtr(d.Get("user")),
+		Password:        expandStringPtr(d.Get("password")),
+		ServiceUser:     expandStringPtr(d.Get("service_user")),
+		ServicePassword: expandStringPtr(d.Get("service_password")),
 	}, scw.WithContext(ctx))
 	if err != nil {
 		return diag.FromErr(err)
@@ -225,6 +258,7 @@ func resourceScalewayBaremetalServerRead(ctx context.Context, d *schema.Resource
 	if server.Install != nil {
 		_ = d.Set("os_id", newZonedID(server.Zone, server.Install.OsID).String())
 		_ = d.Set("ssh_key_ids", server.Install.SSHKeyIDs)
+		_ = d.Set("user", server.Install.User)
 	}
 	_ = d.Set("description", server.Description)
 
@@ -267,12 +301,20 @@ func resourceScalewayBaremetalServerUpdate(ctx context.Context, d *schema.Resour
 	}
 
 	installReq := &baremetal.InstallServerRequest{
-		Zone:     zonedID.Zone,
-		ServerID: zonedID.ID,
-		Hostname: expandStringWithDefault(d.Get("hostname"), d.Get("name").(string)),
+		Zone:            zonedID.Zone,
+		ServerID:        zonedID.ID,
+		Hostname:        expandStringWithDefault(d.Get("hostname"), d.Get("name").(string)),
+		SSHKeyIDs:       expandStrings(d.Get("ssh_key_ids")),
+		User:            expandStringPtr(d.Get("user")),
+		Password:        expandStringPtr(d.Get("password")),
+		ServiceUser:     expandStringPtr(d.Get("service_user")),
+		ServicePassword: expandStringPtr(d.Get("service_password")),
 	}
 
 	if d.HasChange("os") {
+		if diags := validateInstallConfig(ctx, d, meta); len(diags) > 0 {
+			return diags
+		}
 		err = baremetalInstallServer(ctx, d, baremetalAPI, installReq)
 		if err != nil {
 			return diag.FromErr(err)
@@ -286,15 +328,18 @@ func resourceScalewayBaremetalServerUpdate(ctx context.Context, d *schema.Resour
 
 	var diags diag.Diagnostics
 
-	if d.HasChanges("ssh_key_ids", "reinstall_on_ssh_key_changes") {
-		if !d.Get("reinstall_on_ssh_key_changes").(bool) && !d.HasChange("os") {
+	if d.HasChanges("ssh_key_ids", "user", "password", "reinstall_on_config_changes") {
+		if !d.Get("reinstall_on_config_changes").(bool) && !d.HasChange("os") {
 			diags = append(diags, diag.Diagnostic{
 				Severity: diag.Warning,
-				Summary:  "Changes have been made on your SSH key ID(s)",
+				Summary:  "Changes have been made on your config",
 				Detail: "[WARN] This change induce the reinstall of your server. " +
-					"If this behaviour is wanted, please set 'reinstall_on_ssh_key_changes' argument to true",
+					"If this behaviour is wanted, please set 'reinstall_on_config_changes' argument to true",
 			})
 		} else {
+			if diags := validateInstallConfig(ctx, d, meta); len(diags) > 0 {
+				return diags
+			}
 			err = baremetalInstallServer(ctx, d, baremetalAPI, installReq)
 			if err != nil {
 				return diag.FromErr(err)
@@ -334,3 +379,62 @@ func resourceScalewayBaremetalServerDelete(ctx context.Context, d *schema.Resour
 
 	return nil
 }
+
+func baremetalInstallAttributeMissing(field *baremetal.OSOSField, d *schema.ResourceData, attribute string) bool {
+	if field != nil && field.Required && field.DefaultValue == nil {
+		if _, attributeExists := d.GetOk(attribute); !attributeExists {
+			return true
+		}
+	}
+	return false
+}
+
+// validateInstallConfig validates that schema contains attribute required for OS install
+func validateInstallConfig(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	baremetalAPI, zone, err := baremetalAPIWithZone(d, meta)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	os, err := baremetalAPI.GetOS(&baremetal.GetOSRequest{
+		Zone: zone,
+		OsID: expandID(d.Get("os")),
+	}, scw.WithContext(ctx))
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	diags := diag.Diagnostics(nil)
+	installAttributes := []struct {
+		Attribute string
+		Field     *baremetal.OSOSField
+	}{
+		{
+			"user",
+			os.User,
+		},
+		{
+			"password",
+			os.Password,
+		},
+		{
+			"service_user",
+			os.ServiceUser,
+		},
+		{
+			"service_password",
+			os.ServicePassword,
+		},
+	}
+	for _, installAttr := range installAttributes {
+		if baremetalInstallAttributeMissing(installAttr.Field, d, installAttr.Attribute) {
+			diags = append(diags, diag.Diagnostic{
+				Severity:      diag.Error,
+				Summary:       fmt.Sprintf("%s attribute is required", installAttr.Attribute),
+				Detail:        fmt.Sprintf("%s is required for this os", installAttr.Attribute),
+				AttributePath: cty.GetAttrPath(installAttr.Attribute),
+			})
+		}
+	}
+	return diags
+}

scaleway/resource_baremetal_server_test.go

@@ -2,6 +2,7 @@ package scaleway
 
 import (
 	"fmt"
+	"regexp"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
@@ -122,6 +123,31 @@ func TestAccScalewayBaremetalServer_Basic(t *testing.T) {
 	})
 }
 
+func TestAccScalewayBaremetalServer_RequiredInstallConfig(t *testing.T) {
+	tt := NewTestTools(t)
+	defer tt.Cleanup()
+
+	resource.ParallelTest(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t) },
+		ProviderFactories: tt.ProviderFactories,
+		CheckDestroy:      testAccCheckScalewayBaremetalServerDestroy(tt),
+		Steps: []resource.TestStep{
+			{
+				Config: `
+					resource "scaleway_baremetal_server" "base" {
+						name        = "TestAccScalewayBaremetalServer_RequiredInstallConfig"
+						zone        = "fr-par-2"
+						offer       = "EM-B112X-SSD"
+						os          = "7e865c16-1a63-4dc7-8181-dabc020fc21b" // Proxmox
+
+						ssh_key_ids = []
+					}`,
+				ExpectError: regexp.MustCompile("attribute is required"),
+			},
+		},
+	})
+}
+
 func testAccCheckScalewayBaremetalServerExists(tt *TestTools, n string) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
 		rs, ok := s.RootModule().Resources[n]