Explorer UI (Experimental)
Overview
The Control API Explorer UI is a graphical editor for Grey Matter service mesh configuration that gives a high-level overview of the mesh topology. It allows a mesh operator to visualize the connections between objects for each service and troubleshoot broken links or misconfigured sidecars.
Architecture
The Explorer UI is bundled with the Control API server and served at /explorer. It uses the experimental /services endpoint to query for services running in the mesh.
Deployment
To enable the Explorer UI, set the following environment variable for Control API:
If you have deployed Control API somewhere other than a root route /, you will also need to tell the server what the base URL is. By default, the API is served at /v1.0/, so you'll need to prepend your base url to /v1.0/ (note the trailing slash). For example:
The Explorer UI would then be accessed at https://yourhost.com/path/to/controlapi/v1.0/explorer
Usage
The left sidebar renders a dropdown menu to select services within the mesh. A service is defined by configuring a proxy object. Selecting a service renders the configuration graph using the proxy object as the root node.
Selecting an object node on the graph displays that object's configuration in the JSON editor on the left. You can make adjustments to the object via the editor. When finished, click Save to apply those changes to the server and rerender the graph. Currently, there is no way to delete nodes via this UI.
Last updated
Was this helpful?