release v0.4.0 - Updated README.md and CHANGELOG.md

Signed-off-by: Andreea Florescu <[email protected]>

Author: andreeaflorescu

CHANGELOG.md

@@ -1,5 +1,46 @@
 # Changelog
 
+## [0.4.0]
+
+### Added
+
+* The CPU Template can be set with an API call on PUT /machine-config. The only available template is T2.
+* Hyperthreading can be enabled/disabled with an API call on PUT /machine-config. By default, hyperthreading is disabled.
+* Added boot time performance test (tests/performance/test_boottime.py).
+* Added Rate Limiter for Virtio block and net devices. The Rate Limiter uses two token buckets to limit rate on bytes/s
+  and ops/s. The rate limiter can be (optionally) configured per drive with a PUT on /drives/{drive_id} and per network
+  interface with a PUT on /network-interface/{iface_id}.
+* Implemented pre-boot PUT updates for /boot-source, /drives, /network-interfaces and /vsock.
+* Added integration tests for PUT updates.
+
+### Changed
+
+* Moved the API definition (swagger/firecracker-beta.yaml) to the api_server crate.
+* Removed "console=ttyS0" and added "8250.nr_uarts=0" to the default kernel command line to decrease the boot time.
+* Changed the CPU topology to have all logical CPUs on a single socket.
+* Removed the upper bound on CPU count as with musl there is no good way to get the total number of logical processors
+  on a host.
+* Build time tests now print the full output of commands.
+* Disabled the Performance Monitor Unit and the Turbo Boost.
+* Check the expected KVM capabilities before starting the VM.
+* Logs now have timestamps.
+
+### Fixed
+
+* testrun.sh can run on platforms with more than one package manager by setting the package manager via a command
+  line parameter (-p).
+* Allow correct set up of multiple network-interfaces with autogenerated MAC.
+* Fixed sporadic bug in virtio which was causing lost packages.
+* Don't allow PUT requests with empty body on /machine-config.
+* Deny PUT operations after the microvm boots (exception: the temporarily fix for live resize of block devices).
+
+### Removed
+* Removed examples crate. This used to have a Python example of starting Firecracker. This is replaced by test_api.py
+  integration tests.
+* Removed helper scripts for getting coverage and coding style errors. These were replaced by test_coverage.py and
+  test_style.py test integration tests.
+* Removed --vmm-no-api command line option. Firecracker can only be started via the API.
+
 ## [0.3.0]
 
 ### Added

README.md

@@ -24,8 +24,13 @@ and handles resource rate limiting for microVMs.
 Firecracker consists of a single micro Virtual Machine Manager binary that will
 spawn a RESTful API endpoint when started. The API endpoint can be used to:
 
-- Add one or more vCPUs to the microVM.
-- Add memory to the microVM.
+- Configure the microvm by:
+  - Change the number of vCPUs (the default is 1)
+  - Change the memory size (the default is 128 MiB)
+  - Set a CPU template (the only available template is T2 for now)
+  - Enable/Disable hyperthreading (by default hyperthreading is disabled).
+    The host needs to be modified before starting Firecracker as this flag
+    only changes the topology inside the microvm.
 - Add one or more network interfaces to the microVM.
 - Add one or more read/write disks (file-backed block devices) to the microVM.
 - Configure the logging system (i.e. path on host for log file, log level, etc).
@@ -128,7 +133,7 @@ Simply issue the `InstanceStart` action to the `/actions` API resource.
    instances.
 1. Firecracker uses default values for the following parameters:
     1. Kernel Command Line:
-       `console=ttyS0 noapic reboot=k panic=1 pci=off nomodules`. This can be
+       `noapic reboot=k panic=1 pci=off nomodules 8250.nr_uarts=0`. This can be
        changed via the `/boot-source`.
     1. Number of vCPUs: 1. Default Memory Size: 128 MiB.
     1. Unix domain socket: `/tmp/firecracker.socket`.