fix(baremetal): unexpected reinstall on ssh key ids changes (#1556)

Author: yfodil

docs/resources/baremetal_server.md

@@ -38,7 +38,8 @@ 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 reinstall 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.
 - `name` - (Optional) The name of the server.
 - `hostname` - (Optional) The hostname of the server.
 - `description` - (Optional) A description for the server.

scaleway/helpers_baremetal.go

@@ -133,3 +133,15 @@ func waitForBaremetalServerInstall(ctx context.Context, api *baremetal.API, zone
 
 	return server, err
 }
+
+func baremetalInstallServer(ctx context.Context, d *schema.ResourceData, baremetalAPI *baremetal.API, installServerRequest *baremetal.InstallServerRequest) error {
+	installServerRequest.OsID = expandID(d.Get("os"))
+	installServerRequest.SSHKeyIDs = expandStrings(d.Get("ssh_key_ids"))
+
+	_, err := baremetalAPI.InstallServer(installServerRequest, scw.WithContext(ctx))
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

scaleway/resource_baremetal_server.go

@@ -67,8 +67,17 @@ func resourceScalewayBaremetalServer() *schema.Resource {
 					Type:         schema.TypeString,
 					ValidateFunc: validationUUID(),
 				},
-				Required:    true,
-				Description: "Array of SSH key IDs allowed to SSH to the server",
+				Required: true,
+				Description: `Array of SSH key IDs allowed to SSH to the server
+
+**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": {
+				Type:        schema.TypeBool,
+				Optional:    true,
+				Default:     false,
+				Description: "If True, this boolean allows to reinstall the server on SSH key IDs changes",
 			},
 			"description": {
 				Type:         schema.TypeString,
@@ -257,16 +266,14 @@ func resourceScalewayBaremetalServerUpdate(ctx context.Context, d *schema.Resour
 		}
 	}
 
-	if d.HasChanges("os", "ssh_key_ids") {
-		installReq := &baremetal.InstallServerRequest{
-			Zone:      zonedID.Zone,
-			ServerID:  zonedID.ID,
-			OsID:      expandZonedID(d.Get("os")).ID,
-			Hostname:  expandStringWithDefault(d.Get("hostname"), d.Get("name").(string)),
-			SSHKeyIDs: expandStrings(d.Get("ssh_key_ids")),
-		}
+	installReq := &baremetal.InstallServerRequest{
+		Zone:     zonedID.Zone,
+		ServerID: zonedID.ID,
+		Hostname: expandStringWithDefault(d.Get("hostname"), d.Get("name").(string)),
+	}
 
-		_, err := baremetalAPI.InstallServer(installReq, scw.WithContext(ctx))
+	if d.HasChange("os") {
+		err = baremetalInstallServer(ctx, d, baremetalAPI, installReq)
 		if err != nil {
 			return diag.FromErr(err)
 		}
@@ -277,7 +284,30 @@ func resourceScalewayBaremetalServerUpdate(ctx context.Context, d *schema.Resour
 		}
 	}
 
-	return resourceScalewayBaremetalServerRead(ctx, d, meta)
+	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") {
+			diags = append(diags, diag.Diagnostic{
+				Severity: diag.Warning,
+				Summary:  "Changes have been made on your SSH key ID(s)",
+				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",
+			})
+		} else {
+			err = baremetalInstallServer(ctx, d, baremetalAPI, installReq)
+			if err != nil {
+				return diag.FromErr(err)
+			}
+
+			_, err = waitForBaremetalServerInstall(ctx, baremetalAPI, zonedID.Zone, zonedID.ID, d.Timeout(schema.TimeoutUpdate))
+			if err != nil {
+				return diag.FromErr(err)
+			}
+		}
+	}
+
+	return append(diags, resourceScalewayBaremetalServerRead(ctx, d, meta)...)
 }
 
 func resourceScalewayBaremetalServerDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {