Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

User Guide

The CatalyX UI is a web application for operating Canton validators without direct cluster access. It talks only to the CatalyX API, never to Kubernetes or to the Canton nodes directly.


Overview


The sidebar has three primary destinations:

Dashboard

Fleet-wide summary and the Canton console

Validators

The validator list, and every validator's detail view

Applications

Every component deployed for every validator

Below them, Help opens this documentation. The sidebar can be collapsed with Cmd/Ctrl + \.

Environment badge

The sidebar shows which environment you are looking at, derived from the hostname you are on:

Badge
Shown when

Local

The hostname is localhost, 127.0.0.1, or 0.0.0.0

Dev

The hostname contains a dev or staging segment

Production

Anything else


How to read the UI

Everything refreshes itself

There is no refresh button on most screens, and no "last updated" indicator — the UI polls continuously:

Data
Interval

Validator status, applications list, application status

3 seconds

Resource metrics

5 seconds

The Parties tab is the exception: its lists have an explicit Refresh button, because reading the synchronizer topology store is comparatively expensive.

Status vocabulary

The UI uses a small, consistent set of status words. Two of them are worth learning precisely, because they mean different things in different places.

Validator readiness

Value
Meaning

Ready

Every component the validator owns is ready

Degraded

At least one is not (shown on the lists and Dashboard)

On the validator detail header, a validator that is not ready shows the underlying reason instead of the word Degraded — which is more specific and worth reading.

Participant connection

List page
Detail page
Meaning

Live

Connected

The participant is initialised and its synchronizer connection is healthy

Disconnected

Disconnected

Initialised, but the synchronizer connection is unhealthy

Initializing

Initializing

The participant is still starting up

Not live

(no badge)

No participant status was returned — usually still loading, or the participant is unreachable

Health values on participant components and synchronizers are the raw values Canton reports, colour-coded: ok and healthy are good, degraded is a warning, failed, fatal, and unhealthy are errors, and anything else is treated as unknown.

Kubernetes conditions appear as True, False, or Unknown.

Copying identifiers

Party IDs, package IDs, endpoints, and other long values are truncated for display, with the full value in a tooltip. A copy button beside each one copies the complete value, never the truncated form, and confirms with a brief toast.

Tables

All tables in the UI behave the same way:

  • Columns can be resized, and your widths are remembered per table.

  • Rows that lead somewhere are clickable, and respond to Enter or Space.

  • Some rows expand to reveal detail, via a chevron on the left.

  • Narrow screens fall back to a card layout instead of a horizontal scroll.

  • Tables with many rows paginate at 10 rows, with a page size selector offering 10, 25, 50, or 100.


What the UI does not do

Being clear about this up front saves time hunting for a button that is not there.

Not in the UI
Where it lives instead

Creating, editing, or deleting a validator

Apply or delete a Validator custom resource — see Create a Validator

Creating, editing, deleting, scaling, or restarting an application

The operator owns these. Change the Validator resource

Ledger pruning

Not exposed in 2.0. Use the Canton console

Traffic purchases or balance top-ups

Not exposed in 2.0. The Traffic tab is read-only

Generating, rotating, or importing participant keys

Not exposed in 2.0. The Keys tab is read-only

Full-text search across validators

Search exists within the DAR packages list and the Parties tab only

Permissions

The UI requires a valid OIDC token from the identity provider configured at install time. Any user who can authenticate can reach every screen, including the operations that change ledger state.

Last updated

Was this helpful?