use local-hostname for meta-data and update windows logic (#192)

* use local-hostname for meta-data and update windows logic

* fix grammar

Author: rosskirkpat

commands/create.go

@@ -536,16 +536,31 @@ func updateUserdataFile(driverOpts *rpcdriver.RPCFlags, machineName, userdataFla
 	return nil
 }
 
-// writeCloudConfig sets custom install script path to the runcmd directive
+// writeCloudConfig sets the custom install script path for the runcmd directive
 // and passes the script path to commonCloudConfig
+// RK - sets the hostname based on OS as cloud-init (linux) and cloudbase-init (windows) diverge
+// on how hostnames are set in cloud-config (userdata)
 func writeCloudConfig(machineName, encodedData, machineOS string, cf map[interface{}]interface{}, newUserDataFile *os.File) error {
 	command := "sh"
 	path := "/usr/local/custom_script/install.sh"
 	if strings.Contains(machineOS, "windows") {
 		// the writeFile path should ideally be C:\usr\local\custom_script\install.ps1
-		// but we can't guarantee that directory exists or can be created on the target machine
+		// however, we can't guarantee that directory exists or can be created on the target machine
 		command = "powershell"
 		path = "C:\\install.ps1"
+		// set_hostname is a cloudbase-init specific cloud-config parameter
+		// that is only pertinent for windows VMs
+		// https://cloudbase-init.readthedocs.io/en/latest/userdata.html
+		if err := addToCloudConfig(cf, "set_hostname", machineName); err != nil {
+			log.Debugf("[writeCloudConfig] wrote set_hostname field for %s machine %s", machineName, machineOS)
+			return err
+		}
+	} else {
+		// Add the hostname
+		if _, ok := cf["hostname"]; !ok {
+			cf["hostname"] = machineName
+			log.Debugf("[writeCloudConfig] wrote hostname field for %s machine %s", machineName, machineOS)
+		}
 	}
 	return commonCloudConfig(machineName, machineOS, encodedData, command, path, cf, newUserDataFile)
 }
@@ -570,15 +585,6 @@ func commonCloudConfig(machineName, machineOS, encodedData, command, path string
 		return err
 	}
 
-	// Add the hostname
-	if _, ok := cf["hostname"]; !ok {
-		cf["hostname"] = machineName
-	}
-	if err := addToCloudConfig(cf, "set_hostname", machineName); err != nil {
-		log.Debugf("writeCloudConfig: wrote set_hostname field for %s machine %s", machineName, machineOS)
-		return err
-	}
-
 	userdataContent, err := yaml.Marshal(cf)
 	if err != nil {
 		return err

drivers/vmwarevsphere/cloudinit.go

@@ -155,7 +155,7 @@ func (d *Driver) createCloudInitIso() error {
 		return err
 	}
 
-	md := []byte(fmt.Sprintf("hostname: %s\n", d.MachineName))
+	md := []byte(fmt.Sprintf("local-hostname: %s\n", d.MachineName))
 	if err = ioutil.WriteFile(metadata, md, perm); err != nil {
 		return err
 	}
@@ -258,7 +258,7 @@ func (d *Driver) addSSHUserToYaml(sshkey string) (string, error) {
 
 	switch d.OS {
 	default:
-		log.Debug("Adding linux ssh user to cloud-init")
+		log.Debug("[addSSHUserToYaml] Adding linux ssh user to cloud-init")
 		// implements https://github.com/canonical/cloud-init/blob/master/cloudinit/config/cc_users_groups.py#L28-L71
 		// technically not in the spec, see this code for context
 		// https://github.com/canonical/cloud-init/blob/master/cloudinit/distros/__init__.py#L394-L397
@@ -267,11 +267,11 @@ func (d *Driver) addSSHUserToYaml(sshkey string) (string, error) {
 		commonUser["no_user_group"] = true
 
 	// Administrator is the default ssh user on Windows Server 2019/2022
-	// This implements cloudbase-init for Windows VMs as cloudinit doesn't support Windows
+	// This implements cloudbase-init for Windows VMs as cloud-init doesn't support Windows
 	// https://cloudbase-init.readthedocs.io/en/latest/
 	// On Windows, primary_group and groups are concatenated.
 	case WindowsMachineOS:
-		log.Debug("Adding windows ssh user to cloud-init")
+		log.Debug("[addSSHUserToYaml] Adding windows ssh user to cloud-init")
 		commonUser["inactive"] = false
 	}