Ceph » mgr » Dashboard

Adding a comment from Ernesto on PR#31851 :

If I were a user of this REST API and wanted to blink lights on a device device_id attached to host host_id I would first look for something like /api/host/<host_id>/device/<device_id>, but I wouldn't figure out that I need to go to some API endpoint called /orchestrator/identify_device

/api/orchestrator/status
Keep it or move to /api/summary.

We can keep this one (perhaps moving it to the root component /api/orchestrator). This simply returns something like:

{
  "available": true,
  "description": "" 
}

/api/orchestrator/inventory
The difficulties here are:
/host/<hostname>/devices endpoints is already used for devices reported from Ceph. Which needs further integration.
There is a page Cluster -> Inventory that lists all devices on all hosts. To keep that page, we need to
forkjoin or merge individual calls for each host
Create a special endpoint to return all inventory devices, which is the reason I choose /api/orchestrator/inventory before.

We may introduce URI templates - RFC6570 (as a way of mapping single URIs to multiple resources either client or server-side, and there are distro-packaged libraries for Python and JS). Nevertheless, the mapping is resolved statically. There's no such a thing as "/hosts/{*}/devices" meaning "fetch all devices from all hosts" (although "/hosts/{host_id}/devices" could do the trick). I think this server-side expansions can be dangerous, as they are basically "SELECT *"-like queries, which might cause scalability issues (e.g.: OSDs, RBD images, RGW buckets, etc.) and force the front-end to perform paged queries by default.

How about moving the calls

/api/orchestrator/inventory
/api/orchestrator/inventory?hostname=node1

to

/api/host/inventory
or
/ui-api/host/inventory

/api/host/<$host>/inventory
or
/api/host/inventory/<$host>

or

/api/inventory
/api/inventory/<$host>