Merge lp:~julian-edwards/gwacl/user-data-config into lp:gwacl

[Julian Edwards]

Add UserData to LinuxProvisioningConfiguration.

This branch adds UserData to LinuxProvisioningConfiguration. The instance's /var/lib/waagent/ovf-env.xml will end up containing the LinuxProvisioningConfiguration XML exactly as passed even though the API doesn't process unused XML nodes. This will be used to drive an updated cloud-init (WIP) instead of the hacky cloud-drive VHD solution previously proposed.

I also changed the management example to pass some dummy userdata and to optionally pause after setting up the VM so users can play with it before shutting down. Additionally I gave the instance a fixed user/pass of ubuntu/Ubuntu123 since random passwords are no use to man nor beast and is certainly not a security hazard on a short-lived private instance.

Long term, I want a new command line utility to manage VMs.

[Raphaël Badin (rvb)]

Looks good, but I've got a question (see [1]), hence "needs info".

[0]

46 + var wait string
47 + fmt.Println("Pausing so you can play with the newly-created VM")
48 + fmt.Println("To clear up, type something and press enter to continue")
49 + fmt.Scan(&wait)

That's great (I was planning to do something like that myself today :)). How about printing more details about the host to help the testing:

    request := &gwacl.GetDeploymentRequest{ServiceName: hostServiceName, DeploymentName: machineName}
    deploy, err := api.GetDeployment(request)
    fqdn, err := deploy.GetFQDN()
    fmt.Println("host:", fqdn)
    // The user name should be a variable!!!!
    fmt.Println("user:test")
    fmt.Println("password:", password)

[1]

138 + <UserData>%s</UserData>

What about escaping? Shouldn't this be base64 escaped or do you think it should be the caller's responsibility to do something like that?
My take on this is that gwacl should probably base64-encode this to avoid messing with the XML structure.

[2]

24 + location := "West US"
25 + release := "13.04"

Why this change? I don't mind the location change but precise is our target platform at the moment so I'd rather keep that as our default for experimenting.

review: Needs Information

[Julian Edwards (julian-edwards)]

On Monday 01 Jul 2013 06:58:25 you wrote:
> Review: Needs Information
>
> Looks good, but I've got a question (see [1]), hence "needs info".
>
> [0]
>
> 46 + var wait string
> 47 + fmt.Println("Pausing so you can play with the newly-created
VM")
> 48 + fmt.Println("To clear up, type something and press enter to
> continue") 49 + fmt.Scan(&wait)
>
> That's great (I was planning to do something like that myself today :)).
> How about printing more details about the host to help the testing:
>
> request := &gwacl.GetDeploymentRequest{ServiceName: hostServiceName,
> DeploymentName: machineName} deploy, err := api.GetDeployment(request)
> fqdn, err := deploy.GetFQDN()
> fmt.Println("host:", fqdn)
> // The user name should be a variable!!!!
> fmt.Println("user:test")
> fmt.Println("password:", password)

Yes, but I was going to leave it to another branch, it does not belong in this
one.

>
> [1]
>
> 138 + <UserData>%s</UserData>
>
> What about escaping? Shouldn't this be base64 escaped or do you think it
> should be the caller's responsibility to do something like that? My take on
> this is that gwacl should probably base64-encode this to avoid messing with
> the XML structure.

Caller's responsibility. It's stored on the VM host *as supplied*.

>
> [2]
>
> 24 + location := "West US"
> 25 + release := "13.04"
>
> Why this change? I don't mind the location change but precise is our target
> platform at the moment so I'd rather keep that as our default for
> experimenting.

I found both to be more reliable.

[Raphaël Badin (rvb)]

> On Monday 01 Jul 2013 06:58:25 you wrote:
> > Review: Needs Information
> >
> > Looks good, but I've got a question (see [1]), hence "needs info".
> >
> > [0]
> >
> > 46 + var wait string
> > 47 + fmt.Println("Pausing so you can play with the newly-created
> VM")
> > 48 + fmt.Println("To clear up, type something and press enter to
> > continue") 49 + fmt.Scan(&wait)
> >
> > That's great (I was planning to do something like that myself today :)).
> > How about printing more details about the host to help the testing:
> >
> > request := &gwacl.GetDeploymentRequest{ServiceName: hostServiceName,
> > DeploymentName: machineName} deploy, err := api.GetDeployment(request)
> > fqdn, err := deploy.GetFQDN()
> > fmt.Println("host:", fqdn)
> > // The user name should be a variable!!!!
> > fmt.Println("user:test")
> > fmt.Println("password:", password)
>
> Yes, but I was going to leave it to another branch, it does not belong in this
> one.

Okay.

> > [1]
> >
> > 138 + <UserData>%s</UserData>
> >
> > What about escaping? Shouldn't this be base64 escaped or do you think it
> > should be the caller's responsibility to do something like that? My take on
> > this is that gwacl should probably base64-encode this to avoid messing with
> > the XML structure.
>
> Caller's responsibility. It's stored on the VM host *as supplied*.

All right. It's probably worth a comment in the code then.

review: Approve

[lp:~julian-edwards/gwacl/user-data-config]

146. By Julian Edwards on 2013-07-02

doc comment for linux provisioning config

147. By Julian Edwards on 2013-07-02

merge trunk

[Julian Edwards (julian-edwards)]

Thanks mate, comment added.

=== modified file 'example/management/run.go'
--- example/management/run.go	2013-07-01 16:15:45 +0000
+++ example/management/run.go	2013-07-02 00:36:23 +0000
@@ -21,11 +21,13 @@
 var certFile string
 var subscriptionID string
 var verbose bool
+var pause bool
 
 func getParams() error {
     flag.StringVar(&certFile, "cert", "", "Name of your management certificate file (in PEM format).")
     flag.StringVar(&subscriptionID, "subscriptionid", "", "Your Azure subscription ID.")
     flag.BoolVar(&verbose, "verbose", false, "Print debugging output")
+    flag.BoolVar(&pause, "pause", false, "Wait for user input after the VM is brought up (useful for further testing)")
 
     flag.Parse()
 
@@ -85,8 +87,8 @@
 }
 
 func ExerciseHostedServicesAPI(api *gwacl.ManagementAPI) {
-    location := "East US"
-    release := "12.04"
+    location := "West US"
+    release := "13.04"
 
     fmt.Printf("Getting OS Image for release '%s' and location '%s'...\n", release, location)
     images, err := api.ListOSImages()
@@ -133,10 +135,12 @@
 
     fmt.Println("Adding VM deployment...")
     hostname := makeRandomIdentifier("gwaclhost", 25)
-    // Azure is strict about passwords, so make it really ugly.
-    password := makeRandomIdentifier("Password-!£$%^&*-", 32)
+    // Random passwords are no use to man nor beast here if you want to
+    // test with your instance, so we'll use a fixed one.  It's not really a
+    // security hazard in such a short-lived private instance.
+    password := "Ubuntu123"
     vhdName := makeRandomIdentifier("gwacldisk", 16)
-    configurationSet := gwacl.NewLinuxProvisioningConfiguration(hostname, "test", password, false)
+    configurationSet := gwacl.NewLinuxProvisioningConfiguration(hostname, "ubuntu", password, "TEST_USER_DATA", false)
 
     storageAccount := makeRandomIdentifier("gwacl", 24)
     storageLabel := makeRandomIdentifier("gwacl", 64)
@@ -196,4 +200,11 @@
     checkError(err)
     fmt.Printf("Got %d instance(s)\n", len(instances))
     fmt.Println("Done listing VM\n")
+
+    if pause {
+        var wait string
+        fmt.Println("Pausing so you can play with the newly-created VM")
+        fmt.Println("To clear up, type something and press enter to continue")
+        fmt.Scan(&wait)
+    }
 }
 
=== modified file 'helpers_apiobjects_test.go'
--- helpers_apiobjects_test.go	2013-06-27 11:53:50 +0000
+++ helpers_apiobjects_test.go	2013-07-02 00:36:23 +0000
@@ -46,6 +46,7 @@
     hostname := MakeRandomString(10)
     username := MakeRandomString(10)
     password := MakeRandomString(10)
+    userdata := MakeRandomString(10)
     disableSSH := MakeRandomBool()
 
     return &LinuxProvisioningConfiguration{
@@ -53,6 +54,7 @@
         Hostname:             hostname,
         Username:             username,
         Password:             password,
+        UserData:             userdata,
         DisableSSHPasswordAuthentication: disableSSH}
 }
 
 
=== modified file 'management_base_test.go'
--- management_base_test.go	2013-06-27 16:35:06 +0000
+++ management_base_test.go	2013-07-02 00:36:23 +0000
@@ -495,7 +495,7 @@
     api := makeAPI(c)
     recordedRequests := setUpDispatcher("operationID")
     serviceName := "serviceName"
-    configurationSet := NewLinuxProvisioningConfiguration("testHostname12345", "test", "test123#@!", false)
+    configurationSet := NewLinuxProvisioningConfiguration("testHostname12345", "test", "test123#@!", "user-data", false)
     vhd := NewOSVirtualHardDisk("hostCaching", "diskLabel", "diskName", "http://mediaLink", "sourceImageName", "os")
     role := NewRole("ExtraSmall", "test-role-123", []LinuxProvisioningConfiguration{*configurationSet}, []OSVirtualHardDisk{*vhd})
     deployment := NewDeploymentForCreateVMDeployment("test-machine-name", "Staging", "testLabel", []Role{*role}, "testNetwork")
 
=== modified file 'xmlobjects.go'
--- xmlobjects.go	2013-06-28 10:21:26 +0000
+++ xmlobjects.go	2013-07-02 00:36:23 +0000
@@ -45,6 +45,7 @@
     Hostname                         string `xml:"HostName"`
     Username                         string `xml:"UserName"`
     Password                         string `xml:"UserPassword"`
+    UserData                         string `xml:"UserData"`
     DisableSSHPasswordAuthentication bool   `xml:"DisableSshPasswordAuthentication"`
 }
 
@@ -52,14 +53,19 @@
     return toxml(c)
 }
 
+// NewLinuxProvisioningConfiguration creates and returns a
+// LinuxProvisioningConfiguration which is used when deploying a Linux VM
+// instance. Note that UserData is passed to Azure *as-is* which also stores
+// it as passed, so consider base64 encoding it.
 func NewLinuxProvisioningConfiguration(
-    Hostname, Username, Password string,
+    Hostname, Username, Password, UserData string,
     DisableSSHPasswordAuthentication bool) *LinuxProvisioningConfiguration {
     return &LinuxProvisioningConfiguration{
         ConfigurationSetType: "LinuxProvisioningConfiguration",
         Hostname:             Hostname,
         Username:             Username,
         Password:             Password,
+        UserData:             UserData,
         DisableSSHPasswordAuthentication: DisableSSHPasswordAuthentication,
     }
 }
 
=== modified file 'xmlobjects_test.go'
--- xmlobjects_test.go	2013-06-28 10:21:26 +0000
+++ xmlobjects_test.go	2013-07-02 00:36:23 +0000
@@ -31,10 +31,12 @@
           <HostName>%s</HostName>
           <UserName>%s</UserName>
           <UserPassword>%s</UserPassword>
+          <UserData>%s</UserData>
           <DisableSshPasswordAuthentication>%v</DisableSshPasswordAuthentication>
         </LinuxProvisioningConfiguration>`)
     expected := fmt.Sprintf(template, config.Hostname, config.Username,
-        config.Password, config.DisableSSHPasswordAuthentication)
+        config.Password, config.UserData,
+        config.DisableSSHPasswordAuthentication)
     c.Check(xml, Equals, expected)
 }
 
@@ -125,6 +127,7 @@
               <HostName>%s</HostName>
               <UserName>%s</UserName>
               <UserPassword>%s</UserPassword>
+              <UserData>%s</UserData>
               <DisableSshPasswordAuthentication>%v</DisableSshPasswordAuthentication>
             </ConfigurationSet>
           </ConfigurationSets>
@@ -132,7 +135,8 @@
         </Role>`)
     expected := fmt.Sprintf(template, role.RoleName,
         config.ConfigurationSetType, config.Hostname, config.Username,
-        config.Password, config.DisableSSHPasswordAuthentication, role.RoleSize)
+        config.Password, config.UserData,
+        config.DisableSSHPasswordAuthentication, role.RoleSize)
     c.Check(xml, Equals, expected)
 }
 
@@ -160,6 +164,7 @@
                   <HostName>%s</HostName>
                   <UserName>%s</UserName>
                   <UserPassword>%s</UserPassword>
+                  <UserData>%s</UserData>
                   <DisableSshPasswordAuthentication>%v</DisableSshPasswordAuthentication>
                 </ConfigurationSet>
               </ConfigurationSets>
@@ -180,7 +185,7 @@
     expected := fmt.Sprintf(template, deployment.Name,
         deployment.DeploymentSlot, deployment.Label,
         role.RoleName, config.ConfigurationSetType, config.Hostname,
-        config.Username, config.Password,
+        config.Username, config.Password, config.UserData,
         config.DisableSSHPasswordAuthentication, role.RoleSize,
         deployment.VirtualNetworkName, dns.Name, dns.Address)
     c.Check(xml, Equals, expected)
@@ -750,13 +755,15 @@
     hostname := MakeRandomString(10)
     username := MakeRandomString(10)
     password := MakeRandomString(10)
+    userdata := MakeRandomString(10)
     disablessh := MakeRandomBool()
 
     config := NewLinuxProvisioningConfiguration(
-        hostname, username, password, disablessh)
+        hostname, username, password, userdata, disablessh)
     c.Check(config.Hostname, Equals, hostname)
     c.Check(config.Username, Equals, username)
     c.Check(config.Password, Equals, password)
+    c.Check(config.UserData, Equals, userdata)
     c.Check(config.DisableSSHPasswordAuthentication, Equals, disablessh)
     c.Check(config.ConfigurationSetType, Equals, "LinuxProvisioningConfiguration")
 }