OceanBase Deployer 安装与使用手册

OceanBase Deployer 安装与使用手册

obdeploy A deployer and package manager for OceanBase open-source software. 项目地址: https://gitcode.com/gh_mirrors/ob/obdeploy

OceanBase Deployer (OBD) 是一个专为 OceanBase 开源数据库设计的部署工具兼包管理器。本手册旨在引导您了解项目结构、启动与配置关键要素，以便您能够顺利地安装并使用该工具来管理和部署您的 OceanBase 集群。

1. 项目的目录结构及介绍

OceanBase Deployer 的仓库遵循清晰的结构以支持其功能：

• 根目录:

  • config_parser, optimize, plugins, profile, services, web: 这些目录包含了处理配置解析、优化逻辑、插件实现、环境配置、服务相关脚本以及Web界面相关代码的功能模块。
  • LICENSE, README.md: 许可协议文件和项目的读我文件，提供了版权信息和快速入门指导。
  • requirements.txt, requirements3.txt: Python依赖列表，分别对应不同的Python版本需求。
  • build.sh, build_obd: 构建和编译脚本，用于从源码编译安装。
  • ob-deploy.spec: RPM包构建规范文件，用于CentOS系统的RPM包制作。

• 核心脚本与配置:

  • 系统初始化和环境准备脚本如init.sh。
  • 核心逻辑代码主要分布在.py文件中，例如_manager.py, _repository.py, 表明了组件管理和仓库操作等功能。

2. 项目的启动文件介绍

OBD的核心不在单个启动文件上，而是一系列命令集合。然而，有以下几个关键步骤或命令对于启动OBD至关重要：

• 通过RPM安装: 在CentOS 7或更高版本上，使用YUM配置OceanBase的repo，然后安装ob-deploy包后，可通过运行source /etc/profile.d/obd.sh使OBD命令立即可用。
• 从源码安装: 完成必要的依赖安装后，运行pip install -r requirements3.txt来安装Python依赖，执行build.sh编译，再通过source /etc/profile.d/obd.sh加载环境变量。

实际启动OceanBase集群不涉及传统意义上的“启动文件”，而是通过命令行接口，如执行obd demo快速部署本地测试环境。

3. 项目的配置文件介绍

OBD的部署配置是以YAML格式的文件存在的，这是操作集群的关键。这些配置文件通常包括但不限于：

• 部署配置文件: 未明确指定具体文件名，但由obd cluster edit-config或obd cluster deploy -c <config>命令所操作的YAML文件。它定义了服务器登录信息、组件详情、配置信息以及服务器列表等。

  • 关键字段示例:
    • oceanbase-ce: 包含特定版本声明，如version: 3.1.0控制OceanBase CE版本。
    • 自定义配置项，例如修改启动参数，可以通过调整对应的插件目录下的配置文件，如~/obd/plugins/oceanbase-ce/<版本>/start.py。

• 环境与定制配置: 用户可能需要自定义的配置，这通常通过修改或创建的YAML配置文件完成，该文件需详细记录所有部署相关的细节，确保OBD可以根据这些信息正确地进行部署和管理。

通过上述指南，您可以更好地理解和操作OceanBase Deployer，有效管理您的OceanBase数据库部署流程。记得参考官方文档和命令帮助(obd --help)获取更详尽的信息。

obdeploy A deployer and package manager for OceanBase open-source software. 项目地址: https://gitcode.com/gh_mirrors/ob/obdeploy