Add support for NUMA topologies

Author: anastop

README.md

@@ -13,13 +13,13 @@ Libvirt.
 - 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:
-- cloud image used for provisioning (currently tested with Ubuntu 16.04)
+- cloud image used for provisioning (currently tested with Ubuntu 16.04 & 18.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
+- number and topology of vCPUs
 - guest memory
 - hugepage backing options
 - network interfaces: support for `bridge`-type and `vhostuser`-type interfaces
@@ -42,88 +42,27 @@ virgo makes use of the following utilities:
 
 ## Usage 
 
-Provision a new VM called "foo":
-```console
-$ sudo virgo provision foo --config guest_config.json --provision-script provision.sh --initd-script initd.sh
+```console 
+$ virgo init
 ```
-"foo" will shutdown after provisioning. 
 
-Edit `guest_config.json` to change VM's parameters (e.g. #vCPUs), and launch "foo":
-```console
-$ sudo virgo launch foo --config guest_config.json
-```
+Edit the created `virgo.json` according to your needs.
 
-Usage:
-```console
-$ virgo --help
-
-virgo enables easy provisioning, configuration and management of Libvirt guests.
-
-For provisioning a new VM image, you should specify a JSON config file with provisioning
-options, along with a provisioning script to be executed on image's first boot.
-
-For launching a new VM instance from an already-provisioned image, you should specify a
-JSON config file with launch options.
-
-The example below shows all available provisioning and launch options, all in a single
-JSON file (ignore the '#' lines which serve as comments).
-
-{
-  # PROVISIONING OPTIONS
-  "cloud_img_url": "https://cloud-images.ubuntu.com/releases/16.04/release/",
-  "cloud_img_name": "ubuntu-16.04-server-cloudimg-amd64-disk1.img",
-  "user": "nfvsap",
-  "passwd": "nfvsap",
-  "root_img_gb": 10,
-
-  # LAUNCH OPTIONS
-  "guest_memory_mb": 4096,
-  "guest_num_vcpus": 8,
-  "guest_hugepage_support": true,
-  "guest_hugepage_size": 2,
-  "guest_hugepage_size_unit": "M",
-  "guest_hugepage_node_set": "0",
-  "guest_net_ifs": [
-    {"type": "bridge", "bridge": "virbr0"},
-    {"type": "bridge", "bridge": "virbr0"},
-    {
-      "type": "vhostuser",
-      "mac_addr": "de:ad:be:ef:01:23",
-      "unix_socket_path": "/usr/local/var/run/openvswitch/dpdkvhostuser1",
-      "queues": 2
-    },
-    {
-      "type": "vhostuser",
-      "mac_addr": "de:ad:be:ef:45:67",
-      "unix_socket_path": "/usr/local/var/run/openvswitch/dpdkvhostuser2",
-      "queues": 2
-    }]
-}
-
-The provisioning script can be any valid bash script, and it's executed as the
-last step of cloud-init provisioning.
-
-PREREQUISITES
-The following Linux utilities are required by virgo:
-- wget
-- genisoimage
+Optionally, create additional `provision.sh` and `initd.sh` files to be used as provisioning 
+and initd scripts, respectively.
 
-Usage:
-  virgo [command]
+Provision a new VM called "foo":
 
-Available Commands:
-  help        Help about any command
-  launch      Define and start a new VM instance
-  provision   Provision a new VM image
-  purge       Fully destroy a VM by undefining it and removing its image
-  start       Create a new VM instance from an already existing specification
-  stop        Shut down a running VM instance
-  undefine    Undefine a VM by removing its specification
+```console
+$ sudo virgo provision foo --config virgo.json [--provision-script provision.sh] [--initd-script initd.sh]
+```
 
-Flags:
-  -h, --help   help for virgo
+"foo" will shutdown after provisioning. 
 
-Use "virgo [command] --help" for more information about a command.
-```
+Edit `virgo.json` to change VM's parameters (e.g. #vCPUs), and launch "foo":
 
+```console
+$ sudo virgo launch foo --config virgo.json
+```
 
+To find out more, run `virgo -h`. 

cmd/init.go

@@ -0,0 +1,34 @@
+package cmd
+
+import (
+	"fmt"
+	"io/ioutil"
+	"os"
+
+	"github.com/spf13/cobra"
+)
+
+// initCmd represents the init command
+var initCmd = &cobra.Command{
+	Use:   "init",
+	Short: "Create sample configuration files and scripts",
+	Long:  `Create sample configuration files and scripts.`,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		configFile := "virgo.json"
+
+		if _, err := os.Stat(configFile); err == nil {
+			return fmt.Errorf("file %s already exists", configFile)
+		}
+
+		err := ioutil.WriteFile(configFile, []byte(sampleConfig), 0644)
+		if err != nil {
+			return fmt.Errorf("failed to create %s: %v", configFile, err)
+		}
+
+		return nil
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(initCmd)
+}

cmd/provision.go

@@ -3,10 +3,11 @@ package cmd
 import (
 	"encoding/json"
 	"fmt"
-	"github.com/anastop/virgo/pkg/virgo"
 	"io/ioutil"
 	"log"
 
+	"github.com/anastop/virgo/pkg/virgo"
+
 	"github.com/spf13/cobra"
 )
 
@@ -54,12 +55,13 @@ The bash script can be any valid bash script and is executed with root permissio
 		}
 		gc.Name = guest
 
-		data, err = ioutil.ReadFile(provisionScript)
-		if err != nil {
-			return fmt.Errorf("failed to read provision script %s: %v", provisionScript, err)
+		if provisionScript != "" {
+			data, err = ioutil.ReadFile(provisionScript)
+			if err != nil {
+				return fmt.Errorf("failed to read provision script %s: %v", provisionScript, err)
+			}
+			pc.Provision = string(data)
 		}
-		pc.Provision = string(data)
-
 
 		if initdScript != "" {
 			data, err = ioutil.ReadFile(initdScript)

cmd/root.go

@@ -7,35 +7,23 @@ import (
 	"github.com/spf13/cobra"
 )
 
-// rootCmd represents the base command when called without any subcommands
-var rootCmd = &cobra.Command{
-	Use:   "virgo",
-	Short: "virgo enables easy provisioning, configuration and management of Libvirt guests",
-	Long: `virgo enables easy provisioning, configuration and management of Libvirt guests. 
-
-All virgo commands accept a single argument, the name of the VM they act upon. Every command
-has its own flags. 
-
-For provisioning a new VM image, you should specify a JSON config file with provisioning
-options, along with a provisioning script to be executed on image's first boot.
-
-For launching a new VM instance from an already-provisioned image, you should specify a 
-JSON config file with launch options. 
-
-The example below shows all available provisioning and launch options, all in a single
-JSON file (ignore the '#' lines which serve as comments). 
-
+var sampleConfig = `
 {
-  # PROVISIONING OPTIONS
-  "cloud_img_url": "https://cloud-images.ubuntu.com/releases/16.04/release/",
-  "cloud_img_name": "ubuntu-16.04-server-cloudimg-amd64-disk1.img",
-  "user": "nfvsap",
-  "passwd": "nfvsap",
+  "cloud_img_url": "https://cloud-images.ubuntu.com/releases/18.04/release/",
+  "cloud_img_name": "ubuntu-18.04-server-cloudimg-amd64.img",
+  "user": "guest",
+  "passwd": "guest",
   "root_img_gb": 10,
 
-  # LAUNCH OPTIONS
   "guest_memory_mb": 4096,
   "guest_num_vcpus": 8,
+  "guest_num_sockets": 2,
+  "guest_num_cores_per_socket": 2,
+  "guest_num_threads_per_core": 2,
+  "guest_numa_nodes": [ 
+    {"id": 0, "cpus": "0-3", "memory_mb": 2048 },
+    {"id": 1, "cpus": "4-7", "memory_mb": 2048 }
+  ],
   "guest_hugepage_support": true,
   "guest_hugepage_size": 2,
   "guest_hugepage_size_unit": "M",
@@ -56,6 +44,28 @@ JSON file (ignore the '#' lines which serve as comments).
       "queues": 2
     }]
 }
+`
+
+// rootCmd represents the base command when called without any subcommands
+var rootCmd = &cobra.Command{
+	Use:   "virgo",
+	Short: "virgo enables easy provisioning, configuration and management of Libvirt guests",
+	Long: `virgo enables easy provisioning, configuration and management of Libvirt guests. 
+
+Most virgo commands accept a single argument, the name of the VM they act upon. Every command
+has its own flags. 
+
+For provisioning a new VM image, you should specify a JSON config file with provisioning
+options. Additionally, you may specify a provisioning script to be executed on image's first boot,
+and/or an initd script with commands to be executed on every boot. 
+
+For launching a new VM instance from an already-provisioned image, you should specify a 
+JSON config file with launch options. 
+
+The example below shows all available provisioning and launch options, all in a single JSON file
+(these groups of options are separated by an empty line).
+
+` + sampleConfig + `
 
 The provisioning script can be any valid bash script, and it's executed as the 
 last step of cloud-init provisioning.