[PHOENIX-6074] Let PQS Act As An Admin Tool Rest Endpoint

• Type: Improvement
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Component/s: queryserver
• Assignee: Mehdi Salarkia
• Reporter: Mehdi Salarkia
• Created: 13/Aug/20 00:02
• Updated: 28/Aug/20 16:52

Description

In our production environment we need to create a lot of indexes and use indexTool to build the index also sometime use tools like indexScrutiny to verify the health and status of indexes, etc.

PQS can act as a REST API end point (proxy) that allows developers to call and run commands that phoenix currently support via command line only:

• IndexTool
• IndexScrutiny

Benefits:

1. Allow developers to develop tools in their application to run and integrate phoenix command line tools into their application without a human intervention.
2. Remove unnecessary access permission to production from non admins.
3. Simplify the Index management (or any other future command line tool that will be added to phoenix) and remove the possibility of human error, etc.

I was looking at the implementation PHOENIX-5827 as an example. I think we can simply define a new context and use that to trigger phoenix command line tools from PQS and return the result (perhaps the MR job link,...) to the client.

Issue Links

• links to: GitHub Pull Request #48