> For the complete documentation index, see [llms.txt](https://docs.catalyx.solutions/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton.md).

# 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.

<div data-with-frame="true"><figure><img src="https://2680825251-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsUGPGTcyMu8FXsdY8XQY%2Fuploads%2Fgit-blob-843402cb0fb6628bc946a92e4f489929ad61b149%2Fimage%20(150).png?alt=media" alt=""><figcaption></figcaption></figure></div>

***

## Overview

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Dashboard</strong></td><td>Fleet-wide health at a glance.</td><td><a href="/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/dashboard.md">Dashboard</a></td></tr><tr><td><strong>Validator Overview</strong></td><td>Every validator in the cluster, with live status.</td><td><a href="/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/validators-list.md">Validator Overview</a></td></tr><tr><td><strong>Validator Details</strong></td><td>The 13-tab detail view for a single validator.</td><td><a href="/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/validators.md">Validator Details</a></td></tr><tr><td><strong>Applications</strong></td><td>Component-level health and resource usage.</td><td><a href="/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/applications.md">Applications</a></td></tr><tr><td><strong>Canton Console</strong></td><td>An interactive Canton console in the browser.</td><td><a href="/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/canton-console.md">Canton Console</a></td></tr><tr><td><strong>Grafana</strong></td><td>Metrics and log deep links.</td><td><a href="/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/grafana-dashboards.md">Grafana Dashboards</a></td></tr></tbody></table>

***

## Navigation

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                                          |

{% hint style="warning" %}
`Production` is the fallback, not a positive detection. Any hostname that does not look local or dev is labelled `Production`.
{% endhint %}

***

## 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.

<table><thead><tr><th width="290">Not in the UI</th><th>Where it lives instead</th></tr></thead><tbody><tr><td>Creating, editing, or deleting a validator</td><td>Apply or delete a <code>Validator</code> custom resource — see <a href="/catalyx-blockchain-manager/canton-network/version-2.0/validator-management/create-a-validator.md">Create a Validator</a></td></tr><tr><td>Creating, editing, deleting, scaling, or restarting an application</td><td>The operator owns these. Change the <code>Validator</code> resource</td></tr><tr><td>Ledger pruning</td><td>Not exposed in 2.0. Use the <a href="/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/canton-console.md">Canton console</a></td></tr><tr><td>Traffic purchases or balance top-ups</td><td>Not exposed in 2.0. The Balances and Traffic tabs are read-only</td></tr><tr><td>Generating, rotating, or importing participant keys</td><td>Not exposed in 2.0. The Keys tab is read-only</td></tr><tr><td>Full-text search across validators</td><td>Search exists within the DAR packages list and the Parties tab only</td></tr></tbody></table>

## 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.

{% hint style="danger" %}
There is no per-validator or per-screen authorisation inside the UI in 2.0. Restrict who can obtain a token for the UI client in your identity provider, and treat UI access as privileged — the [Canton console](/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/canton-console.md) in particular grants full administrative access to the participant.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.