Merge pull request #1 from anastop/provision-with-initd

anastop · web-flow · commit f4cfdd91c9ad · 2018-10-23T14:37:55.000+03:00
Add init.d script to provision command
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # virgo
 
-Flexible provisioning and management of virtual machines 
+virgo allows you to quickly provision and spin VMs locally, leveraging cloud-init and
+Libvirt.
 
 ![virgo](./virgo.png)
 
@@ -11,9 +12,11 @@ Flexible provisioning and management of virtual machines
 - Allows easy VM creation with flexible configuration options
 - Supports [vhost-user network interfaces](https://libvirt.org/formatdomain.html#elementVhostuser), to allow a VM to connect e.g. with a  DPDK-based vswitch
 
-Provisioning options: 
+Provisioning options:
 - cloud image used for provisioning (currently tested with Ubuntu 16.04)
 - user credentials
+- custom provisioning script to be used during VM creation
+- custom init.d script to be installed permanently
 
 VM configuration options: 
 - number of vCPUs
@@ -38,7 +41,7 @@ virgo makes use of the following utilities:
 
 Provision a new VM called "foo":
 ```console
-$ sudo virgo --config guest_config.json --script provision.sh --guest foo
+$ sudo virgo provision --config guest_config.json --provision-script provision.sh --initd-script initd.sh --guest foo
 ```
 "foo" will shutdown after provisioning. 
 
diff --git a/cmd/provision.go b/cmd/provision.go
@@ -24,9 +24,14 @@ The bash script can be any valid bash script and is executed with root permissio
 			return fmt.Errorf("failed to parse 'guest' argument: %v", err)
 		}
 
-		scriptFile, err := cmd.Flags().GetString("script")
+		provisionScript, err := cmd.Flags().GetString("provision-script")
 		if err != nil {
-			return fmt.Errorf("failed to parse script argument: %v", err)
+			return fmt.Errorf("failed to parse provision argument: %v", err)
+		}
+
+		initdScript, err := cmd.Flags().GetString("initd-script")
+		if err != nil {
+			return fmt.Errorf("failed to parse initd argument: %v", err)
 		}
 
 		conf, err := cmd.Flags().GetString("config")
@@ -43,19 +48,29 @@ The bash script can be any valid bash script and is executed with root permissio
 		if err := json.Unmarshal(data, pc); err != nil {
 			return fmt.Errorf("failed to unmarshal provision config: %v", err)
 		}
+		pc.Name = guest
 
 		gc := &virgo.GuestConf{}
 		if err := json.Unmarshal(data, gc); err != nil {
 			return fmt.Errorf("failed to unmarshal guest config: %v", err)
 		}
 		gc.Name = guest
 
-		data, err = ioutil.ReadFile(scriptFile)
+		data, err = ioutil.ReadFile(provisionScript)
 		if err != nil {
-			return fmt.Errorf("failed to read provision script %s: %v", scriptFile, err)
+			return fmt.Errorf("failed to read provision script %s: %v", provisionScript, err)
 		}
 		pc.Provision = string(data)
 
+
+		if initdScript != "" {
+			data, err = ioutil.ReadFile(initdScript)
+			if err != nil {
+				return fmt.Errorf("failed to read initd script %s: %v", initdScript, err)
+			}
+			pc.Initd = string(data)
+		}
+
 		l, err := virgo.NewLibvirtConn()
 		if err != nil {
 			return fmt.Errorf("failed to open Libvirt connection: %v", err)
@@ -76,7 +91,10 @@ The bash script can be any valid bash script and is executed with root permissio
 
 func init() {
 	provisionCmd.Flags().StringP("guest", "g", "", "guest to provision")
-	provisionCmd.Flags().StringP("script", "s", "", "bash script to be used for provisioning")
+	provisionCmd.Flags().StringP("provision-script", "p", "", "bash script to be used for provisioning")
+	provisionCmd.Flags().StringP("initd-script", "i", "", "bash script to be used in init.d")
 	provisionCmd.Flags().StringP("config", "c", "", "JSON file containing the provisioning options")
+	provisionCmd.MarkFlagRequired("config")
+	provisionCmd.MarkFlagRequired("guest")
 	rootCmd.AddCommand(provisionCmd)
 }
diff --git a/cmd/purge.go b/cmd/purge.go
@@ -41,5 +41,6 @@ var purgeCmd = &cobra.Command{
 
 func init() {
 	purgeCmd.Flags().StringP("guest", "g", "", "guest to purge")
+	purgeCmd.MarkFlagRequired("guest")
 	rootCmd.AddCommand(purgeCmd)
 }
diff --git a/cmd/start.go b/cmd/start.go
@@ -39,5 +39,6 @@ either via 'provision' or 'launch'`,
 
 func init() {
 	startCmd.Flags().StringP("guest", "g", "", "guest to start")
+	startCmd.MarkFlagRequired("guest")
 	rootCmd.AddCommand(startCmd)
 }
diff --git a/cmd/stop.go b/cmd/stop.go
@@ -37,5 +37,6 @@ var stopCmd = &cobra.Command{
 
 func init() {
 	stopCmd.Flags().StringP("guest", "g", "", "guest to stop")
+	stopCmd.MarkFlagRequired("guest")
 	rootCmd.AddCommand(stopCmd)
 }
diff --git a/cmd/undefine.go b/cmd/undefine.go
@@ -39,5 +39,6 @@ If it's running, the domain is first stopped.'`,
 
 func init() {
 	undefineCmd.Flags().StringP("guest", "g", "", "guest to undefine")
+	undefineCmd.MarkFlagRequired("guest")
 	rootCmd.AddCommand(undefineCmd)
 }
diff --git a/pkg/virgo/virgo.go b/pkg/virgo/virgo.go
@@ -18,23 +18,27 @@ import (
 
 var metaDataFmt = `
 instance-id: iid-%s;
-#hostname: %s
-#local-hostname: %s`
+`
 
-var userDataFmt = `#cloud-config
+var userDataTmpl = `#cloud-config
 users:
-  - name: %s
+  - name: {{.User}}
     lock_passwd: false
     sudo: ALL=(ALL) NOPASSWD:ALL
     shell: /bin/bash
     # this is the outcome of the command openssl passwd -1 -salt SaltSalt $PASSWORD
-    passwd: %s
+    passwd: {{.PasswdHash}}
 
 write_files: 
 - path: /provision.sh
   content: |
-    %s
+    {{.Provision | indentByFour }}
     
+{{- if ne .Initd "" }}
+- path: /etc/init.d/{{.Name}}
+  content: |
+    {{.Initd | indentByFour }}
+{{- end}}
 
 - path: /remove_cloud_init.sh 
   content: |
@@ -44,7 +48,7 @@ write_files:
     sudo rm -rf /etc/cloud/; sudo rm -rf /var/lib/cloud/
 
 
-password: %s
+#password: {{.Passwd}}
 chpasswd: { expire: False }
 ssh_pwauth: True
 
@@ -56,6 +60,10 @@ apt_upgrade: true
 
 runcmd:
   - bash /provision.sh
+{{- if ne .Initd "" }}  
+  - chmod +x /etc/init.d/{{.Name}}
+  - update-rc.d {{.Name}} defaults
+{{- end}}  
   - bash /remove_cloud_init.sh
   - shutdown
 
@@ -64,12 +72,15 @@ power_state:
 `
 
 type ProvisionConf struct {
+	Name         string `json:"name"`
 	CloudImgURL  string `json:"cloud_img_url"`
 	CloudImgName string `json:"cloud_img_name"`
 	User         string `json:"user"`
 	Passwd       string `json:"passwd"`
 	RootImgGB    int    `json:"root_img_gb"`
 	Provision    string
+	Initd        string
+	PasswdHash   string
 }
 
 type NetIf struct {
@@ -94,40 +105,62 @@ type GuestConf struct {
 }
 
 func createMetaDataFile(path, guest string) error {
-	s := fmt.Sprintf(metaDataFmt, guest, guest, guest)
+	s := fmt.Sprintf(metaDataFmt, guest)
 	if err := ioutil.WriteFile(path, []byte(s), 0644); err != nil {
 		return err
 	}
 	return nil
 }
 
-func createUserDataFile(path, user, passwd, script string) error {
-	cmd := exec.Command("openssl", "passwd", "-1", "-salt", "SaltSalt", passwd)
-	hash, err := cmd.CombinedOutput()
+func indentByFour(s string) string {
+	return regexp.MustCompile("\n").ReplaceAllString(s, "\n    ")
+}
+
+func userData(p *ProvisionConf) (string, error) {
+	t, err := template.New("udtmpl").
+		Funcs(template.FuncMap{"indentByFour": indentByFour}).
+		Parse(userDataTmpl)
+	if err != nil {
+		return "", fmt.Errorf("failed to parse template: %v", err)
+	}
+
+	var xml bytes.Buffer
+	if err := t.Execute(&xml, p); err != nil {
+		return "", fmt.Errorf("failed to execute template: %v", err)
+	}
+
+	return xml.String(), nil
+}
+
+func createUserDataFile(path string, p *ProvisionConf) error {
+	cmd := exec.Command("openssl", "passwd", "-1", "-salt", "SaltSalt", p.Passwd)
+	out, err := cmd.CombinedOutput()
 	if err != nil {
 		return fmt.Errorf("failed to executed %v: %v", cmd.Args, err)
 	}
 
-	re := regexp.MustCompile("\n")
-	indentedScript := re.ReplaceAllString(script, "\n    ")
-	s := fmt.Sprintf(userDataFmt, user, hash, indentedScript, passwd)
+	p.PasswdHash = string(out)
+
+	s, err := userData(p)
+	if err != nil {
+		return fmt.Errorf("failed to create user-data string from config %+v: %v", p, err)
+	}
 
 	if err := ioutil.WriteFile(path, []byte(s), 0644); err != nil {
 		return err
 	}
 	return nil
 }
 
-func createConfigIsoImage(path, guest, user, passwd, prov string) error {
-	var metaDataPath = "meta-data"
-	var userDataPath = "user-data"
-
-	if err := createMetaDataFile(metaDataPath, guest); err != nil {
+func createConfigIsoImage(path string, p *ProvisionConf) error {
+	userDataPath := "user-data"
+	metaDataPath := "meta-data"
+	if err := createMetaDataFile(metaDataPath, p.Name); err != nil {
 		return fmt.Errorf("failed to create meta-data file for cloud-init: %v", err)
 	}
 	//defer os.Remove(metaDataPath)
 
-	if err := createUserDataFile(userDataPath, user, passwd, prov); err != nil {
+	if err := createUserDataFile(userDataPath, p); err != nil {
 		return fmt.Errorf("failed to create user-data file for cloud-init: %v", err)
 	}
 	//defer os.Remove(userDataPath)
@@ -168,13 +201,13 @@ var domTmpl = `
   	<currentMemory unit='MiB'>{{.MemoryMB}}</currentMemory>
 
 	<!-- hugepages -->
-	{{if .HugepageSupport}}
+	{{- if .HugepageSupport}}
 	<memoryBacking>
 	<hugepages>
 		<page size='{{.HugepageSize}}' unit='{{.HugepageSizeUnit}}' nodeset='{{.HugepageNodeSet}}'/>
 	</hugepages>
 	</memoryBacking>
-	{{end}}
+	{{- end}}
 
 	<vcpu placement='static'>{{.NumVcpus}}</vcpu>
 	<!-- cputune><shares>4096</shares>
@@ -322,7 +355,7 @@ func GuestImagePaths(l *libvirt.Libvirt, poolName, guest string) (rootImgPath, c
 	return
 }
 
-func createVolumes(l *libvirt.Libvirt, guest string, c *ProvisionConf) (rootImgPath, configIsoPath string, e error) {
+func createVolumes(l *libvirt.Libvirt, c *ProvisionConf) (rootImgPath, configIsoPath string, e error) {
 	baseu, err := url.Parse(c.CloudImgURL)
 	if err != nil {
 		e = err
@@ -341,18 +374,18 @@ func createVolumes(l *libvirt.Libvirt, guest string, c *ProvisionConf) (rootImgP
 		return
 	}
 
-	rootImgPath, configIsoPath, err = GuestImagePaths(l, DefaultPool(), guest)
+	rootImgPath, configIsoPath, err = GuestImagePaths(l, DefaultPool(), c.Name)
 	if err != nil {
 		e = fmt.Errorf("failed to compute guest image paths: %v", err)
 		return
 	}
 
-	if err := createConfigIsoImage(ConfigIsoName(guest), guest, c.User, c.Passwd, c.Provision); err != nil {
-		e = fmt.Errorf("failed to create configuration iso image %s: %v", ConfigIsoName, err)
+	if err := createConfigIsoImage(ConfigIsoName(c.Name), c); err != nil {
+		e = fmt.Errorf("failed to create configuration iso image %s: %v", ConfigIsoName(c.Name), err)
 		return
 	}
 
-	if err := copyFile(ConfigIsoName(guest), configIsoPath); err != nil {
+	if err := copyFile(ConfigIsoName(c.Name), configIsoPath); err != nil {
 		e = fmt.Errorf("failed to copy configuration iso under storage pool's directory: %v", err)
 		return
 	}
@@ -373,9 +406,9 @@ func createVolumes(l *libvirt.Libvirt, guest string, c *ProvisionConf) (rootImgP
 		return
 	}
 
-	vol, err := l.StorageVolLookupByName(pool, RootImgName(guest))
+	vol, err := l.StorageVolLookupByName(pool, RootImgName(c.Name))
 	if err != nil {
-		e = fmt.Errorf("failed to lookup storage volume %s under pool %s: %v", RootImgName, pool.Name, err)
+		e = fmt.Errorf("failed to lookup storage volume %s under pool %s: %v", RootImgName(c.Name), pool.Name, err)
 		return
 	}
 
@@ -422,7 +455,7 @@ func ConfigIsoName(guest string) string {
 
 func Provision(l *libvirt.Libvirt, p *ProvisionConf, g *GuestConf) error {
 	var err error
-	g.RootImgPath, g.ConfigIsoPath, err = createVolumes(l, g.Name, p)
+	g.RootImgPath, g.ConfigIsoPath, err = createVolumes(l, p)
 	if err != nil {
 		return fmt.Errorf("failed to create volumes: %v", err)
 	}
diff --git a/pkg/virgo/virgo_test.go b/pkg/virgo/virgo_test.go
@@ -12,8 +12,8 @@ func TestDomXMLStr(t *testing.T) {
 		HugepageSize:     2,
 		HugepageSizeUnit: "MB",
 		HugepageNodeSet:  "0",
-		rootImgPath:      "foo.img",
-		configIsoPath:    "foo.iso",
+		RootImgPath:      "foo.img",
+		ConfigIsoPath:    "foo.iso",
 		NetIfs: []NetIf{
 			{Type: "bridge", Bridge: "virbr0"},
 			{Type: "bridge", Bridge: "virbr0"},
@@ -32,11 +32,28 @@ func TestDomXMLStr(t *testing.T) {
 		},
 	}
 
-	t.Logf("Domain XML string: %s", domXMLStr("foo", s))
+	xml, err := domXML(s)
+	if err != nil {
+		t.Fatal(err)
+	}
+	t.Logf("Domain XML string: %s", xml)
 }
 
 func TestCreateUserDataFile(t *testing.T) {
-	if err := createUserDataFile("user-data", "nfvsap", "nfvsap", "echo hello\nls *"); err != nil {
+	p := &ProvisionConf{Name: "test",
+		CloudImgURL:  "https://cloud-images.ubuntu.com/releases/16.04/release/",
+		CloudImgName: "ubuntu-16.04-server-cloudimg-amd64-disk1.img",
+		User:         "nfvsap",
+		Passwd:       "nfvsap",
+	}
+
+	p.Provision = `#/bin/bash
+echo Hello
+echo Hello again`
+
+	p.Initd = p.Provision
+
+	if err := createUserDataFile("user-data", p); err != nil {
 		t.Fatal(err)
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -41,5 +41,6 @@ var purgeCmd = &cobra.Command{`
`41`	`41`
`42`	`42`	`func init() {`
`43`	`43`	`purgeCmd.Flags().StringP("guest", "g", "", "guest to purge")`
	`44`	`+ purgeCmd.MarkFlagRequired("guest")`
`44`	`45`	`rootCmd.AddCommand(purgeCmd)`
`45`	`46`	`}`
Original file line number	Diff line number	Diff line change
@@ -39,5 +39,6 @@ either via 'provision' or 'launch'`,
`39`	`39`
`40`	`40`	`func init() {`
`41`	`41`	`startCmd.Flags().StringP("guest", "g", "", "guest to start")`
	`42`	`+ startCmd.MarkFlagRequired("guest")`
`42`	`43`	`rootCmd.AddCommand(startCmd)`
`43`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,5 +37,6 @@ var stopCmd = &cobra.Command{`
`37`	`37`
`38`	`38`	`func init() {`
`39`	`39`	`stopCmd.Flags().StringP("guest", "g", "", "guest to stop")`
	`40`	`+ stopCmd.MarkFlagRequired("guest")`
`40`	`41`	`rootCmd.AddCommand(stopCmd)`
`41`	`42`	`}`
Original file line number	Diff line number	Diff line change
@@ -39,5 +39,6 @@ If it's running, the domain is first stopped.'`,
`39`	`39`
`40`	`40`	`func init() {`
`41`	`41`	`undefineCmd.Flags().StringP("guest", "g", "", "guest to undefine")`
	`42`	`+ undefineCmd.MarkFlagRequired("guest")`
`42`	`43`	`rootCmd.AddCommand(undefineCmd)`
`43`	`44`	`}`