The Nuxeo admin console is an addon that provides a dedicated UI for system administrators to get an overview of the system and perform common tasks like reindexing documents.
Installation
This addon requires no specific installation steps. It can be installed like any other package with nuxeoctl command line or from the Marketplace.
nuxeo-admin-console.
What It Is
As a Nuxeo system administrator, the admin console is your go-to application to support your users on a daily basis and maintain your Nuxeo instance in production. Through an easy to use UI, it provides a full set of capabilities to leverage our management REST API endpoint tasks easily on individual documents and at scale.
What It Is NOT
A monitoring and observability application. Nuxeo provides a wide set of metrics for observability that leverage market standards, allowing you to leverage your monitoring tool of choice for this use case.
A functional administration tool. Options like managing users or vocabularies for instance can be achieved from Nuxeo Web UI.
A developer focused application. Applications like our browser extension for developers and Nuxeo CLI help with that.
A way to get the logs of your instance. Reasons for that:
- Since we run Nuxeo apps as a cluster, we need to aggregate all the logs from all the systems in a single place, including logs from services like Nuxeo Enhanced Viewer. A single Nuxeo instance cannot get this information, so the admin console cannot handle that. Their display is managed in the cloud console for our cloud customers. Self-managed customers can leverage their observability tool of choice.
- Logs configuration usually varies depending on the type of environment. The cloud console offers this option.
Functional Overview
Once installed, the Nuxeo admin console can be accessed through a dedicated URL: [YOUR-NUXEO-SERVER-URL/nuxeo]/nuxeoadmin. Only administrators can access this interface. Using an account without adminstrator level displays an error message.
Homepage
The homepage provides a quick view into the essential information of your Nuxeo instance:
- Probes and their status to see if all components are running
- Version information and cluster enablement information
Document Reindexing
The Elasticsearch Reindex menu lets you reindex documents with Elasticsearch or OpenSearch. You can reindex documents:
- Individually
- From a folder: all documents in that folder and below are reindexed
- From a NXQL query
When using the Folder and NXQL Query options, the admin console warns you about the consequences and the expected duration of this action.
Monitoring an Action
Any action triggered through the admin console uses the bulk action framework, making them highly scalable. Once an action is triggered, a confirmation is provided with a bulk action command id.
You can click on the See Status button to follow how the bulk action is proceeding.
In addition, the command id can be copied to retrieve its status later using the Bulk Action Monitoring menu. Note that the bulk action id won't be remembered, so you may want to store it in a safe place if you intend to monitor it later on.
Checking the Status of System Components
The homepage provides a concise list of probes to check the health of the various system components. For a full list with detailed information and the possibility to launch a check on them individually, you can see the Probes menu.
Going Further
Additional management options are not yet exposed into the admin console and are only available at this stage using the management REST API endpoint. Please refer to the documentation for an exhaustive list.