diff --git a/README.md b/README.md index 3cafcbc..e6f289c 100644 --- a/README.md +++ b/README.md @@ -236,7 +236,7 @@ curl -H -XPOST -d '{ "name": "Cluster_B", ### Cluster management ``` bash -'/api/v1/administration/cluster/' | GET - Return the informations for an specific cluster +'/api/v1/administration/cluster/' | GET - Return the informations for an specific cluster | PUT - Update the configurations 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 # date/cluster/node/vmid # Disks mapping -'/api/v1/static/disks////' | GET - Return the informations for an specific disk +'/api/v1/static/disks////' | GET - Return the informations for an specific disk '/api/v1/static/disks////' | GET - Return all disks used in a node -'/api/v1/static/disks///' | GET - Return all disks used in a cluster -'/api/v1/static/disks//' | GET - Return all disks +'/api/v1/static/disks///' | GET - Return all disks used in a cluster +'/api/v1/static/disks//' | GET - Return all disks # Storages mapping '/api/v1/static/storages////' | GET - Return all storage used in a node -'/api/v1/static/storages///' | GET - Return all storages used in a cluster -'/api/v1/static/storages//' | GET - Return all storages +'/api/v1/static/storages///' | GET - Return all storages used in a cluster +'/api/v1/static/storages//' | GET - Return all storages # Instances mapping '/api/v1/static/instances////' | GET - Return the informations for an specific instance -'/api/v1/static/instances////' | GET - Return all instances for a node -'/api/v1/static/instances///' | GET - Return all instances for a cluster -'/api/v1/static/instances//' | GET - Return all instances (the dump can be very big, in a large infrastructure) +'/api/v1/static/instances////' | GET - Return all instances for a node +'/api/v1/static/instances///' | GET - Return all instances for a cluster +'/api/v1/static/instances//' | GET - Return all instances (the dump can be very big, in a large infrastructure) # Nodes mapping '/api/v1/static/nodes///' | GET - Return the informations for an specific node -'/api/v1/static/nodes///' | GET - Return all nodes for a cluster -'/api/v1/static/nodes//' | GET - Return all nodes +'/api/v1/static/nodes///' | GET - Return all nodes for a cluster +'/api/v1/static/nodes//' | GET - Return all nodes # cluster mapping -'/api/v1/static/clusters//' | GET - Return the insformations for a specific cluster -'/api/v1/static/clusters//' | GET - Return all cluster informations +'/api/v1/static/clusters//' | GET - Return the insformations for a specific cluster +'/api/v1/static/clusters//' | GET - Return all cluster informations # 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 '/api/v1/static/(instances|nodes|clusters|storages|disks)/id/' | 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 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. + \ No newline at end of file diff --git a/TasksList.md b/TasksList.md new file mode 100644 index 0000000..f006c0f --- /dev/null +++ b/TasksList.md @@ -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