> 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.md). # Canton Network - [Version 2.0](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0.md) - [Getting Started](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/getting-started.md): This section covers how to get started with CatalyX Blockchain Manager (CAT-BM) 2.0 for the Canton Network. - [Introduction to Canton Network](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/introduction-to-canton-network.md): This section covers the introduction to the Canton Network, including its core components, architecture, and key concepts relevant to operating nodes with CatalyX Blockchain Manager. - [Technical Architecture](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/architecture.md): System context, high-level architecture, and design principles of CatalyX Blockchain Manager version 2.0 for the Canton Network. - [Installation Instructions](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/installation-instructions-canton.md): How to install CatalyX Blockchain Manager 2.0 for the Canton Network. - [Prerequisites](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/installation-instructions-canton/prerequisites.md): Cluster, tooling, and access required before installing CAT-BM 2.0. - [Keycloak Realm Setup](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/installation-instructions-canton/keycloak-realm-setup.md): Create the realm, clients, and login user the platform needs before you install — with the commands to do it by hand. - [Platform Installation](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/installation-instructions-canton/platform-installation.md): Install the CAT-BM operator, API, and UI with Helm. - [Validator CRD Reference](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/validator-crd.md): Every field on the Validator custom resource, with types and defaults. - [User Guide](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton.md): 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. - [Dashboard](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/dashboard.md): Fleet-wide validator and application health. - [Validator Overview](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/validators-list.md): The Validators list is the main working view for an operator running more than one validator. Every row is live — status, participant connection, and balance all refresh on their own. - [Validator Details](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/validators.md): Opening a validator opens the validator details, and a left-hand navigation of thirteen tabs grouped into four sections. - [Summary](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/validators/summary.md): The Summary tab is where you start when a validator is not behaving. It shows the participant node's health and then every component the validator owns, in one table. - [Status & Specification](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/validators/status-and-specification.md): The conditions the operator posted, and the validator's configuration as applied. Status is what the operator reports, Specification is what you asked for. - [Balances & Traffic](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/validators/balances-and-traffic.md): Two read-only tabs covering the validator's economic position on the network: Canton Coin holdings and synchronizer traffic counters. - [Parties](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/validators/parties.md): The Parties tab shows the parties this participant hosts, the hosting proposals waiting on it, and a lookup for any party on the synchronizer — and it is where all party operations start. - [DARs](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/validators/dars.md): The DARs tab lists every Daml package the participant knows about, and lets you upload new ones. - [Participant & Keys](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/validators/participant-and-keys.md): Two read-only tabs that expose what the Canton participant node itself reports: Participant node health, synchronizer connections, identity, and keys. - [Users & Wallet Users](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/validators/users-and-wallet-users.md): Two tabs covering two different kinds of user: Ledger users with their rights, and users onboarded to the Wallet UI. - [Identity & Endpoints](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/validators/identity-and-endpoints.md): OIDC configuration and the identity dump download, plus the URLs each component exposes. - [Applications](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/applications.md): Application component-level health and resource usage across every validator. - [Canton Console](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/canton-console.md): The Canton Console panel gives you a live, interactive Canton console attached to a participant node, from the UI, without cluster or shell access. - [Grafana Dashboards](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/grafana-dashboards.md): The CatalyX UI does not embed dashboards. Instead it links out to your Grafana instance, pre-filtered to the component you were looking at — so you land on the right data rather than a blank dashboard - [Validator Management](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/validator-management.md): This section covers creating a validator, and the operational tasks that go beyond viewing its health: managing parties, protecting keys, adding optional components, & keeping a validator upgradable & - [Create a Validator](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/validator-management/create-a-validator.md): A validator is declared as a single Validator custom resource. You apply it, and the operator provisions everything else to create the validator. - [External & Multi-Host Parties](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/validator-management/external-and-multi-host-parties.md): Onboard parties whose signing keys live outside the participant, and host a single party across several participants. - [Users & Rights](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/validator-management/users-and-rights.md): The two kinds of users in a CAT-BM deployment, and how ledger rights work. - [Identity Dumps & Database Backups](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/validator-management/identity-dumps.md): Identity dumps, database backups, and what each one recovers. - [Key Management Service (KMS)](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/validator-management/kms-integration.md): Hold the Canton participant's operational keys in an external key management service. - [Participant Query Store](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/validator-management/participant-query-store.md): The Participant Query Store (PQS) streams the ledger from the participant into a PostgreSQL database, so applications can query contract state with SQL instead of walking the Ledger API. - [Wallet Gateway](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/validator-management/wallet-gateway.md): Deploy a custodial key-holding service for a validator's parties, and manage wallets from the CatalyX UI or the API — without holding private keys yourself. - [Upgrades](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/validator-management/upgrades.md): Upgrading the platform, and upgrading validator components. - [Identity Provider Configuration](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/validator-management/identity-provider-configuration.md): Choose between letting CAT-BM provision authentication for a validator, or supplying your own OIDC configuration. - [Managed Keycloak](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/validator-management/identity-provider-configuration/managed-keycloak.md): Let CAT-BM provision the OIDC clients, scopes, and users a validator needs. - [External Identity Provider](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/validator-management/identity-provider-configuration/external-identity-provider.md): Configure a validator against OIDC clients you create yourself, in any OIDC-compliant identity provider. - [Release Notes](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/release-notes.md): Product updates and release notes for CAT-BM 2.0 for Canton. - [Support & Resources](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/support-and-resources.md): Additional support and resources for CAT-BM 2.0 for Canton. - [FAQ](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/support-and-resources/faq.md): Frequently asked questions about CAT-BM 2.0 for Canton. - [API Reference](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/support-and-resources/api-reference.md): The CatalyX REST API — endpoints, authentication, and error handling. - [Troubleshooting](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/support-and-resources/troubleshooting.md): Common problems, and the order in which to look at things. - [Open Source Licenses](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/support-and-resources/open-source-licenses.md): In this page we list all the software/components/libraries and their licenses used for CatalyX Blockchain Manager v1.11 - [Version 1.11](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11.md) - [Getting Started](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/getting-started.md): This section covers the Canton Network integration of CatalyX Blockchain Manager (CAT-BM). - [Introduction to Canton Network](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/introduction-to-canton-network.md): This section covers the introduction to the Canton Network, including its core components, architecture, and key concepts relevant to operating nodes with CatalyX Blockchain Manager. - [Installation Instructions](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/installation-instructions-canton.md): This section provides an overview of the steps necessary to launch CAT-BM for the Canton Network. - [Prerequisites](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/installation-instructions-canton/prerequisites.md): System, infrastructure, and access requirements to prepare for a CatalyX Blockchain Manager installation on Canton Network. - [Setup](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/installation-instructions-canton/set-up.md): Full Helm chart values reference for configuring the CatalyX Blockchain Manager Canton service prior to installation. - [CAT-BM Canton Service Installation](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/installation-instructions-canton/cat-bm-canton-service-installation.md): Instructions for deploying the CatalyX Blockchain Manager Canton Service using Helm. - [External Identity Provider Configuration (optional)](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/installation-instructions-canton/external-identity-provider-configuration-optional.md): This section outlines the requirements for configuring an external Identity Provider (IdP) instead of the default integrated Keycloak. - [Okta Setup Guide](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/installation-instructions-canton/external-identity-provider-configuration-optional/okta-setup-guide.md): CatalyX Blockchain Manager supports Okta as an external Identity Provider. This section walks through the steps required to configure Okta before creating a validator in CAT-BM. - [Microsoft EntraID Setup Guide](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/installation-instructions-canton/external-identity-provider-configuration-optional/microsoft-entraid-setup-guide.md): CatalyX Blockchain Manager supports Microsoft Entra ID (formerly Azure Active Directory) as an external Identity Provider. - [Auth0 Setup Guide](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/installation-instructions-canton/external-identity-provider-configuration-optional/auth0-setup-guide.md) - [Network & Node Management](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/network-and-node-management.md) - [Domains](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/network-and-node-management/domains.md) - [Participants](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/network-and-node-management/participants.md) - [Parties & Users](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/network-and-node-management/parties-and-users.md) - [Applications](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/network-and-node-management/applications.md) - [Collections](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/network-and-node-management/collections.md) - [Networking](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/network-and-node-management/networking.md) - [Validator Management](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/validator-management.md) - [Validator Management with Integrated Keycloak](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/validator-management/validator-management-with-integrated-keycloak.md) - [Validator Management with Custom Identity Provider](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/validator-management/validator-management-with-custom-identity-provider.md) - [Validator Backups and Identity Dumps](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/validator-management/identity-backup-and-recovery.md): How to configure scheduled backups and identity dumps for validator nodes in CatalyX Blockchain Manager. - [Data Retention & Pruning Policy](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/validator-management/data-retention-and-pruning-policy.md): How CatalyX Blockchain Manager handles data retention, ledger pruning, and backup strategy for validator and participant infrastructure. - [DAR management](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/validator-management/dar-management.md): How to upload and deploy DAR files in CatalyX Blockchain Manager. - [Validator Custom Resource Definition](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/validator-management/validator-custom-resource-definition.md) - [Validator CRD User Guide](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/validator-management/validator-crd-user-guide.md) - [Key Management Service (KMS)](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/validator-management/kms-integration.md): How to enable KMS-backed key management for Canton Validator Participant nodes using IRSA (IAM Roles for Service Accounts). - [Logging](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/validator-management/logging.md) - [Wallet Sweeps](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/validator-management/wallet-sweeps.md) - [Expose Ledger API](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/validator-management/expose-ledger-api.md): How to expose and access the Ledger API for a participant or validator in CatalyX Blockchain Manager. - [Disaster Recovery from a Failure on Global Synchronizer](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/validator-management/disaster-recovery-from-a-failure-on-global-synchronizer.md) - [Validator Upgrade Policy and Release Schedule](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/validator-management/validator-upgrade-policy-and-release-schedule.md): CatalyX's policy and process for validator node upgrades, release validation, and version compatibility on the Canton Network. - [Release Notes](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/release-notes.md) - [Support & Resources](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/support-and-resources.md): Contact our Support Center or explore the additional resources below to answer any questions you may have about CatalyX Blockchain Manager. - [FAQ](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/support-and-resources/faq.md): This section covers answers to frequently asked questions about CatalyX Blockchain Manager and Canton Network operations. - [API Reference](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/support-and-resources/api-reference.md): REST API reference for the CatalyX Blockchain Manager Canton Console v1.11, covering all 128 endpoints across validators, participants, domains, and more. - [Open Source Licenses](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/support-and-resources/open-source-licenses.md): In this page we list all the software/components/libraries and their licenses used for CatalyX Blockchain Manager v1.11 - [Version 1.10](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10.md) - [Getting Started](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/getting-started.md) - [Canton Network Introduction](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/getting-started/canton-network-introduction.md) - [Canton Component Overview](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/getting-started/canton-component-overview.md) - [Network & Node Management](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/network-and-node-management.md) - [Domains](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/network-and-node-management/domains.md) - [Participants](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/network-and-node-management/participants.md) - [Applications](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/network-and-node-management/applications.md) - [Collections](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/network-and-node-management/collections.md) - [Rest API](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/network-and-node-management/rest-api.md) - [Networking](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/network-and-node-management/networking.md) - [Validator Management](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/validator-management.md) - [Create Validator with Integrated Keycloak](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/validator-management/create-validator-with-integrated-keycloak.md) - [Create Validator with Custom Identity Provider](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/validator-management/create-validator-with-custom-identity-provider.md) - [Backup and Recovery](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/validator-management/backup-and-recovery.md) - [Validator Custom Resource Definition](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/validator-management/validator-custom-resource-definition.md) - [Validator CRD User Guide](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/validator-management/validator-crd-user-guide.md) - [Logging](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/validator-management/logging.md) - [Operations Guide](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/operations-guide.md) - [Installation Instructions](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/operations-guide/installation-instructions.md): This section provides an overview of the steps necessary to launch CAT-BM v1.10 for the Canton Network. - [Open Source Licenses](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/operations-guide/open-source-licenses.md): In this page we list all the software/components/libraries and their licenses used on Catalyst Blockchain Manager - Canton Service 1.0.0 - [Disaster Recovery from a Failure on Global Synchronizer](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/operations-guide/disaster-recovery-from-a-failure-on-global-synchronizer.md) - [Okta Setup Guide](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/operations-guide/okta-setup-guide.md) - [Release Notes](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.10/release-notes.md) --- # 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.md?ask=&goal= ``` `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.