Update README with latest changes

* logging info
* ability to run in-tree integration tests

Signed-off-by: Diana Popa <[email protected]>

Author: dianpopa

README.md

@@ -11,6 +11,7 @@ Firecracker consists of a single micro Virtual Machine Manager binary that will
 * Add memory to the microVM.
 * Add one or more network interfaces to the microVM.
 * Add one or more read/write disks (block devices) to the microVM.
+* Configure the logging system (i.e. path on host for log file, log level, etc).
 * Start the microVM using a given kernel image and root file system.
 * Stop the microVM.
 
@@ -20,6 +21,7 @@ Firecracker consists of a single micro Virtual Machine Manager binary that will
 * Emulated keyboard (i8042) and serial console (UART). The microVM serial console input and output are connected to those of the Firecracker process (this allows direct console access to the guest OS).
 * The capability of mapping an existing host tun-tap device as a virtIO/net device into the microVM.
 * The capability of mapping an existing host file as a virtIO/block device into the microVM.
+* Logging capabilities.
 * Default demand fault paging & CPU oversubscription.
 
 ## Limits and Performance
@@ -51,6 +53,9 @@ To run microVMs with Firecracker, you will need to have:
 ## Runtime Dependencies
 * Firecracker needs rw access to `/dev/kvm`. You can grant these rights, e.g., to all users, with: `sudo chmod a+rw /dev/kvm`.
 
+## Testing
+* In-tree integration tests, that can be run locally or as part of a continuous integration system, are provided. See `tests/README.md` for more information.
+
 ## Start Firecracker & the Micro VM
 
 The python-based toy example below will start a Firecracker microVM with 2 vCPUs, 256 MiB or RAM, two network interfaces and two disks (rootfs and temp).
@@ -121,6 +126,17 @@ requests.put(
     }
 )
 
+# Configure logging system.
+requests.put(
+    firecracker.logger_url,
+    json={
+        'path': '/tmp/firecracker0001/file.log',
+        'level': 'Info',
+        'show_level': True,
+        'show_log_origin': True,
+    }
+)
+
 # Specify a boot source: a kernel image.
 # Currently, only linux kernel images are supported.
 requests.put(

examples/hello_api/spawn_microvm.py

@@ -21,6 +21,7 @@ class Firecracker:
     drives_path = '/drives'
     boot_source_path = '/boot-source'
     actions_path = '/actions'
+    logger = '/logger'
 
     def __init__(self, socket_name):
         self.socket_name = socket_name
@@ -40,6 +41,7 @@ def spawn(self):
         self.drives_url = usocket_url + self.drives_path
         self.boot_source_url = usocket_url + self.boot_source_path
         self.actions_url = usocket_url + self.actions_path
+        self.logger_url = usocket_url + self.logger
 
         screen_cmd = (
             'screen -dmS ' + self.session_name +
@@ -116,6 +118,15 @@ def get_usocket_url(self):
     }
 )
 
+requests.put(
+    firecracker.logger_url,
+    json={
+        'path': '/tmp/firecracker0001/file.log',
+        'level': 'Info',
+        'show_level': True,
+        'show_log_origin': True,
+    }
+)
 
 # Specify a boot source: a kernel image.
 # Currently, only linux kernel images are supported.