The CrateDB Admin UI

CrateDB ships with a web administration user interface (aka Admin UI) that you can use to inspect and interact with any CrateDB cluster.

Note

The tool is primarily intended for self-hosted clusters and mirrors the relevant features of the CreateDB Cloud Console. Cloud users can also benefit from the Admin UI by using it to view shards or to provide console access to users without full admin access to the Cloud Console.

Connecting

The Admin UI runs on every CrateDB node and can be accessed on port 4200:

http://HOSTNAME:4200/

Replace HOSTNAME with the hostname of the CrateDB node. If CrateDB is running locally, this will be localhost.

Navigate to this URL in a web browser.

Navigating

This is what the Admin UI looks like when it first loads:

Take note of the status bar (at the top) and the tabs (down the left side).

Status bar

Along the top of the screen, from left to right, the status bar shows:

• Cluster name

• CrateDB version

• Number of nodes in the cluster

• Health checks

  • Data status

    • Green – All data is replicated and available

    • Yellow – Some records are unreplicated

    • Red – Some data is unavailable

  • Cluster status:

    • Green – Good configuration

    • Yellow – Some configuration warnings

    • Red – Some configuration errors

• Average cluster load (for the past 1 minute, 5 minutes, and 15 minutes)

• Settings and notifications menu

Tabs

On the left-hand side, from top to bottom, the tabs are:

• Overview screen

• SQL console

• Tables browser

• Views browser

• Shards browser

• Cluster browser

• Monitoring overview

• Privileges browser

See also

The CrateDB Admin UI is an open source project and is hosted on GitHub.