external/HyperProxmox
1
0
Fork 0
mirror of https://github.com/ThomasGsp/HyperProxmox.git synced 2025-03-09 15:40:18 +00:00
Code Issues Releases Wiki Activity

Update documentation

Browse source
This commit is contained in:
Tlams 2018-03-28 20:21:25 +01:00
parent b45683f51b
commit 43f73594b2
2 changed files with 26 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -236,7 +236,7 @@ curl -H -XPOST -d '{ "name": "Cluster_B",
### Cluster management ### Cluster management
``` bash ``` bash
'/api/v1/administration/cluster/<cluster>' | GET - Return the informations for an specific cluster '/api/v1/administration/cluster/<cluster>' | GET - Return the informations for an specific cluster
| PUT - Update the configurations for an specific cluster | PUT - Update the configurations for an specific cluster
| DELETE - Delete the configuration for an specific cluster | DELETE - Delete the configuration for an specific cluster
@ -249,33 +249,33 @@ This data are manage by the crawler, you can't insert or change data yourself
``` bash ``` bash
# date/cluster/node/vmid # date/cluster/node/vmid
# Disks mapping # Disks mapping
'/api/v1/static/disks/<date>/<cluster>/<node>/<vmid>' | GET - Return the informations for an specific disk '/api/v1/static/disks/<date>/<cluster>/<node>/<vmid>' | GET - Return the informations for an specific disk
'/api/v1/static/disks/<date>/<cluster>/<node>/' | GET - Return all disks used in a node '/api/v1/static/disks/<date>/<cluster>/<node>/' | GET - Return all disks used in a node
'/api/v1/static/disks/<date>/<cluster>/' | GET - Return all disks used in a cluster '/api/v1/static/disks/<date>/<cluster>/' | GET - Return all disks used in a cluster
'/api/v1/static/disks/<date>/' | GET - Return all disks '/api/v1/static/disks/<date>/' | GET - Return all disks
# Storages mapping # Storages mapping
'/api/v1/static/storages/<date>/<cluster>/<node>/' | GET - Return all storage used in a node '/api/v1/static/storages/<date>/<cluster>/<node>/' | GET - Return all storage used in a node
'/api/v1/static/storages/<date>/<cluster>/' | GET - Return all storages used in a cluster '/api/v1/static/storages/<date>/<cluster>/' | GET - Return all storages used in a cluster
'/api/v1/static/storages/<date>/' | GET - Return all storages '/api/v1/static/storages/<date>/' | GET - Return all storages
# Instances mapping # Instances mapping
'/api/v1/static/instances/<date>/<cluster>/<node>/<vmid>' | GET - Return the informations for an specific instance '/api/v1/static/instances/<date>/<cluster>/<node>/<vmid>' | GET - Return the informations for an specific instance
'/api/v1/static/instances/<date>/<cluster>/<node>/' | GET - Return all instances for a node '/api/v1/static/instances/<date>/<cluster>/<node>/' | GET - Return all instances for a node
'/api/v1/static/instances/<date>/<cluster>/' | GET - Return all instances for a cluster '/api/v1/static/instances/<date>/<cluster>/' | GET - Return all instances for a cluster
'/api/v1/static/instances/<date>/' | GET - Return all instances (the dump can be very big, in a large infrastructure) '/api/v1/static/instances/<date>/' | GET - Return all instances (the dump can be very big, in a large infrastructure)
# Nodes mapping # Nodes mapping
'/api/v1/static/nodes/<date>/<cluster>/<node>' | GET - Return the informations for an specific node '/api/v1/static/nodes/<date>/<cluster>/<node>' | GET - Return the informations for an specific node
'/api/v1/static/nodes/<date>/<cluster>/' | GET - Return all nodes for a cluster '/api/v1/static/nodes/<date>/<cluster>/' | GET - Return all nodes for a cluster
'/api/v1/static/nodes/<date>/' | GET - Return all nodes '/api/v1/static/nodes/<date>/' | GET - Return all nodes
# cluster mapping # cluster mapping
'/api/v1/static/clusters/<date>/<cluster>' | GET - Return the insformations for a specific cluster '/api/v1/static/clusters/<date>/<cluster>' | GET - Return the insformations for a specific cluster
'/api/v1/static/clusters/<date>/' | GET - Return all cluster informations '/api/v1/static/clusters/<date>/' | GET - Return all cluster informations
# date # date
'/api/v1/static/dates/(all|last)' | GET - Return all or the last date available (generated by the crawler) '/api/v1/static/dates/(all|last)' | GET - Return all or the last date available (generated by the crawler)
# mongoid # mongoid
'/api/v1/static/(instances|nodes|clusters|storages|disks)/id/<MongoID>' | GET - Return an information by mongoid '/api/v1/static/(instances|nodes|clusters|storages|disks)/id/<MongoID>' | GET - Return an information by mongoid
@ -285,3 +285,9 @@ This data are manage by the crawler, you can't insert or change data yourself
``` bash ``` bash
curl http://127.0.0.1:8080/api/v1/static/nodes/1519040226/Cluster_1/sd-817348 curl http://127.0.0.1:8080/api/v1/static/nodes/1519040226/Cluster_1/sd-817348
``` ```
## Unique ID
When a new instance is discover, the system assign an unique ID for this VM.
This unique ID is visible in the comments part in Proxmox.
This ID allow the possibility to follow the VM in a large infrastructure with frequent VM balancing between the Proxmox hypervisors.

6
TasksList.md Normal file
View file

@ -0,0 +1,6 @@
## Tasks list
* Finish the logger system
* Detect an duplicate or invalid unique ID
* Detect a new clone
* Improve the return format (json) and make a standard