Release v0.5.0 #353

acatangiu · 2018-06-15T11:11:55Z

No description provided.

andreeaflorescu · 2018-06-15T11:21:24Z

api_server/swagger/firecracker-beta.yaml

+      Defines a token bucket with a fixed size/capacity and refill_time.
+      The refill-rate is derived from size and refill_time, and it is the constant
+      rate at which the tokens replenish.
+      Rate of consumption from the token bucket is unlimited which allows for bursts


I think there is a dash missing here before but.

andreeaflorescu · 2018-06-15T11:22:16Z

api_server/swagger/firecracker-beta.yaml

@@ -1,10 +1,10 @@
 swagger: "2.0"
 info:
-  title: Firecracker v0.4 API
-  description: Firecraker v0.4 - RESTful public-facing API.
+  title: Firecracker v0.5 API


This should be commit with Cargo.toml before setting the tag.

andreeaflorescu · 2018-06-15T11:33:49Z

api_server/swagger/firecracker-beta.yaml

-      summary: Creates new network interface with ID specified by iface_id path parameter.
-               If network interface with specified ID already exists,
-               updates its state based on new input. Will fail if update is not possible.
+      summary: Creates or updates a network interface.


We have a bug here, we should remove the update of network interfaces till we actually have it correctly implemented.

#354 tracks the update bug.

andreeaflorescu · 2018-06-15T11:34:22Z

api_server/swagger/firecracker-beta.yaml

+      summary: Creates or updates a network interface.
+      description:
+        Creates new network interface with ID specified by iface_id path parameter.
+        If network interface with specified ID already exists,


We should also say here: update is not supported yet or something like that.

andreeaflorescu · 2018-06-15T11:37:24Z

api_server/swagger/firecracker-beta.yaml

-                     This value is read-only for the control-plane.
+        description:
+          The current detailed state of the Firecracker instance.
+          This value is read-only for the control-plane.


We should also say here that it contains only the instance state: one of Uninitialized, Starting, Running. I think we shouldn't mention Halting and Halted since this also doesn't work at the time.

They do work, starting after halting doesn't work and we have an open issue for that, but by no means should we remove it from the spec :)

Comments have been addressed

alxiord · 2018-06-15T12:33:57Z

api_server/swagger/firecracker-beta.yaml

+      summary: Creates or updates the boot source.
+      description:
+        Creates new boot source if one does not already exists, otherwise updates it.
+        Will fail if update is not possible.


It would be worth mentioning that updates are only allowed before the guest boots.

Can't turn this into documentation, these are already too verbose for my taste. Ideally the API spec should not expose or describe underlying program logic.

alxiord · 2018-06-15T12:35:32Z

api_server/swagger/firecracker-beta.yaml

+      summary: Creates or updates a drive.
+      description:
+        Creates new drive with ID specified by drive_id path parameter.
+        If a drive with the specified ID already exists, updates its state based on new input.


This is a bit more complicated:

if a drive with the same ID exists and the PUT comes before guest boot, the state is updated based on the new input;

if the guest is running, the input is irrelevant as a rescan is triggered and the drive is updated with info it reads from the OS.

same as above

alxiord · 2018-06-15T12:35:55Z

api_server/swagger/firecracker-beta.yaml

-                   there is no CPU Template.
+      summary: Gets the machine configuration of the VM.
+      description:
+        Get the machine configuration of the VM. When called before the PUT operation, it


alxiord · 2018-06-15T12:36:31Z

api_server/swagger/firecracker-beta.yaml

+      summary: Gets the machine configuration of the VM.
+      description:
+        Get the machine configuration of the VM. When called before the PUT operation, it
+        will return the default values for the vCPU count (=1), memory size (=128 MiB),


This line ends abruptly in a comma, is there something else to add that got accidentally deleted?

Fixed that unfortunate layout.

alxiord · 2018-06-15T12:37:12Z

api_server/swagger/firecracker-beta.yaml

-               When Hyperthreading is enabled, the vCPU count has to be either 1 or an even number.
-               is disabled, there are no restrictions regarding the vCPU count.
-               If one of the parameters does not have a correct value, the update fails and no fields are updated.
+      summary: Updates the machine configuration of the VM.


Please rephrase with the wording from the description: "Updates the Virtual Machine Configuration"

alxiord · 2018-06-15T12:37:57Z

api_server/swagger/firecracker-beta.yaml

-      summary: Creates new network interface with ID specified by iface_id path parameter.
-               If network interface with specified ID already exists,
-               updates its state based on new input. Will fail if update is not possible.
+      summary: Creates or updates a network interface.


#354 tracks the update bug.

dianpopa · 2018-06-15T13:15:22Z

api_server/swagger/firecracker.yaml

-               The only supported boot source is LocalImage.
+      summary: Creates or updates the boot source.
+      description:
+        Creates new boot source if one does not already exists, otherwise updates it.


exist not exists.

dianpopa · 2018-06-15T13:20:08Z

api_server/swagger/firecracker.yaml

@@ -25,7 +25,7 @@ produces:
 paths:


There is kind of a comment on line 335 # Timestamp generated by FC - output only timestamp: for the timestamp field. Can t we turn that comment into the value of a description field?

Signed-off-by: Adrian Catangiu <[email protected]>

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

Signed-off-by: Adrian Catangiu <[email protected]>

Fixes #352 Signed-off-by: Alexandra Iordache <[email protected]>

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

acatangiu requested a review from a team June 15, 2018 11:11

acatangiu changed the title ~~Housekeeping for API YAML~~ Housekeeping for API YAML (v0.5.0) Jun 15, 2018

andreeaflorescu previously requested changes Jun 15, 2018

View reviewed changes

alxiord reviewed Jun 15, 2018

View reviewed changes

dianpopa assigned acatangiu Jun 15, 2018

alxiord previously approved these changes Jun 15, 2018

View reviewed changes

dianpopa reviewed Jun 15, 2018

View reviewed changes

acatangiu dismissed alxiord’s stale review via 6da281c June 15, 2018 13:41

dianpopa previously approved these changes Jun 15, 2018

View reviewed changes

andreeaflorescu previously approved these changes Jun 15, 2018

View reviewed changes

acatangiu added 2 commits June 15, 2018 18:00

Add IO rate limiters description to api yaml

48244df

Signed-off-by: Adrian Catangiu <[email protected]>

Correct some info therein, and beautify the api yaml.

f7f27b6

Signed-off-by: Adrian Catangiu <[email protected]>

acatangiu changed the title ~~Housekeeping for API YAML (v0.5.0)~~ Release v0.5.0 Jun 15, 2018

docs: add documentation on jailer

0a29eda

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

acatangiu dismissed stale reviews from andreeaflorescu and dianpopa via a377bd3 June 15, 2018 15:44

acatangiu and others added 3 commits June 15, 2018 18:46

Update README with rate-limiter, metrics and jailer info (v0.5.0)

6fb9c59

Signed-off-by: Adrian Catangiu <[email protected]>

Release notes for Firecracker v0.5.0

08c9bab

Fixes #352 Signed-off-by: Alexandra Iordache <[email protected]>

0.5.0: updated firecracker.yaml and Cargo.toml

a377bd3

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

alxiord approved these changes Jun 15, 2018

View reviewed changes

raduweiss approved these changes Jun 15, 2018

View reviewed changes

alxiord merged commit 030570c into firecracker-microvm:master Jun 15, 2018

hyandell unassigned acatangiu Nov 7, 2018

Release v0.5.0 #353

Release v0.5.0 #353

Uh oh!

Conversation

acatangiu commented Jun 15, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!