Clarify path details for VM-based runtime configuration.

All paths specified in the configuration for virtual-machine-based
runtimes are host-side.

Signed-off-by: James O. D. Hunt <[email protected]>

Author: James O. D. Hunt

config-vm.md

@@ -4,13 +4,13 @@ Virtual-machine-based runtimes require additional configuration to that specifie
 
 This optional configuration is specified in a "VM" object:
 
-* **`imagePath`** (string, required) path to file that represents the root filesystem for the virtual machine.
+* **`imagePath`** (string, required) host path to file that represents the root filesystem for the virtual machine.
 * **`kernel`** (object, required) specifies details of the kernel to boot the virtual machine with.
 
 Note that `imagePath` refers to a path on the host (outside of the virtual machine).
 This field is distinct from the **`path`** field in the [Root Configuration](config.md#Root-Configuration) section since in the context of a virtual-machine-based runtime:
 
-* **`imagePath`** will represent the root filesystem for the virtual machine.
+* **`imagePath`** will represent the host path to the root filesystem for the virtual machine.
 * The container root filesystem specified by **`path`** from the [Root Configuration](config.md#Root-Configuration) section will be mounted inside the virtual machine at a location chosen by the virtual-machine-based runtime.
 
 The virtual-machine-based runtime will use these two path fields to arrange for the **`path`** from the [Root Configuration](config.md#Root-Configuration) section to be presented to the process to run as the root filesystem.
@@ -19,9 +19,9 @@ The virtual-machine-based runtime will use these two path fields to arrange for
 
 Used by virtual-machine-based runtimes only.
 
-* **`path`** (string, required) specifies the path to the kernel used to boot the virtual machine.
+* **`path`** (string, required) specifies the host path to the kernel used to boot the virtual machine.
 * **`parameters`** (string, optional) specifies a space-separated list of parameters to pass to the kernel.
-* **`initrd`** (string, optional) specifies the path to an initial ramdisk to be used by the virtual machine.
+* **`initrd`** (string, optional) specifies the host path to an initial ramdisk to be used by the virtual machine.
 
 ## Example of a fully-populated `VM` object
 

schema/schema-vm.json

@@ -9,7 +9,7 @@
         ],
         "properties": {
             "imagePath": {
-                "description": "path to rootfs image on host system which is used for VM-based runtimes",
+                "description": "host path to rootfs image on host system which is used for VM-based runtimes",
                 "id": "https://opencontainers.org/schema/bundle/vm/imagePath",
                 "type": "string"
             },
@@ -23,7 +23,7 @@
                 "properties": {
                     "path": {
                         "id": "https://opencontainers.org/schema/bundle/vm/kernel/path",
-                        "description": "path to kernel image",
+                        "description": "host path to kernel image",
                         "type": "string"
                     },
                     "parameters": {
@@ -32,7 +32,7 @@
                         "type": "string"
                     },
                     "initrd": {
-                        "description": "path to initial ramdisk image",
+                        "description": "host path to initial ramdisk image",
                         "id": "https://opencontainers.org/schema/bundle/vm/kernel/initrd",
                         "type": "string"
                     }

specs-go/config.go

@@ -33,17 +33,17 @@ type Spec struct {
 type VM struct {
 	// Kernel specifies kernel-related configuration for virtual-machine-based runtimes.
 	Kernel Kernel `json:"kernel"`
-	// ImagePath is the path to the root filesystem image on the host which can be used by a virtual-machine-based runtime.
+	// ImagePath is the host path to the root filesystem image on the host which can be used by a virtual-machine-based runtime.
 	ImagePath string `json:"imagePath"`
 }
 
 // Kernel contains information about the kernel to use for a virtual machine.
 type Kernel struct {
-	// Path is the path to the kernel used to boot the virtual machine.
+	// Path is the host path to the kernel used to boot the virtual machine.
 	Path string `json:"path"`
 	// Parameters specifies parameters to pass to the kernel.
 	Parameters string `json:"parameters,omitempty"`
-	// InitRd is the path to an initial ramdisk to be used by the kernel.
+	// InitRd is the host path to an initial ramdisk to be used by the kernel.
 	InitRd string `json:"initrd,omitempty"`
 }