Bookkeeper Visual Manager

Overview

BKVM (Bookkeeper Visual Manager) is an open source visual interface designed for Apache BookKeeper. This tool allows users to connect to a BookKeeper cluster, discover bookies and their status, search for specific ledgers, inspect ledger metadata, monitor ledger disk usage and replication factor, and validate the configuration of each application in the cluster. With a user-friendly interface, BKVM provides a convenient way to manage and monitor your BookKeeper cluster.

Features

• Connect to a BookKeeper cluster (version 4.7+)
• Discover bookies and their status (available, down, readonly)
• Search for specific ledgers and inspect their metadata
• Monitor ledger disk usage and replication factor
• Ability to manage bookies and replication
• Verify consistency of the cluster
• Advanced query functions
• API support

Docker

• Build the Docker image.
• Run the container, and the service will be available at http://0.0.0.0:4500.
• Note: The database will be persisted locally with this configuration. If you want to rely on BookKeeper for all BKVM data, use the JDBC URL option.

Helm (Kubernetes)

• Use the provided sample Helm Chart to deploy BKVM on Kubernetes.
• The war application can be deployed using Maven Jetty Plugin or on a container.
• Set the bookkeeper.visual.manager.metadataServiceUri system property or run the provided script in the bin folder to pass the Metadata Service URI connection string.

For advanced configuration, provide a key-value properties file to the application. An example file is provided in the conf/ folder, which can also be used as your BookKeeper Server configuration.

Summary

BKVM is a powerful open source visual interface for Apache BookKeeper. With its user-friendly interface, users can easily manage and monitor their BookKeeper cluster. Its features include connecting to a cluster, discovering bookies, searching ledgers, inspecting metadata, monitoring disk usage and replication, and validating configurations. Installation is straightforward, and options such as Docker and Kubernetes deployment are also available for more convenient usage.