Ctrlk
Support Center
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Release Notes

A chronological record of all CAT-BM updates, improvements, and bug fixes.

Version 1.11

What’s New

  • Validator Backup and restore - Configure a database backups schedule through CatalyX and restore validators. Read more

  • Identity backups scheduling - Configure the identity backup flow through a schedule, now these backups are also visible in CatalyX UI. Read more

  • Configure External DB - Create Validators configured for a external Database service (e.g: RDS)

  • User roles added to match new Daml versions - Added Roles for Participant users in the new Daml versions on the Edit User UI

Patches Summary

  • v1.11.1 - Validator deployment fix: resolved an error thrown when deploying Validators without a wallet configured.

  • v1.11.2 - Validator wallet configuration fix: resolved a bug where wallet username configuration was missing for some Validators.

  • v1.11.3 - Client heap dump & parties cache: added client heap dump support and an initial attempt at parties cache improvements.

  • …​

  • v1.11.6 - Disabled party cache

  • v1.11.7 - Local parties tab & dynamic backup sizing: added a local parties view on the participant details page, improved party fetching performance, and introduced automatic backup volume sizing based on database size and retention settings.

Version 1.10

What’s new

  • Custom Resource Definition changes for Git Ops - Changes to the main Validator CRD specification to make Git Ops integration easier

  • Custom Annotations for On-Prem Deployments - Introduced custom Kubernetes annotations for services and deployments, targeted at on-premises customers.

  • Participant Communication API Upgrade - CatalyX now uses the V2 API for participant communication.

  • Ledger API Egress Support - Added the ability to configure Ledger API egress.

  • Validator Creation Prefill - Validator provisioning now automatically queries the network to prefill configuration values, reducing manual input and setup errors.

  • Security Enhancements - Upgraded dependencies to address known vulnerabilities.

  • Multi-DAR Upload - Users can now upload multiple DAR files in a single operation.

Breaking change: API endpoint /api/files now expects 'files' param instead of 'file'

Bug Fixes

  • Optimized the validator listing call - reducing cold start times reported at >1 minute for some customers.

  • Resolved Liveness Probe Creation Issue - Solved limitations when being created for certain components.

  • Resolved a logging issue - some runtime logs were not visible in the UI.

Patches Summary

  • v1.10.1 - Fixed bug where logs could be truncated - json formatted logs are now returned fully instead of only returning the message field

  • v1.10.2 - Fixed scan API forwarding regression errors in cross environment Identity Dump recovery introduced in 1.10

  • v1.10.3 - Fixed to handle change on validator images where the default user was changed

  • v1.10.4 - Fixed logs formatted in json, so they could get truncated in CatalyX UI

  • v1.10.5 - Changed DAR upload through CatalyX to match the new Daml Ledger API

Version 1.9

What’s new

  • Secure JSON API Communication – CatalyX now establishes direct HTTPS connections with the Daml JSON API, removing the prior reliance on Traefik HTTP-to-HTTPS redirection. This improves compatibility with different cluster environments

  • Dedicated Metrics Port Exposure – Participants and validators now expose an explicit metrics port, enhancing observability and integration with monitoring tools.

  • Client-Focused Enhancements – Participants and validators now expose a dedicated Prometheus-compatible metrics port, enabling tighter integration with observability stacks and more granular performance monitoring.

    • UI Redesign – Modernized frontend for improved UX and streamlined workflows.

    • Flexible Deployment Options – Additional deployment flags and configurations to support heterogeneous client environments and infrastructure.

    • Stability Improvements – Multiple backend fixes and improvements to ensure more consistent runtime behavior.

Patches Summary

  • v1.9.0 / v1.9.1- Internal-only builds for penetration testing and internal QA cycles.

  • v1.9.2- Major client release featuring UI overhaul and modular deployment support for varied infrastructure requirements.

  • v1.9.3- Resolved an issue introduced in v1.9 where validator pods failed to restart correctly during migration operations

  • …​

  • v1.9.5- Introduced dedicated metrics port bindings for both participants and validators.

  • v1.9.6- Modified CatalyX’s Daml JSON API integration to initiate direct HTTPS requests, eliminating dependency on Traefik-level HTTPS redirection.

  • v1.9.7- Added the ability to disable wallet creation during validator provisioning. Improved identity dump behavior by removing wallet password requirements and avoiding field duplication.

Version 1.8

What’s new

  • Extended Identity Provider Integration - CatalyX now supports integration with additional identity providers beyond Keycloak, enabling broader compatibility with enterprise authentication systems such as Auth0 and Okta.

  • Custom Authorization Controls - Introduced a configurable authorization mechanism that allows manual definition of clients and users to enhance flexibility for custom access control and tighter security policies.

Improvements

  • Validator Provisioning Flow Enhancements - Streamlined the creation and configuration process for validators with improved component orchestration and resource management, reducing setup time and potential misconfigurations.

  • Bug Fixes. - Includes various UI and backend corrections to improve stability and consistency.

Patches

  • v1.8.1 - Fixed application creation issue with custom Identity Providers.

  • v1.8.2 - Resolved volume sizing bug affecting Operator stability.

  • v1.8.3 - Updated Helm charts and removed deprecated replicated labels; internal CI/CD improvements.

  • v1.8.4 - Enabled license key injection via Kubernetes secrets.

  • v1.8.5 - Fixed port conflict in validator UI Docker images for versions >0.3.15.

  • v1.8.6 - Corrected Canton Name Server image reference from cns-web-ui to ans-web-ui for version 0.3.17.

  • v1.8.7 - Added option to disable Role-Based Access Control and use a single Admin role.

  • …​

  • v1.8.10 - Resolved a regression introduced in build v1.8.7.

  • v1.8.11 - Introduced ability to define default images (e.g., Postgres, NGINX).

  • v1.8.12 - Added configuration option to disable typ header verification.

  • v1.8.13 - Enabled Postgres deployment customization via the Validator CRD.

  • v1.8.14 - Updated Postgres deployment strategy to support rolling updates.

Since v1.8.4 the license key can be passed as a secret, please update your values.yaml with the respective values.

 licenseKey:
    key: ""  # Set licenseKey if NOT using a Kubernetes secret
    secret:
      enabled: false  # Set to 'true' to use a Kubernetes Secret
      name: ""        # Name of the Kubernetes secret
      key: ""         # Key inside the secret that contains licenseKey
Version 1.7

What’s new

  • Validator Identity Dump Management - CatalyX now allows users to generate identity dumps for validator nodes directly from the UI. These dumps are stored as Kubernetes secrets within the cluster, enabling secure and persistent identity management.

  • Validator Recreation from Identity Dumps - Validators can now be safely deleted and later recreated using their previously stored identity dumps, preserving node identity across lifecycle operations and reducing redeployment overhead.

Improvements

  • Stability & Maintenance Fixes - Includes minor backend and UI fixes to enhance system reliability and user experience.

Version 1.6

What’s new

  • Validator Lifecycle Management - CatalyX now supports the deployment and operational management of Canton validator nodes directly from the UI, enabling users to provision, monitor, and maintain validator infrastructure with minimal manual intervention.

  • Wallet Operations Interface - Introduced a dedicated interface for Canton wallet management, allowing users to operate their wallets more securely and efficiently.

Improvements

  • One-Click Health Data Export - Users can now generate and download comprehensive health dumps for both participants and domains in a single action, simplifying diagnostics and support workflows.

  • Stability & Usability Enhancements - Includes various minor fixes and refinements to improve overall stability and user experience.

Version 1.5

What’s new

  • Scheduled Backup Support CatalyX now enables automated scheduling of backups for both domains and participants. This ensures regular state snapshots and enhances disaster recovery readiness with minimal manual oversight.

  • Embedded Cluster Monitoring Dashboard A built-in dashboard has been introduced for real-time observability of cluster health. This provides a consolidated view of node status, resource usage, and system metrics directly within the CatalyX interface.

  • Direct Node Health Dump Downloads Users can now download health dump files directly from individual nodes, streamlining diagnostics and enabling faster support workflows.

Improvements

  • Runtime Log Level Management It is now possible to dynamically adjust the log level of running nodes without requiring restarts, providing enhanced control during debugging or incident analysis.

  • Topology Update API A new API has been added to allow live updates to node topology configurations, simplifying the process of managing participant and domain relationships at runtime.

Version 1.4

What’s new

  • Support for Auth0 as ledger authentication provider

Improvements

  • Minor security improvements

  • Minor UX improvements

Version 1.3

What’s new

  • Full remote administration of participant and domain nodes

Improvements

  • See when the next run of the pruning schedule will take place

  • Improved node health feedback

Version 1.2

What’s new

  • Option to enable a PostgreSQL backend for the HTTP JSON API server, for more efficient data caching and improved query performance

  • IAM integration for parties created outside of CAT-BM

Improvements

  • Improved feedback for pruning schedule: Status of last runs, including number of pruned records

  • Increased configurability for already running nodes

  • UI/UX improvements on Collections and input validation

Version 1.1

What’s new

  • Role-based access control

  • A Web UI for the Daml REPL console

  • Pruning: CatalyX now supports pruning leveraging the Canton protocol

Improvements

  • Improvements for Dars/package management

Version 1.0

What’s new

  • Intuitive UI for Canton/Daml deployment & operations

  • Simplified Canton nodes configuration & bootstrap

  • Integrated off-ledger Identity Access Management

  • Party & User management

  • DAR package management

  • Query active contract

  • Deploy Daml client applications

Last updated

Was this helpful?