Skip to content
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.

Sign up for GitHub

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

Updated README #29

Merged
merged 1 commit into from
Jul 31, 2020
Merged

Updated README #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 25 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,31 @@
[![Build Status](https://travis-ci.com/ustiugov/fccd-orchestrator.svg?token=Dx4z7rB8qLcioVK5Dhsr&branch=master)](https://travis-ci.com/github/ustiugov/fccd-orchestrator)
<br />

# fccd-orchestrator
VM orchestrator for Firecracker-Containerd
# Usage notes

# Golang specifics
Need to clone the firecracker-containerd dependency (that might be a fork) under
`src/github/firecracker-microvm/firecracker-containerd` because this repo depends on
repos from the origin. This Golang/fork workaround is taken from [here](http://code.openark.org/blog/development/forking-golang-repositories-on-github-and-managing-the-import-path).
## Networking
The orchestrator creates taps and bridges with IPs when starting/loading and offloading/stopping VMs.

# Networking
The orchestrator (re)uses the taps (IPs) when starting and stopping VMs.

Note: CNI network configuration is supported in general (commented out for now) but it does not allow to
Note 1: CNI network configuration is supported in general (commented out for now) but it does not allow to
keep track of the IP addresses that are given to VMs or reuse them.

Note 2: When orchestrator panics, it leaves taps and bridges that need to be cleaned manually by running `scripts/clean_fcctr.sh`


# Development notes

## Testing

The orchestrator includes both unit/module tests and end-2-end tests.

To run the unit tests:
```
make test-subdirs
```

To run the end-to-end tests:
```
make test-orch
```

**Before merging any code, make sure ALL tests pass on your local machine!** Travis testing TBD.