快速上手

本文介绍两种方式来快速使用PTK部署 MogDB 数据库。

PTK工具本身可以在多种操作系统中运行，支持Linux，macOS，Windows，但是由于 MogDB 目前仅支持 在Linux 系统中运行，因此需确保要运行MogDB数据库的服务器为 Linux 操作系统。MogDB支持的Linux操作系统种类和版本参看通过 PTK 支持安装 MogDB 的操作系统。

下载安装 PTK

执行以下命令在线安装：

curl --proto '=https' --tlsv1.2 -sSf https://cdn-mogdb.enmotech.com/ptk/install.sh | sh

安装完成后会提示如下信息（根据运行PTK的 SHELL 类型不同，信息会有所差异）

info: downloading ptk package
Detected shell: bash
Shell profile:  /root/.bash_profile
ptk has been added to PATH in /root/.bash_profile
open a new terminal or source /root/.bash_profile to active it
Installed path: /root/.ptk/bin/ptk

可以通过提示的 source 指令或打开一个新的终端窗口来使 PTK PATH 环境变量生效。

假如输出的信息如上面的示例输出信息，ptk 已经自动在 /root/.bash_profile 文件中将自己的路径加入 PATH 环境变量。

请注意，并非所有系统都是 ~/.bash_profile，具体要激活哪个文件，请参考安装日志中的提示

以以上输出为例：

source $HOME/.bash_profile

第一种：免配置部署单机测试数据库

免配置方式仅支持Linux操作系统

1) 执行 demo 指令

执行前确保 26000 端口空闲，如果需要使用其他端口，可以通过增加选项 --port <PORT> 指定

使用默认端口方式执行如下指令：

ptk demo

如果 ptk 所在的用户是 root，会在本机创建一个以 demo_user_ 为前缀的随机用户来作为数据库运行用户，并将数据库实例和数据存放在该用户的家目录下。

如果 ptk 所在的用户是普通用户，由于没有权限新建用户，会直接在当前用户的家目录下创建一个示例数据库。

安装完成后，PTK 会在该实例上安装额外的数据库支持的插件来用于测试。

下面是以普通用户 demo 用户安装的演示：

2) 访问数据库

以示例用户 demo 为例

su - demo
gsql -r

第二种：通过配置文件安装数据库

配置文件方式安装既支持本地安装也支持远程安装

1) 准备拓扑配置文件

PTK 安装需用户提供一个 YAML格式 的配置文件, 该配置文件可以通过 PTK 提供的 template 指令生成，如果是为本地安装，则可以执行：

ptk template --local > config.yaml

配置文件的内容如下：

global:
  # 集群名称
  cluster_name: "cluster_etalatint"
  # 运行数据库的系统用户
  user: "omm"
  # 系统用户组，默认和用户名相同
  group: "omm"
  # 数据库的基础目录,
  # 如果 app_dir，data_dir，log_dir 和 tool_dir 都没有配置，
  # PTK 将会在基础目录下自动创建对应的目录
  base_dir: "/opt/mogdb"

db_servers:
  - host: "127.0.0.1" # 本机 IP
    # 数据库端口
    db_port: 26000

如果全部使用默认值，则PTK 执行以下行为：

• 在本机安装数据库
• 运行数据库的操作系统用户为omm ，用户组名称也是omm，该用户没有默认密码；
• 数据库安装在 /opt/mogdb目录下，在该目录下会创建4个目录：app, data, log, tool，分别用于存储数据库软件、数据文件、数据库日志和数据库相关工具；
• 数据库监听端口为26000；

如果需要在其它服务器上安装MogDB，或者是安装主备架构的MogDB，则需要在config.yaml中配置更多信息。详细信息可参考 使用手册。

以下为安装一主一备环境的配置示例。

# config.yaml
global:
    cluster_name: mogdb_cluster1
    user: omm
    group: omm
    base_dir: /opt/mogdb
db_servers:
    - host: 192.168.0.1
      db_port: 26000
      role: primary
      ssh_option:
        port: 22
        user: root
        password: [此处填写SSH登录密码]
    - host: 192.168.0.2
      db_port: 26000
      role: standby
      ssh_option:
        port: 22
        user: root
        password: [此处填写SSH登录密码]

2) 对本机进行系统检查

ptk checkos -f config.yaml

确保输出的检查结果均为 OK 或者 Warning 。

如果有 Abnormal 的检查项出现，PTK默认会自动生成一个 root_fix_os 前缀的 Shell 脚本，您可以通过执行该 Shell 脚本来尝试自动修复异常的检查项。

大部分情况下都是可以自动修复的，如果出现特殊情况，PTK 没有兼容到，需您根据日志提示手动修正。

3) 执行安装

ptk install -f config.yaml

默认会安装当前已经正式发布的 MogDB 最新版本，版本号可以在 MogDB 官网下载页面查询。安装过程中会提示用户输入数据库初始用户的密码，请用户自行记录并安全保存。PTK 自动完成所有安装操作后，会启动数据库实例。

PTK 也支持自定义安装包，可以通过手工下载安装包，指定安装。比如执行以下命令，将使用当前目录下的该安装包进行数据库安装。

ptk install -f config.yaml --pkg ./MogDB-3.0.0-openEuler-arm64.tar.gz

安装成功后，可以通过 ptk ls 来查看安装的实例信息。

4) 访问数据库

su - omm
gsql -r

探索更多

以上示例中的拓扑配置文件以最简化模板提供，方便用户快速体验 MogDB, 若想要更全面的描述集群拓扑，请访问拓扑文件配置章节了解更多参数细节。