Support get volume metadata summary¶

Problem description¶

Currently, Cinder supports filter volumes with metadata. But in some case, users don’t know what metadata all the volumes contain or what metadata is valid to filter volumes. Then users need to show the volumes one by one to get the correct metadata, this is really a heavy and unfriendly way. Imaging that if there are hundreds of volumes, admin users will take a very long time to query all metadata.

Use Cases¶

1. For users, they can get all the metadata easily just through one API request. 2. For dashboard, such as Horizon, it can use this metadata information to show end users a dropdown list.

Proposed change¶

1. DB layer change:

   All the volumes’ metadata can be got by the sql query.

2. API layer change:

   Add a new micro version. Add “metadata” to volume-summary API response body. The body will be like:

   "metadata": {"key1": ["value1"],"key2": ["value2", "value3"]}
   

Implementation¶

Dependencies¶

None

Testing¶

• Add unit tests.

Documentation Impact¶

Update API documentation.

References¶

None