Details
-
New Feature
-
Status: Open
-
Major
-
Resolution: Unresolved
-
0.6
-
None
-
None
-
None
Description
When users have hundreds or thousands of entities to manage, they may not remember the exact name/tag of the entity. We would like to provide a more convenient way for the user to search an entity by providing keywords in name and tags. We also plan to provide a search UI, similar to Visual Search, to allow the user to enter keywords in a search box and display the filtered results. The user can click on the entity to view details and search its instances as well.
To support free-text search, we plan to extend the LIST API:
GET api/entities/list/:entity-type
Parameters changed/added:
1) :entity-type Comma-separated entity types. Can be empty. Valid entity types are cluster, feed or process.
2) nameseq Subsequence of entity name. Not case sensitive. Example: "Sample1" is a subsequence of entity name "SampleFeed1". Note that we rename "pattern" parameter to "nameseq" to make it more intuitive to the user, but the functionality is already there in Falcon-914 .
3) tagkeys Tag keywords, separated by comma. Not case sensitive. The returning entities must have tags that match all the tag keywords.
4) Clean up the parameter "tags" and the name filter in filterBy option, which match the full tag and the full name, respectively.
Results
Return the total number of entity results and a list of entities.
e.g. falcon entity -list -nameseq housetexas -tagkeys estate
This should return the entity with name "houseSellTexas" and tags "category=realestate".
Falcon CLI will be changed accordingly as well.