View inventories in the web UI
The web UI shows in a browser what the query API returns: inventories, entities, contributions and diagnostics. An administrator uses it to check an inventory after a configuration change, and to find the records and values that need fixing in a source. The UI is read-only: inventories are changed in the configuration file.
The server serves the UI at /ui/, on the same port as the API, for example
http://localhost:8080/ui/. Like the API, it has no authentication, and it never shows a
connection's endpoint or credentials.
Screens
| Screen | Address | What it shows |
|---|---|---|
| Inventories and connections | /ui/ | Each inventory with its description, entity kind, status (ready or rebuilding) and completeness, with the causes when it is incomplete. Each connection with its type, whether it supports branches, and the contributions that use it. |
| Entity list | /ui/inventories/{inventory} | One column per field, plus HFID, location and freshness. The inventory's completeness, and one card per contribution with its health, snapshot, last publication time and last error. Filters by location, HFID and field value, sorting, pages and the total count, and a branch selector. |
| Entity detail | /ui/inventories/{inventory}/entities/{hfid} | Each field's resolved value, the contribution that supplied it, and the state and reason when the value is null. The location and the contribution of each level. Optionally, each contribution's source record with object type, native id, HFID as reported, every observation, and its references: a link to the object's page, the NetBox API address or the Infrahub GraphQL query, and the id, with buttons that copy them. |
| Diagnostics | /ui/inventories/{inventory}/diagnostics | Excluded records and unusable values, filtered by kind and contribution, with a link to each source object's page. |
The header links to the inventories, the connections and the API reference at /docs.
The links to source objects use each connection's external_base_url, as described in
Connect source systems. With
external_base_url_fallback = "error" and no external_base_url, the UI shows an error in
place of each link.
Bookmark and share a view
The inventory, branch, location, filters, sort and page are held in the address. An administrator can bookmark a filtered list, or send its address to a colleague, and the UI opens on the same view.
Build the UI into Census
The Docker image includes the UI. A binary built from source includes it only when the UI was
built first, as described in
Deploy Census. A binary built without it answers
/ui/ with the command to run.