Start work on documenting supported and unsupported use cases.

master
Tait Hoyem 2 years ago
parent 348fda54be
commit 15f288a732

@ -1,6 +1,31 @@
# `lunanode`
This is an API to work with the LunaNode's OpenStack-compatible [citation needed] API.
This crate currently covers only the most basic functionality from the Lunanode API. Currently 8/21 use cases.
* VMs [8/21]
* List [X]
* Start [X]
* Stop [X]
* Reboot [X]
* Diskswap [ ]
* Rescue [ ]
* Shelve [ ]
* Unshelve [ ]
* Delete [ ]
* Info [X]
* Reimage [ ]
* Resize [ ]
* VNC [ ]
* IP [ ]
* Floaitng IP Add [ ]
* Floating IP Delete [ ]
* IP List [X]
* IP Add [X]
* IP Delete [X]
* Security group Add [ ]
* Security group Delete [ ]
* TODO: write more of the endpoints.
## Installation
@ -34,6 +59,7 @@ See section help for more details, i.e.: `lunanode image help`
## TODO (looking for contributors)
* [ ] Create more detailed documentation. `#[deny(missing_docs)]` is on, but some of the decisions in the code aren't explained very well.
* [ ] Cover EVERY API endpoint.
* [ ] Tests!!! I've written some, but this should be comprehensively tested.
* [ ] Write tests that involve talking with a live server! This will enable breaking changes from LunaNode to be seen before they are messed with.
* [ ] Write a local test server for faster, more easily created edge-case testing.

Loading…
Cancel
Save