Merge pull request #672 from q384566678/add-generate-option

Add generate option

Author: liangchenye

cmd/oci-runtime-tool/generate.go

@@ -126,6 +126,14 @@ var generateFlags = []cli.Flag{
 	cli.StringFlag{Name: "solaris-max-shm-memory", Usage: "Specifies the maximum amount of shared memory"},
 	cli.StringFlag{Name: "solaris-milestone", Usage: "Specifies the SMF FMRI"},
 	cli.StringFlag{Name: "template", Usage: "base template to use for creating the configuration"},
+	cli.StringFlag{Name: "vm-hypervisor-parameters", Usage: "specifies an array of parameters to pass to the hypervisor"},
+	cli.StringFlag{Name: "vm-hypervisor-path", Usage: "specifies the path to the hypervisor binary that manages the container virtual machine"},
+	cli.StringFlag{Name: "vm-image-format", Usage: "set the format of the container virtual machine root image"},
+	cli.StringFlag{Name: "vm-image-path", Usage: "set path to the container virtual machine root image"},
+	cli.StringFlag{Name: "vm-kernel-initrd", Usage: "set path to an initial ramdisk to be used by the container virtual machine"},
+	cli.StringFlag{Name: "vm-kernel-parameters", Usage: "specifies an array of parameters to pass to the kernel"},
+	cli.StringFlag{Name: "vm-kernel-path", Usage: "set path to the kernel used to boot the container virtual machine"},
+	cli.StringSliceFlag{Name: "windows-devices", Usage: "specifies a list of devices to be mapped into the container"},
 	cli.StringFlag{Name: "windows-hyperv-utilityVMPath", Usage: "specifies the path to the image used for the utility VM"},
 	cli.BoolFlag{Name: "windows-ignore-flushes-during-boot", Usage: "ignore flushes during boot"},
 	cli.StringSliceFlag{Name: "windows-layer-folders", Usage: "specifies a list of layer folders the container image relies on"},
@@ -862,6 +870,44 @@ func setupSpec(g *generate.Generator, context *cli.Context) error {
 		g.SetSolarisMilestone(context.String("solaris-milestone"))
 	}
 
+	if context.IsSet("vm-hypervisor-path") {
+		if err := g.SetVMHypervisorPath(context.String("vm-hypervisor-path")); err != nil {
+			return err
+		}
+	}
+
+	if context.IsSet("vm-hypervisor-parameters") {
+		g.SetVMHypervisorParameters(context.String("vm-hypervisor-parameters"))
+	}
+
+	if context.IsSet("vm-kernel-path") {
+		if err := g.SetVMKernelPath(context.String("vm-kernel-path")); err != nil {
+			return err
+		}
+	}
+
+	if context.IsSet("vm-kernel-parameters") {
+		g.SetVMKernelParameters(context.String("vm-kernel-parameters"))
+	}
+
+	if context.IsSet("vm-kernel-initrd") {
+		if err := g.SetVMKernelInitRD(context.String("vm-kernel-initrd")); err != nil {
+			return err
+		}
+	}
+
+	if context.IsSet("vm-image-path") {
+		if err := g.SetVMImagePath(context.String("vm-image-path")); err != nil {
+			return err
+		}
+	}
+
+	if context.IsSet("vm-image-format") {
+		if err := g.SetVMImageFormat(context.String("vm-image-format")); err != nil {
+			return err
+		}
+	}
+
 	if context.IsSet("windows-hyperv-utilityVMPath") {
 		g.SetWindowsHypervUntilityVMPath(context.String("windows-hyperv-utilityVMPath"))
 	}
@@ -877,6 +923,19 @@ func setupSpec(g *generate.Generator, context *cli.Context) error {
 		}
 	}
 
+	if context.IsSet("windows-devices") {
+		devices := context.StringSlice("windows-devices")
+		for _, device := range devices {
+			id, idType, err := parseWindowsDevices(device)
+			if err != nil {
+				return err
+			}
+			if err := g.AddWindowsDevices(id, idType); err != nil {
+				return err
+			}
+		}
+	}
+
 	if context.IsSet("windows-network") {
 		network := context.String("windows-network")
 		tmpNetwork := rspec.WindowsNetwork{}
@@ -1028,6 +1087,17 @@ func parseNamespace(ns string) (string, string, error) {
 	return nsType, nsPath, nil
 }
 
+func parseWindowsDevices(device string) (string, string, error) {
+	parts := strings.Split(device, ":")
+	if len(parts) != 2 {
+		return "", "", fmt.Errorf("invalid windows device value: %s", device)
+	}
+
+	id := parts[0]
+	idType := parts[1]
+	return id, idType, nil
+}
+
 var deviceType = map[string]bool{
 	"b": true, // a block (buffered) special file
 	"c": true, // a character special file

completions/bash/oci-runtime-tool

@@ -396,8 +396,16 @@ _oci-runtime-tool_generate() {
 		--solaris-capped-memory-swap
 		--solaris-limitpriv1
 		--solaris-max-shm-memory
-		 --solaris-milestone
+		--solaris-milestone
 		--template
+		--vm-hypervisor-parameters
+		--vm-hypervisor-path
+		--vm-image-format
+		--vm-image-path
+		--vm-kernel-initrd
+		--vm-kernel-parameters
+		--vm-kernel-path
+		--windows-devices
 		--windows-hyperv-utilityVMPath
 		--windows-layer-folders
 		--windows-network

generate/config.go

@@ -178,3 +178,31 @@ func (g *Generator) initConfigWindowsResourcesMemory() {
 		g.Config.Windows.Resources.Memory = &rspec.WindowsMemoryResources{}
 	}
 }
+
+func (g *Generator) initConfigVM() {
+	g.initConfig()
+	if g.Config.VM == nil {
+		g.Config.VM = &rspec.VM{}
+	}
+}
+
+func (g *Generator) initConfigVMHypervisor() {
+	g.initConfigVM()
+	if &g.Config.VM.Hypervisor == nil {
+		g.Config.VM.Hypervisor = rspec.VMHypervisor{}
+	}
+}
+
+func (g *Generator) initConfigVMKernel() {
+	g.initConfigVM()
+	if &g.Config.VM.Kernel == nil {
+		g.Config.VM.Kernel = rspec.VMKernel{}
+	}
+}
+
+func (g *Generator) initConfigVMImage() {
+	g.initConfigVM()
+	if &g.Config.VM.Image == nil {
+		g.Config.VM.Image = rspec.VMImage{}
+	}
+}

generate/generate.go

@@ -1533,6 +1533,74 @@ func (g *Generator) SetSolarisMilestone(milestone string) {
 	g.Config.Solaris.Milestone = milestone
 }
 
+// SetVMHypervisorPath sets g.Config.VM.Hypervisor.Path
+func (g *Generator) SetVMHypervisorPath(path string) error {
+	if !strings.HasPrefix(path, "/") {
+		return fmt.Errorf("hypervisorPath %v is not an absolute path", path)
+	}
+	g.initConfigVMHypervisor()
+	g.Config.VM.Hypervisor.Path = path
+	return nil
+}
+
+// SetVMHypervisorParameters sets g.Config.VM.Hypervisor.Parameters
+func (g *Generator) SetVMHypervisorParameters(parameters string) {
+	g.initConfigVMHypervisor()
+	g.Config.VM.Hypervisor.Parameters = parameters
+}
+
+// SetVMKernelPath sets g.Config.VM.Kernel.Path
+func (g *Generator) SetVMKernelPath(path string) error {
+	if !strings.HasPrefix(path, "/") {
+		return fmt.Errorf("kernelPath %v is not an absolute path", path)
+	}
+	g.initConfigVMKernel()
+	g.Config.VM.Kernel.Path = path
+	return nil
+}
+
+// SetVMKernelParameters sets g.Config.VM.Kernel.Parameters
+func (g *Generator) SetVMKernelParameters(parameters string) {
+	g.initConfigVMKernel()
+	g.Config.VM.Kernel.Parameters = parameters
+}
+
+// SetVMKernelInitRD sets g.Config.VM.Kernel.InitRD
+func (g *Generator) SetVMKernelInitRD(initrd string) error {
+	if !strings.HasPrefix(initrd, "/") {
+		return fmt.Errorf("kernelInitrd %v is not an absolute path", initrd)
+	}
+	g.initConfigVMKernel()
+	g.Config.VM.Kernel.InitRD = initrd
+	return nil
+}
+
+// SetVMImagePath sets g.Config.VM.Image.Path
+func (g *Generator) SetVMImagePath(path string) error {
+	if !strings.HasPrefix(path, "/") {
+		return fmt.Errorf("imagePath %v is not an absolute path", path)
+	}
+	g.initConfigVMImage()
+	g.Config.VM.Image.Path = path
+	return nil
+}
+
+// SetVMImageFormat sets g.Config.VM.Image.Format
+func (g *Generator) SetVMImageFormat(format string) error {
+	switch format {
+	case "raw":
+	case "qcow2":
+	case "vdi":
+	case "vmdk":
+	case "vhd":
+	default:
+		return fmt.Errorf("Commonly supported formats are: raw, qcow2, vdi, vmdk, vhd")
+	}
+	g.initConfigVMImage()
+	g.Config.VM.Image.Format = format
+	return nil
+}
+
 // SetWindowsHypervUntilityVMPath sets g.Config.Windows.HyperV.UtilityVMPath.
 func (g *Generator) SetWindowsHypervUntilityVMPath(path string) {
 	g.initConfigWindowsHyperV()
@@ -1551,6 +1619,27 @@ func (g *Generator) AddWindowsLayerFolders(folder string) {
 	g.Config.Windows.LayerFolders = append(g.Config.Windows.LayerFolders, folder)
 }
 
+// AddWindowsDevices adds or sets g.Config.Windwos.Devices
+func (g *Generator) AddWindowsDevices(id, idType string) error {
+	if idType != "class" {
+		return fmt.Errorf("Invalid idType value: %s. Windows only supports a value of class", idType)
+	}
+	device := rspec.WindowsDevice{
+		ID:     id,
+		IDType: idType,
+	}
+
+	g.initConfigWindows()
+	for i, device := range g.Config.Windows.Devices {
+		if device.ID == id {
+			g.Config.Windows.Devices[i].IDType = idType
+			return nil
+		}
+	}
+	g.Config.Windows.Devices = append(g.Config.Windows.Devices, device)
+	return nil
+}
+
 // SetWindowsNetwork sets g.Config.Windows.Network.
 func (g *Generator) SetWindowsNetwork(network rspec.WindowsNetwork) {
 	g.initConfigWindows()

man/oci-runtime-tool-generate.1.md

@@ -505,6 +505,30 @@ read the configuration from `config.json`.
   Additional options will only adjust the relevant portions of your template.
   Templates are not validated for correctness, so the user should ensure that they are correct.
 
+**--vm-hypervisor-parameters**=""
+  Specifies an array of parameters to pass to the hypervisor.
+
+**--vm-hypervisor-path**=PATH
+  Specifies the path to the hypervisor binary that manages the container virtual machine.
+
+**--vm-image-format**=""
+  Set the format of the container virtual machine root image.
+
+**--vm-image-path**=PATH
+  Set path to the container virtual machine root image.
+
+**--vm-kernel-initrd**=""
+  Set path to an initial ramdisk to be used by the container virtual machine.
+
+**--vm-kernel-parameters**=""
+  Specifies an array of parameters to pass to the kernel.
+
+**--vm-kernel-path**=PATH
+  Set path to the kernel used to boot the container virtual machine.
+
+**--windows-devices**=[]
+  Specifies devices that MUST be available in the container.
+
 **--windows-hyperv-utilityVMPath**=PATH
   Specifies the path to the image used for the utility VM.