mirror of
https://github.com/veops/cmdb.git
synced 2025-08-11 00:21:04 +08:00
docs: update README
This commit is contained in:
songlh
187
README.md
187
README.md
@@ -2,115 +2,136 @@
|
||||
<p align="center">
|
||||
<a href="https://veops.cn"><img src="docs/images/logo.png" alt="维易CMDB" width="300"/></a>
|
||||
</p>
|
||||
<h3 align="center">简单、轻量、通用的运维配置管理数据库</h3>
|
||||
<h4 align="center">简单、轻量、通用的运维配置管理数据库</h4>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/veops/cmdb/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-AGPLv3-brightgreen" alt="License: GPLv3"></a>
|
||||
<a href="https:https://github.com/sendya/ant-design-pro-vue"><img src="https://img.shields.io/badge/UI-Ant%20Design%20Pro%20Vue-brightgreen" alt="UI"></a>
|
||||
<a href="https://github.com/pallets/flask"><img src="https://img.shields.io/badge/API-Flask-brightgreen" alt="API"></a>
|
||||
<a href="https://github.com/veops/cmdb/stargazers">
|
||||
<img src="https://img.shields.io/github/stars/veops/cmdb" alt="Stars Badge"/>
|
||||
</a>
|
||||
<a href="https://github.com/veops/cmdb">
|
||||
<img src="https://img.shields.io/github/forks/veops/cmdb" alt="Forks Badge"/>
|
||||
</a>
|
||||
</p>
|
||||
<p align="center">
|
||||
中文(简体) · <a href="docs/README_en.md">English</a>
|
||||
</p>
|
||||
|
||||
|
||||
------------------------------
|
||||
|
||||
[English](docs/README_en.md) / [中文](README.md)
|
||||
- 产品文档：https://veops.cn/docs/
|
||||
- 在线体验：<a href="https://cmdb.veops.cn" target="_blank">CMDB</a>
|
||||
- username: demo 或者 admin
|
||||
- password: 123456
|
||||
|
||||
> **重要提示**: `master` 分支在开发过程中可能处于 _不稳定的状态_ 。
|
||||
> 请通过[releases](https://github.com/veops/cmdb/releases)获取
|
||||
|
||||
## 系统介绍
|
||||
|
||||
### 系统概览
|
||||
维易CMDB是一个简洁、轻量且高度可定制的运维配置管理数据库（CMDB）。它支持灵活的模型配置和资源自动发现，旨在为企业提供便捷的资产管理解决方案，帮助运维团队高效地管理 IT 基础设施和服务。
|
||||
|
||||
<img src=docs/images/dashboard.png />
|
||||
|
||||
|
||||
### 相关文章
|
||||
|
||||
- <a href="https://mp.weixin.qq.com/s/v3eANth64UBW5xdyOkK3tg" target="_blank">概要设计</a>
|
||||
- <a href="https://github.com/veops/cmdb/tree/master/docs/cmdb_api.md" target="_blank">API 文档</a>
|
||||
- <a href="https://mp.weixin.qq.com/s/rQaf4AES7YJsyNQG_MKOLg" target="_blank">自动发现</a>
|
||||
- 更多文章可以在公众号 **维易科技OneOps** 里查看
|
||||
|
||||
### 特点
|
||||
|
||||
- 灵活性
|
||||
1. 配置灵活，不设定任何运维场景，有内置模板
|
||||
2. 自动发现、入库 IT 资产
|
||||
- 安全性
|
||||
1. 细粒度权限控制
|
||||
2. 完备操作日志
|
||||
- 多应用
|
||||
1. 丰富视图展示维度
|
||||
2. API简单强大
|
||||
3. 支持定义属性触发器、计算属性
|
||||
- 产品文档：[https://veops.cn/docs/](https://veops.cn/docs/)
|
||||
- 在线体验：[https://cmdb.veops.cn](https://cmdb.veops.cn)
|
||||
- 用户名：demo 或者 admin
|
||||
- 密码：123456
|
||||
- **重要提示**：`master` 分支在开发过程中可能处于**不稳定的状态**。请通过 [releases](https://github.com/veops/cmdb/releases) 获取最新稳定版本。
|
||||
|
||||
### 主要功能
|
||||
|
||||
- 自定义模型和模型关系，模型属性支持下拉列表、字体颜色、计算属性等高级特性
|
||||
- 支持计算机、网络设备、存储设备、数据库、中间件、公有云资源等自动发现
|
||||
- 支持资源、层级、关系视图展示
|
||||
- 细粒度访问控制，完备的操作日志
|
||||
- 通用的资源搜索和关系搜索
|
||||
- 支持IP地址管理(IPAM), 数据中心基础设施管理(DCIM)
|
||||
- **自定义模型和模型关系**：支持模型属性的自定义，包括下拉列表、字体颜色、计算属性等高级功能，满足不同业务需求。
|
||||
- **自动发现资源**：支持计算机、网络设备、存储设备、数据库、中间件、公有云资源等自动发现。
|
||||
- **多维度视图展示**：包括资源视图、层级视图、关系视图等，帮助运维人员全面管理资源。
|
||||
- **细粒度权限控制**：通过精确的访问控制和完备的操作日志保障系统的安全性。
|
||||
- **全面的资源搜索功能**：支持灵活的资源和关系搜索，快速定位和操作资源。
|
||||
- **集成 IP 地址管理（IPAM）和数据中心基础设施管理（DCIM）功能**：简化网络资源和数据中心设备的管理。
|
||||
|
||||
更多详细功能，请移步 [维易科技官网](https://veops.cn) 进行了解。
|
||||
|
||||
### 系统特点
|
||||
|
||||
- 灵活性
|
||||
+ 无需指定固定运维场景，支持自由配置并内置多种模板
|
||||
+ 支持自动发现和入库 IT 资产，快速搭建资产管理系统
|
||||
- 安全性
|
||||
+ 细粒度的权限控制机制，确保资源管理的安全性
|
||||
+ 完整的操作日志记录，便于审计和问题追踪
|
||||
- 多应用
|
||||
+ 提供多种视图展示方式，满足不同场景的需求
|
||||
+ 强大的 API 接口，支持深度集成
|
||||
+ 支持定义属性触发器和计算属性，增强数据处理能力
|
||||
|
||||
### 技术栈
|
||||
|
||||
+ 后端：Python [3.8-3.11]
|
||||
+ 数据存储：MySQL、Redis
|
||||
+ 前端：Vue.js
|
||||
+ UI组件库：Ant Design Vue
|
||||
|
||||
### 系统概览
|
||||
|
||||
<table style="border-collapse: collapse; border: 1px solid black;">
|
||||
<tr>
|
||||
<td style="padding: 5px;background-color:#fff;">
|
||||
<img width="400" src="docs/images/cmdb-screenshot-1.png"/>
|
||||
</td>
|
||||
<td style="padding: 5px;background-color:#fff;">
|
||||
<img width="400" src="docs/images/cmdb-screenshot-2.png"/>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td style="padding: 5px;background-color:#fff;">
|
||||
<img width="400" src="docs/images/cmdb-screenshot-3.png"/>
|
||||
</td>
|
||||
<td style="padding: 5px;background-color:#fff;">
|
||||
<img width="400" src="docs/images/cmdb-screenshot-4.png"/>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 更多功能
|
||||
### 1. 搭建
|
||||
|
||||
> 也欢迎移步[维易科技官网](https://veops.cn)，发现更多免费运维系统。
|
||||
+ 方案一：Docker 一键快速构建
|
||||
|
||||
- 第1步: 安装 Docker 环境和 Docker Compose（v2）
|
||||
- 第2步: 拷贝项目代码, `git clone https://github.com/veops/cmdb.git`
|
||||
- 第3步：进入主目录并启动, `docker compose up -d`
|
||||
|
||||
+ 方案二：[本地开发环境搭建](docs/local.md)
|
||||
+ 方案三：[Makefile 安装](docs/makefile.md)
|
||||
|
||||
### 2. 访问
|
||||
- 打开浏览器并访问: [http://127.0.0.1:8000](http://127.0.0.1:8000)
|
||||
- 用户名: demo 或者 admin
|
||||
- 密码: 123456
|
||||
|
||||
## 接入公司
|
||||
|
||||
> 欢迎使用开源CMDB的公司，在 [#112](https://github.com/veops/cmdb/issues/112) 登记
|
||||
+ 欢迎使用开源CMDB的公司，在 [#112](https://github.com/veops/cmdb/issues/112) 登记
|
||||
|
||||
## 安装
|
||||
## 代码贡献
|
||||
我们欢迎所有开发者贡献代码，改善和扩展这个项目。请先阅读我们的[贡献指南](docs/CONTRIBUTING.md)。此外，您还可以通过社交媒体、活动和分享来支持 Veops 的开源。
|
||||
|
||||
### Docker 一键快速构建
|
||||
<a href="https://github.com/veops/cmdb/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=veops/cmdb" />
|
||||
</a>
|
||||
|
||||
[//]: # (> 方法一)
|
||||
- 第一步: 先安装 Docker 环境, 以及Docker Compose (v2)
|
||||
- 第二步: 拷贝项目
|
||||
```shell
|
||||
git clone https://github.com/veops/cmdb.git
|
||||
```
|
||||
- 第三步：进入主目录，执行:
|
||||
```
|
||||
docker compose up -d
|
||||
```
|
||||
## 企业版
|
||||
相比于社区版，维易企业版为企业提供了大量增强功能及技术支持服务，增强功能包括数据合规、数据级联、自动发现扩展、大屏定制等。[企业版详细介绍](https://veops.cn/cmdb)
|
||||
|
||||
[//]: # (> 方法二, 该方法适用于linux系统)
|
||||
## 维易科技的其他开源项目
|
||||
|
||||
[//]: # (- 第一步： 先安装 Docker 环境, 以及Docker Compose (v2))
|
||||
- [OneTerm](https://github.com/veops/oneterm): 一款简单、轻量、灵活的堡垒机服务。
|
||||
- [messenger](https://github.com/veops/messenger): 一个简单轻量的消息发送服务。
|
||||
- [ACL](https://github.com/veops/acl): 一个简单通用的权限管理系统设计与实践。
|
||||
- [ops-tools](https://github.com/veops/ops-tools): 运维的一些常用实践和代码。
|
||||
|
||||
[//]: # (- 第二步： 直接使用项目根目录下的install.sh 文件进行 `安装`、`启动`、`暂停`、`查状态`、`删除`、`卸载`)
|
||||
## 相关文章
|
||||
|
||||
[//]: # (```shell)
|
||||
- <a href="https://mp.weixin.qq.com/s/v3eANth64UBW5xdyOkK3tg" target="_blank">尽可能通用的运维CMDB的设计与实践(Ⅰ) - 概览</a>
|
||||
- <a href="https://mp.weixin.qq.com/s/rQaf4AES7YJsyNQG_MKOLg" target="_blank">尽可能通用的运维CMDB的设计与实践(ⅠⅠ) - 自动发现</a>
|
||||
- <a href="https://github.com/veops/cmdb/tree/master/docs/cmdb_api.md" target="_blank">CMDB接口文档</a>
|
||||
|
||||
[//]: # (curl -so install.sh https://raw.githubusercontent.com/veops/cmdb/deploy_on_kylin_docker/install.sh)
|
||||
更多文章可以在公众号 **维易科技OneOps** 里查看
|
||||
|
||||
[//]: # (sh install.sh install)
|
||||
## 与我联系
|
||||
|
||||
[//]: # (```)
|
||||
|
||||
### [本地开发环境搭建](docs/local.md)
|
||||
|
||||
### [Makefile 安装](docs/makefile.md)
|
||||
|
||||
## 验证
|
||||
- 浏览器打开: [http://127.0.0.1:8000](http://127.0.0.1:8000)
|
||||
- username: demo 或者 admin
|
||||
- password: 123456
|
||||
|
||||
|
||||
---
|
||||
|
||||
_**欢迎关注公众号(维易科技OneOps)，关注后可加入微信群，进行产品和技术交流。**_
|
||||
|
||||
|
||||
<p align="center">
|
||||
<img src="docs/images/wechat.png" alt="公众号: 维易科技OneOps" />
|
||||
</p>
|
||||
+ 邮箱: <a href="mailto:bd@veops.cn">bd@veops.cn</a>
|
||||
+ 公众号：**维易科技OneOps**。关注后可以加入微信群，参与产品和技术交流
|
||||
<img src="docs/images/wechat.png" alt="公众号: 维易科技OneOps" />
|
||||
Reference in New Issue
Block a user