Admin UI

A simplified administration UI is provided by the manager node, providing easy access to the manager api operations.

DocService

The DocService is an admin UI automatically generated from the protobuf definitions via Armeria. This service can be accessed at the /docs path at the manager IP.

Tip: Consider registering your manager nodes with a service discovery tool to provide a consistent address for your administration tooling.

Tip: No service is bound to the root path of the manager service. Make sure to include the complete /docs path to avoid getting the service error response.

Status: 404
Description: Not Found

Manager DocService page

Using the debug UI

The debug UI will automatically populate an example request body stub that can be used to help prepare a request. Note that this example is not always valid, as certain fields may be required that are not automatically populated.

Invoking the debug dialog can be done with an overlay using the debug button, or is additionally provided at the bottom of a service description page. Submitting a request in the UI will render the response, along with any error messages that may have occurred.

Example before submitting a DocService request

Example with a successful DocService request

Example with an error DocService request