Skip to content

added vsock definition in experimental yaml #1086

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 9, 2019

Conversation

andreeaflorescu
Copy link
Member

Fixes #1085

Description of changes:
Added firecracker-experimental.yaml in api_server/swagger.
This file is a copy of firecracker.yaml with an additional definiton
for the vsock API request.

The point of this file is to be used by third-party projects (like
Kata Containers) to automatically generate an API client that knows
how to send requests to the Firecracker API. The definition currently
lies in a different file and not in firecracker.yaml because vsock
is consider an experimental feature. Once the production ready vsock
is merged we will get rid of this experimental yaml.

For tracking purposes, this is the issue regarding switching to
vsock with UDS:
#650

In the new proposed vsock implementation, the API request for
configuring the vsock will also change.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Copy link

@alxiord alxiord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update test_yaml_style to verify the new swagger as well.

@andreeaflorescu
Copy link
Member Author

@aghecenco Thanks for pointing me to the test. I updated it now, please take a look and let me know.

alxiord
alxiord previously approved these changes May 9, 2019
dianpopa
dianpopa previously approved these changes May 9, 2019
Added firecracker-experimental.yaml in api_server/swagger.
This file is a copy of firecracker.yaml with an additional definiton
for the vsock API request.

The point of this file is to be used by third-party projects (like
Kata Containers) to automatically generate an API client that knows
how to send requests to the Firecracker API. The definition currently
lies in a different file and not in firecracker.yaml because vsock
is consider an experimental feature. Once the production ready vsock
is merged we will get rid of this experimental yaml.

For tracking purposes, this is the issue regarding switching to
vsock with UDS:
firecracker-microvm#650

In the new proposed vsock implementation, the API request for
configuring the vsock will also change.

Fixes firecracker-microvm#1085

Signed-off-by: Andreea Florescu <[email protected]>
@dianpopa dianpopa merged commit 3b432b9 into firecracker-microvm:master May 9, 2019
@andreeaflorescu andreeaflorescu deleted the vsock_yaml branch May 9, 2019 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add vsock to Firecracker yaml definition
3 participants