bookkeeper visual manager

BKVM - Apache BookKeeper 的可视化管理器

Bookkeeper Visual Manager 是 Apache Bookkeeper 的开源可视化界面。

特征：

• 连接到 BookKeeper 集群 (4.7+)
• 发现博彩公司和博彩公司状态
• 使用分类账元数据搜索分类账
• 检查账本元数据

用例：

• 检查您的 BookKeeper 集群
• 检查 Bookies 的健康状况
• 查看哪些应用程序正在使用更多资源
• 验证每个应用程序的配置（检查复制）
• 请参阅集群范围配置

路线图：

• 支持多用户访问、多租户和多集群
• 管理博彩公司
• 管理复制
• 验证集群的一致性
• 添加高级查询功能
• 添加API

概述

登录

使用默认帐户（ admin ）和默认密码（ admin ）登录。

博彩公司状态

Bookies 可用性（AVAILABLE、DOWN、READONLY）和磁盘使用情况。

账本监控

搜索特定分类账和分类账元数据。监控账本磁盘使用情况和复制因子。

博彩公司配置

快速入门

要求

为了运行 BookKeeper Visual Manager，您只需要 Unix 机器和 Java 8 运行时。

为了开发 BookKeeper Visual Manager，您需要 Maven 3.6.x 和 Yarn。

使用提供的发布包

从 github 发布页面下载发布包。解压包

通过编辑conf/server.properties来配置服务默认情况下，我们将连接到本地主机上的ZooKeeper，就像您独立使用BookKeeper时一样。

启动服务

 bin/service server start

打开浏览器 http://localhost:4500

用户名和密码为：admin/admin

码头工人

您可以通过运行以下命令来构建 docker 映像：

 mvn clean install -DskipTests
./docker/build.sh

然后你可以运行容器，服务将在 0.0.0.0:4500 上监听：

 docker run --rm -p 4500:4500 -e BKVM_metadataServiceUri='zk+null://<my-zookeeper>:2181/ledgers' bkvm/bkvm:latest

请注意，使用此配置数据库将保留在本地。

如果您想依赖 BookKeeper 来获取所有 BKVM​​ 数据（集群配置、bookies 元数据），您可以使用 JDBC url 选项运行 docker：

 docker run --rm -p 4500:4500 -e BKVM_metadataServiceUri='zk+null://bk:2181/ledgers' 
   -e BKVM_jdbc_url='jdbc:herddb:zookeeper:<my-zookeeper>:2181/herddb?server.mode=diskless-cluster' bkvm/bkvm:latest

由于 HerdDb diskless-cluster模式，BKVM 容器是无状态的。

使用 Helm 在 Kubernetes 上部署 BKVM

您可以使用示例 Helm Chart 在 k8s 上引导 BKVM​​。

使用 Maven Jetty 插件部署 war 应用程序

 git clone https://github.com/diennea/bookkeeper-visual-manager.git
cd bookkeeper-visual-manager
mvn clean install -DskipTests

要传递元数据服务 URI 连接字符串，您必须设置系统属性bookkeeper.visual.manager.metadataServiceUri或运行 bin 文件夹中提供的脚本。

 BVM_PORT=8080
BVM_SERVICEURI=zk+null://localhost:2181/ledgers

./bin/run_dev.sh $BVM_SERVICEURI $BVM_PORT

在容器上部署 war 应用程序

您还可以在容器上部署target/bookkeeper-visual-manager-XX.XX.war并传递系统属性中的bookkeeper.visual.manager.metadataServiceUri位置。

使用 Maven Jetty Runner 部署 war 应用程序

下载 Maven Central 上提供的 jetty-runner jar。

 BVM_PORT=8080
BVM_WAR_PATH=path/to/warfile

# Environment Variable configuration
BVM_CONF_PATH=/path/to/conf java -jar jetty-runner.jar $BVM_WAR_PATH --port $BVM_PORT

高级配置

为了使用更高级的配置，您需要向应用程序提供键/值属性文件。 conf/ 文件夹中提供了一个示例文件。提供的文件也可以是您的 Bookkeeper 服务器配置。

财产	价值
元数据服务Uri	Bookkeeper 服务器的位置。
zk连接超时	首次连接超时。
zk超时	Zookeeper 会话超时。

您可以通过三种方式将此文件提供给应用程序：

1. 系统属性：bookkeeper.visual.manager.config.path

    BVM_PORT=8080
   BVM_CONF_PATH=path/to/warfile
   
   mvn jetty:run 
       -Dbookkeeper.visual.manager.config.path=$BVM_CONF_PATH 
       -Djetty.http.port=$BVM_PORT
   

2. 环境变量：BVM_CONF_PATH

    BVM_PORT=8080
   BVM_WAR_PATH=path/to/warfile
   
   BVM_CONF_PATH=path/to/conf java -jar jetty-runner.jar $BVM_WAR_PATH --port $BVM_PORT
   

3. 部署描述符：web.xml 中的 bookkeeper.visual.manager.config.path

    <context-param>
       <param-name>bookkeeper.visual.manager.config.path</param-name>
       <param-value>path/to/file</param-value>
   </context-param>
   

前端开发

0. 克隆这个仓库
1. 确保您已经安装了node (v11.8.0) 和yarn (1.19.1)。
2. 进入前端文件夹src/main/bvmui
3. 安装依赖项（使用yarn install命令）
4. 自动重新加载（使用yarn serve命令）

    cd src/main/bvmui
   yarn install
   yarn serve
   

5. 构建（使用yarn build命令）

参与其中

请随意创建问题并拉取请求，以便与社区互动。

如果您正在尝试这个项目，请告诉我们，我们将很高兴听到您的用户案例并为您提供帮助。

释放命令

 git checkout master
mvn release:prepare
mvn release:perform

发布图表

1. 更新kubernetes/bkvm/Chart.yaml中的图表版本。

 version=0.0.2
git commit -am "Release chart $version"
git tag bkvm-$version
git push
git push --tags

执照

Bookkeeper Visual Manager 受 Apache 2 许可。