DataKit

功能介绍

openGauss的开发运维涉及到很多复杂操作，DataKit提供了一个可视化操作的运维界面，可以帮助用户管理，安装，监控运维自己的openGauss数据库以及对应的物理机资源。

DataKit是一个以资源（物理机，数据库）为底座的开发运维工具，将上层的开发运维工具插件化，各插件之间相互独立，方便用户按需引入。各插件围绕DataKit的资源中心进行扩展开，完成数据库的运维，监控，迁移，开发，建模等复杂的操作。

原理简介

DataKit是基于spring-brick开发的插件化的工具，前台使用vue，后台使用spring-bot技术栈。DataKit基座提供资源管理，安全中心，日志中心等基础的公共能力，具体的数据库安装，运维，监控，数据迁移等能力是基于spring-brick开发的插件工具，可以灵活的在基座上面安装卸载，方便客户按需使用。

特性优势

本项目是基于Web的openGauss的可视化的一体化工具：DataKit，目的是方便客户使用和管理openGauss可视化工具，可以为客户降低openGauss数据库安装使用门槛，做到安全中心管理，插件管理，以及其它功能包括一键化部署、卸载、组件化安装、多版本升级和日常运维。

环境准备

X86/ARM+openEuler 20.03 或 X86+CentOS 5.7。

操作步骤

  1. 创建工作目录：

    1. mkdir -p /ops/server/openGauss-visualtool/logs /ops/server/openGauss-visualtool/config /ops/ssl /ops/files

  2. 将jar包传至/ops/server/openGauss-visualtool/下，jar包下载地址：https://www.opengauss.org/zh/download/

  3. 将配置文件application-temp.yml传至/ops/server/openGauss-visualtool/config/下。配置文件内容如下：

    1. system:
    2.   # File storage path
    3.   defaultStoragePath: /ops/files
    4.   # Whitelist control switch
    5.   whitelist:
    6.     enabled: false
    7. server:
    8.   port: 9494
    9.   ssl:
    10.     key-store: /ops/ssl/keystore.p12
    11.     key-store-password: password
    12.     key-store-type: PKCS12
    13.     enabled: true
    14.   servlet:
    15.     context-path: /
    16. logging:
    17.   file:
    18.     path: /ops/server/openGauss-visualtool/logs/
    19. spring:
    20.   datasource:
    21.     type: com.alibaba.druid.pool.DruidDataSource
    22.     driver-class-name: org.opengauss.Driver
    23.     url: jdbc:opengauss://ip:port/database?currentSchema=public
    24.     username: dbuser
    25.     password: dbpassword
    26.     druid:
    27.       test-while-idle: false
    28.       test-on-borrow: true
    29.       validation-query: "select 1"
    30.       validation-query-timeout: 30000

  4. 将ssl文件传置/ops/ssl/下，生成ssl文件示例（生成ssl的java必须跟运行DataKit是一个java版本）：

    1. keytool -genkey -noprompt \
    2.     -dname "CN=opengauss, OU=opengauss, O=opengauss, L=Beijing, S=Beijing, C=CN"\
    3.     -alias opengauss\
    4.     -storetype PKCS12 \
    5.     -keyalg RSA \
    6.     -keysize 2048 \
    7.     -keystore /ops/ssl/keystore.p12 \
    8.     -validity 3650 \
    9.     -storepass password

  5. 修改application-temp.yml文件中的数据链链接ip、port、database、dbuser、dbpassword。

  6. 创建ops用户，给ops目录及下面所有文件修改所属用户为执行用户（ops）。

  7. 切换到ops用户，进入/ops/server/openGauss-visualtool目录，执行启动命令：

    1. nohup java -Xms2048m -Xmx4096m -jar /ops/server/openGauss-visualtool/visualtool-main.jar --spring.profiles.active=temp >/ops/server/openGauss-visualtool/logs/visualtool-main.out 2>&1 &\

卸载工具

DataKit工具是Jar包启动的，删除对应的Jar包即可卸载该工具。

注意事项

  1. DataKit使用文档和开发文档：https://gitee.com/opengauss/openGauss-workbench/tree/master/openGauss-visualtool/doc

  2. 基础运维插件：https://gitee.com/opengauss/openGauss-workbench/tree/master/base-ops

  3. 其他插件：https://gitee.com/opengauss/openGauss-workbench/tree/master/plugins