OpenCMDB 配置与使用指南

OpenCMDB 配置与使用指南

cmdbCMDB 配置管理系统 资产管理系统项目地址:https://gitcode.com/gh_mirrors/cmdb/cmdb

1. 项目目录结构及介绍

OpenCMDB 的目录结构设计如下：

.
├── conf           # 配置文件存放目录
│   ├── config.yaml  # 主要配置文件
│   └── ...          # 其他相关配置
├── scripts         # 启动与脚本工具目录
│   ├── start.sh     # 服务启动脚本
│   └── stop.sh      # 服务停止脚本
├── src             # 源代码目录
│   ├── app.py       # 主应用入口
│   ├── models       # 数据模型定义
│   ├── controllers  # 控制器逻辑
│   └── ...          # 其他源码
└── requirements.txt  # 依赖包列表

• conf: 存放所有配置文件，包括数据库连接信息、服务设置等。
• scripts: 包含用于启动和停止 OpenCMDB 服务的 shell 脚本。
• src: 开源项目的核心代码，包含了主要的应用逻辑。
  • app.py: 应用程序的主入口点，负责加载配置并启动服务。
  • models: 定义了 CMDB 中的数据结构和配置项（CI）。
  • controllers: 处理 HTTP 请求，提供 API 接口。
• requirements.txt: 列出所有必需的 Python 第三方库。

2. 项目的启动文件介绍

在 scripts 目录下，有以下两个重要脚本用于启动和停止 OpenCMDB 服务：

start.sh

启动脚本 start.sh 负责初始化环境，加载配置并启动 OpenCMDB 服务。运行此脚本前确保已经安装了所有依赖项，并设置了正确的工作环境。

#!/bin/bash
cd <path_to_opencmdb_directory>
source venv/bin/activate  # 如果使用虚拟环境
python src/app.py

注意: 根据你的实际环境，可能需要先创建虚拟环境并激活(venv)，然后安装 requirements.txt 文件中列出的依赖。

stop.sh

停止脚本 stop.sh 通常用于关闭通过 start.sh 启动的服务。由于 OpenCMDB 可能是基于 Python 进程运行，它可能会杀死相应的进程以达到停止服务的目的。

#!/bin/bash
kill $(ps aux | grep '[p]ython src/app.py' | awk '{print $2}')

提示: 在执行 stop.sh 前，请确认确切的进程ID，或者根据你的具体实现调整脚本以匹配正确的终止机制。

3. 项目的配置文件介绍

OpenCMDB 使用 config.yaml 文件作为主要配置文件，位于 conf 目录下。以下是该文件的一些关键部分及其用途：

server:
  host: 0.0.0.0  # 服务器监听地址，默认为0.0.0.0，表示任何可用的网络接口
  port: 8080     # 服务端口号

database:
  type: mysql     # 数据库存储类型，如mysql, postgresql等
  host: localhost  # 数据库主机名或IP地址
  port: 3306       # 数据库端口号
  user: opencmdb   # 数据库用户名
  password: example # 数据库密码
  dbname: cmdb     # 数据库名称

logging:
  level: info      # 日志级别，可以是debug, info, warning, error, critical
  file: logs/app.log   # 日志文件路径

auth:
  enabled: true     # 是否启用身份验证，默认启用
  admin_user: admin # 管理员用户名
  admin_password: example_admin # 管理员密码

根据你的环境，修改这些配置参数以适应你的需求。例如，如果你正在远程数据库上部署，你需要更新 database 部分的 host, port, user, password 和 dbname。

提示: 修改配置文件后，记得重新启动服务以应用新的设置。

通过遵循以上指南，你应该能够成功地了解 OpenCMDB 项目，并根据需要进行配置和部署。祝你在使用过程中一切顺利！

cmdbCMDB 配置管理系统 资产管理系统项目地址:https://gitcode.com/gh_mirrors/cmdb/cmdb