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

Update API.md - Add route part & ToC #178

Merged
merged 2 commits into from
Jul 26, 2018
Merged

Update API.md - Add route part & ToC #178

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0490a9
Add route of Nrework part, cc #154
sufuf3 Jul 25, 2018
43e3c74
Add table of contents in API.md
sufuf3 Jul 25, 2018
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
64 changes: 64 additions & 0 deletions API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,45 @@
# Vortex API

## Table of Contents
* [Network](#network)
+ [Create Network](#create-network)
+ [List Network](#list-network)
+ [Get Network](#get-network)
+ [Get Network Status](#get-network-status)
+ [Delete Network](#delete-network)
* [Storage](#storage)
+ [Create Storage](#create-storage)
+ [List Storage](#list-storage)
+ [Remove Storage](#remove-storage)
* [Volume](#volume)
+ [Create Volume](#create-volume)
+ [List Volume](#list-volume)
+ [Remove Volume](#remove-volume)
* [Pod](#pod)
+ [Create Pod](#create-pod)
+ [List Pods](#list-pods)
+ [Get Pod](#get-pod)
+ [Delete Pod](#delete-pod)
* [Resouce Monitoring](#resouce-monitoring)
+ [List Nodes](#list-nodes)
+ [Get Node](#get-node)
+ [List NICs of certain node](#list-nics-of-certain-node)
+ [List Pod](#list-pod)
+ [Get Pod](#get-pod-1)
+ [List Containers](#list-containers)
+ [Get Container](#get-container)
+ [List Services](#list-services)
+ [Get Service](#get-service)
+ [List Controllers](#list-controllers)
+ [Get Controller](#get-controller)
* [Service](#service)
+ [Create Service](#create-service)
+ [List Services](#list-services-1)
+ [Get Service](#get-service-1)
+ [Delete Service](#delete-service)



## Network

### Create Network
Expand All @@ -20,6 +60,12 @@ Example:
100,
200
],
"routes":[
{
"dstCIDR":"224.0.0.0/4",
"gateway":"0.0.0.0"
}
],
"bridgeName":"ovsbr0",
"nodes":[
{
Expand Down Expand Up @@ -47,6 +93,12 @@ Request Data:
100,
200
],
"routes":[
{
"dstCIDR":"224.0.0.0/4",
"gateway":"0.0.0.0"
}
],
"bridgeName":"ovsbr0",
"nodes":[
{
Expand Down Expand Up @@ -94,6 +146,12 @@ Response Data:
100,
200
],
"routes":[
{
"dstCIDR":"224.0.0.0/4",
"gateway":"0.0.0.0"
}
],
"bridgeName": "",
"nodes": [
{
Expand Down Expand Up @@ -146,6 +204,12 @@ Response Data:
100,
200
],
"routes":[
{
"dstCIDR":"224.0.0.0/4",
"gateway":"0.0.0.0"
}
],
"bridgeName": "ovsbr0",
"nodes": [
{
Expand Down