Merge pull request #167 from smira/update-swagger

Update Swagger API spec to include new option, InitrdPath

Author: xibz

client/models/boot_source.go

@@ -2,10 +2,10 @@ swagger: "2.0"
 info:
   title: Firecracker API
   description: RESTful public-facing API.
-    The API is accessible through HTTP calls on specific URLs
-    carrying JSON modeled data.
-    The transport medium is a Unix Domain Socket.
-  version: 0.19.0
+               The API is accessible through HTTP calls on specific URLs
+               carrying JSON modeled data.
+               The transport medium is a Unix Domain Socket.
+  version: 0.20.0
   termsOfService: ""
   contact:
     email: "[email protected]"
@@ -43,11 +43,11 @@ paths:
       summary: Creates a synchronous action.
       operationId: createSyncAction
       parameters:
-        - name: info
-          in: body
-          required: true
-          schema:
-            $ref: "#/definitions/InstanceActionInfo"
+      - name: info
+        in: body
+        required: true
+        schema:
+          $ref: "#/definitions/InstanceActionInfo"
       responses:
         204:
           description: The update was successful
@@ -69,12 +69,12 @@ paths:
         Note that the only currently supported boot source is LocalImage.
       operationId: putGuestBootSource
       parameters:
-        - name: body
-          in: body
-          description: Guest boot source properties
-          required: true
-          schema:
-            $ref: "#/definitions/BootSource"
+      - name: body
+        in: body
+        description: Guest boot source properties
+        required: true
+        schema:
+          $ref: "#/definitions/BootSource"
       responses:
         204:
           description: Boot source created/updated
@@ -96,17 +96,17 @@ paths:
         Will fail if update is not possible.
       operationId: putGuestDriveByID
       parameters:
-        - name: drive_id
-          in: path
-          description: The id of the guest drive
-          required: true
-          type: string
-        - name: body
-          in: body
-          description: Guest drive properties
-          required: true
-          schema:
-            $ref: "#/definitions/Drive"
+      - name: drive_id
+        in: path
+        description: The id of the guest drive
+        required: true
+        type: string
+      - name: body
+        in: body
+        description: Guest drive properties
+        required: true
+        schema:
+          $ref: "#/definitions/Drive"
       responses:
         204:
           description: Drive created/updated
@@ -125,17 +125,17 @@ paths:
         Will fail if update is not possible.
       operationId: patchGuestDriveByID
       parameters:
-        - name: drive_id
-          in: path
-          description: The id of the guest drive
-          required: true
-          type: string
-        - name: body
-          in: body
-          description: Guest drive properties
-          required: true
-          schema:
-            $ref: "#/definitions/PartialDrive"
+      - name: drive_id
+        in: path
+        description: The id of the guest drive
+        required: true
+        type: string
+      - name: body
+        in: body
+        description: Guest drive properties
+        required: true
+        schema:
+          $ref: "#/definitions/PartialDrive"
       responses:
         204:
           description: Drive updated
@@ -149,27 +149,27 @@ paths:
             $ref: "#/definitions/Error"
 
   /logger:
-    put:
-      summary: Initializes the logger by specifying two named pipes (i.e. for the logs and metrics output).
-      operationId: putLogger
-      parameters:
+      put:
+        summary: Initializes the logger by specifying two named pipes (i.e. for the logs and metrics output).
+        operationId: putLogger
+        parameters:
         - name: body
           in: body
           description: Logging system description
           required: true
           schema:
             $ref: "#/definitions/Logger"
-      responses:
-        204:
-          description: Logger created.
-        400:
-          description: Logger cannot be initialized due to bad input.
-          schema:
-            $ref: "#/definitions/Error"
-        default:
-          description: Internal server error.
-          schema:
-            $ref: "#/definitions/Error"
+        responses:
+          204:
+            description: Logger created.
+          400:
+            description: Logger cannot be initialized due to bad input.
+            schema:
+              $ref: "#/definitions/Error"
+          default:
+            description: Internal server error.
+            schema:
+              $ref: "#/definitions/Error"
 
   /machine-config:
     get:
@@ -199,11 +199,11 @@ paths:
         If any of the parameters has an incorrect value, the whole update fails.
       operationId: putMachineConfiguration
       parameters:
-        - name: body
-          in: body
-          description: Machine Configuration Parameters
-          schema:
-            $ref: "#/definitions/MachineConfiguration"
+      - name: body
+        in: body
+        description: Machine Configuration Parameters
+        schema:
+          $ref: "#/definitions/MachineConfiguration"
       responses:
         204:
           description: Machine Configuration created/updated
@@ -223,11 +223,11 @@ paths:
         If any of the parameters has an incorrect value, the whole update fails.
       operationId: patchMachineConfiguration
       parameters:
-        - name: body
-          in: body
-          description: A subset of Machine Configuration Parameters
-          schema:
-            $ref: "#/definitions/MachineConfiguration"
+      - name: body
+        in: body
+        description: A subset of Machine Configuration Parameters
+        schema:
+          $ref: "#/definitions/MachineConfiguration"
       responses:
         204:
           description: Machine Configuration created/updated
@@ -302,17 +302,17 @@ paths:
         Creates new network interface with ID specified by iface_id path parameter.
       operationId: putGuestNetworkInterfaceByID
       parameters:
-        - name: iface_id
-          in: path
-          description: The id of the guest network interface
-          required: true
-          type: string
-        - name: body
-          in: body
-          description: Guest network interface properties
-          required: true
-          schema:
-            $ref: "#/definitions/NetworkInterface"
+      - name: iface_id
+        in: path
+        description: The id of the guest network interface
+        required: true
+        type: string
+      - name: body
+        in: body
+        description: Guest network interface properties
+        required: true
+        schema:
+          $ref: "#/definitions/NetworkInterface"
       responses:
         204:
           description: Network interface created/updated
@@ -362,12 +362,12 @@ paths:
         May fail if update is not possible.
       operationId: putGuestVsock
       parameters:
-        - name: body
-          in: body
-          description: Guest vsock properties
-          required: true
-          schema:
-            $ref: "#/definitions/Vsock"
+      - name: body
+        in: body
+        description: Guest vsock properties
+        required: true
+        schema:
+          $ref: "#/definitions/Vsock"
       responses:
         204:
           description: Vsock created/updated
@@ -391,6 +391,9 @@ definitions:
       kernel_image_path:
         type: string
         description: Host level path to the kernel image used to boot the guest
+      initrd_path:
+        type: string
+        description: Host level path to the initrd image used to boot the guest
       boot_args:
         type: string
         description: Kernel boot arguments
@@ -449,10 +452,10 @@ definitions:
         description: Enumeration indicating what type of action is contained in the payload
         type: string
         enum:
-          - BlockDeviceRescan
-          - FlushMetrics
-          - InstanceStart
-          - SendCtrlAltDel
+        - BlockDeviceRescan
+        - FlushMetrics
+        - InstanceStart
+        - SendCtrlAltDel
       payload:
         type: string
 

client/swagger.yaml

@@ -192,7 +192,7 @@ var CreateMachineHandler = Handler{
 var CreateBootSourceHandler = Handler{
 	Name: CreateBootSourceHandlerName,
 	Fn: func(ctx context.Context, m *Machine) error {
-		return m.createBootSource(ctx, m.Cfg.KernelImagePath, m.Cfg.KernelArgs)
+		return m.createBootSource(ctx, m.Cfg.KernelImagePath, m.Cfg.InitrdPath, m.Cfg.KernelArgs)
 	},
 }
 

handlers.go

@@ -381,6 +381,19 @@ func LinkFilesHandler(rootfs, kernelImageFileName string) Handler {
 				return err
 			}
 
+			initrdFilename := ""
+			if m.Cfg.InitrdPath != "" {
+				initrdFilename := filepath.Base(m.Cfg.InitrdPath)
+				// copy initrd to root fs
+				if err := linkFileToRootFS(
+					m.Cfg.JailerCfg,
+					filepath.Join(rootfs, initrdFilename),
+					m.Cfg.InitrdPath,
+				); err != nil {
+					return err
+				}
+			}
+
 			// copy all drives to the root fs
 			for i, drive := range m.Cfg.Drives {
 				hostPath := StringValue(drive.PathOnHost)
@@ -398,6 +411,9 @@ func LinkFilesHandler(rootfs, kernelImageFileName string) Handler {
 			}
 
 			m.Cfg.KernelImagePath = kernelImageFileName
+			if m.Cfg.InitrdPath != "" {
+				m.Cfg.InitrdPath = initrdFilename
+			}
 
 			for _, fifoPath := range []*string{&m.Cfg.LogFifo, &m.Cfg.MetricsFifo} {
 				if fifoPath == nil || *fifoPath == "" {

jailer.go

@@ -75,6 +75,11 @@ type Config struct {
 	// The kernel image must be an uncompressed ELF image.
 	KernelImagePath string
 
+	// InitrdPath defines the file path where initrd image is located.
+	//
+	// This parameter is optional.
+	InitrdPath string
+
 	// KernelArgs defines the command-line arguments that should be passed to
 	// the kernel.
 	KernelArgs string
@@ -134,6 +139,12 @@ func (cfg *Config) Validate() error {
 		return fmt.Errorf("failed to stat kernel image path, %q: %v", cfg.KernelImagePath, err)
 	}
 
+	if cfg.InitrdPath != "" {
+		if _, err := os.Stat(cfg.InitrdPath); err != nil {
+			return fmt.Errorf("failed to stat initrd image path, %q: %v", cfg.InitrdPath, err)
+		}
+	}
+
 	for _, drive := range cfg.Drives {
 		if BoolValue(drive.IsRootDevice) {
 			rootPath := StringValue(drive.PathOnHost)
@@ -645,9 +656,10 @@ func (m *Machine) createMachine(ctx context.Context) error {
 	return err
 }
 
-func (m *Machine) createBootSource(ctx context.Context, imagePath, kernelArgs string) error {
+func (m *Machine) createBootSource(ctx context.Context, imagePath, initrdPath, kernelArgs string) error {
 	bsrc := models.BootSource{
 		KernelImagePath: &imagePath,
+		InitrdPath:      initrdPath,
 		BootArgs:        kernelArgs,
 	}
 

machine.go

@@ -499,7 +499,7 @@ func testCreateBootSource(ctx context.Context, t *testing.T, m *Machine, vmlinux
 	//          filesystem available to the guest.
 	// Kernel command-line options can be found in the kernel source tree at
 	// Documentation/admin-guide/kernel-parameters.txt.
-	err := m.createBootSource(ctx, vmlinuxPath, "ro console=ttyS0 noapic reboot=k panic=0 pci=off nomodules")
+	err := m.createBootSource(ctx, vmlinuxPath, "", "ro console=ttyS0 noapic reboot=k panic=0 pci=off nomodules")
 	if err != nil {
 		t.Errorf("failed to create boot source: %s", err)
 	}