mirror of
https://github.com/veops/cmdb.git
synced 2025-08-28 11:36:47 +08:00
merge origin
This commit is contained in:
137
README.md
137
README.md
@@ -1,11 +1,15 @@
|
||||
<h1 align="center">CMDB</h1>
|
||||
<div align="center">
|
||||
尽可能实现比较通用的运维资产数据的配置和管理
|
||||
|
||||
|
||||
As far as possible to achieve more universal configuration and management of IT resources
|
||||
|
||||
</div>
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](https://github.com/pycook/cmdb/blob/master/LICENSE)
|
||||
|
||||
[](https://github.com/pycook/cmdb/blob/master/LICENSE)
|
||||
[](https://github.com/sendya/ant-design-pro-vue)
|
||||
[](https://github.com/pallets/flask)
|
||||
|
||||
@@ -13,42 +17,113 @@
|
||||
|
||||
|
||||
|
||||
- 在线预览: [CMDB](http://39.100.252.148:8000)
|
||||
- username: admin
|
||||
- password: admin
|
||||
[English](README.md) / [中文](README_cn.md)
|
||||
|
||||
## DEMO ONLINE
|
||||
- preview online: [CMDB](http://121.42.12.46:8000)
|
||||
- username: demo
|
||||
- password: 123456
|
||||
|
||||
Overview
|
||||
> **ATTENTION**: branch `master` may be unstable as the result of continued development, please pull code from [releases](https://github.com/pycook/cmdb/releases)
|
||||
|
||||
----
|
||||

|
||||
## Overview
|
||||
|
||||

|
||||
CMDB is a universal project that can define and manage almost all IT resource, even every resource as long as you want to, which treat all IT resources as resource objects. objects has both attributes and relationship.
|
||||
|
||||
环境和依赖
|
||||
----
|
||||
- 存储: mysql, redis
|
||||
- python版本: python2.7, >=python3.6
|
||||
CMDB's main distinguishing features as compared to other resource systems are:
|
||||
- define attributes of resource objects dynamically,you don't need to define all the attributes at the beginning.
|
||||
- define relationship of resource objects dynamically and simply, even you can draw the relationship through the web.
|
||||
- three view:
|
||||
- resource view: model instance data that users can subscribe
|
||||
- tree view: the model is hierarchical by field, shown in a tree diagram, and users can subscribe
|
||||
- relational view: relationships between models, shown in a tree diagram, **are configurable by the administrator**
|
||||
|
||||
- authority management
|
||||
|
||||
|
||||
安装
|
||||
----
|
||||
- 创建数据库cmdb
|
||||
## Install
|
||||
|
||||
- 拉取代码
|
||||
```bash
|
||||
git clone https://github.com/pycook/cmdb.git
|
||||
cd cmdb
|
||||
cp api/settings.py.example api/settings.py
|
||||
```
|
||||
设置api/settings.py里的database
|
||||
There are various ways of installing CMDB.
|
||||
|
||||
- 安装库
|
||||
- 后端: ```pipenv run pipenv install```
|
||||
- 前端: ```cd ui && yarn install && cd ..```
|
||||
### Install by Docker
|
||||
- prepare: install docker and docker-compose
|
||||
- in directory cmdb
|
||||
```
|
||||
docker-compose up -d
|
||||
```
|
||||
- view: [http://127.0.0.1:8000](http://127.0.0.1:8000)
|
||||
|
||||
### Environment and dependency
|
||||
- database: mysql
|
||||
- cache: redis
|
||||
- python: python2.7, >=python3.6
|
||||
|
||||
### install
|
||||
- start mysql, redis
|
||||
- create mysql database: cmdb
|
||||
- pull code
|
||||
```bash
|
||||
git clone https://github.com/pycook/cmdb.git
|
||||
cd cmdb
|
||||
cp cmdb-api/settings.py.example cmdb-api/settings.py
|
||||
```
|
||||
**set database in config file cmdb-api/settings.py**
|
||||
|
||||
- install library
|
||||
- backend: ```cd cmdb-api && pipenv run pipenv install && cd ..```
|
||||
- frontend: ```cd cmdb-ui && yarn install && cd ..```
|
||||
|
||||
- 创建数据库表 ```flask run flask db-setup```
|
||||
|
||||
- 启动服务
|
||||
- 后端: ```pipenv run flask run```
|
||||
- 前端: ```cd ui && yarn run serve```
|
||||
- 浏览器打开: [http://127.0.0.1:8000](http://127.0.0.1:8000)
|
||||
- create tables of cmdb database:
|
||||
|
||||
in **cmdb-api** directory: ```pipenv run flask db-setup && pipenv run flask init-cache```
|
||||
- suggest step: (default: user:demo,password:123456)
|
||||
|
||||
``` source docs/cmdb.sql```
|
||||
|
||||
- start service
|
||||
- backend: in **cmdb-api** directory: ```pipenv run flask run -h 0.0.0.0```
|
||||
- frontend: in **cmdb-ui** directory: ```yarn run serve```
|
||||
- worker: in **cmdb-api** directory: ```pipenv run celery worker -A celery_worker.celery -E -Q cmdb_async --concurrency=1```
|
||||
|
||||
- homepage: [http://127.0.0.1:8000](http://127.0.0.1:8000)
|
||||
- if not run localhost: please change ip address(**VUE_APP_API_BASE_URL**) in config file **cmdb-ui/.env** into your backend ip address
|
||||
|
||||
### Install by Makefile
|
||||
- start mysql,redis
|
||||
- create mysql database: cmdb
|
||||
- pull code
|
||||
```bash
|
||||
git clone https://github.com/pycook/cmdb.git
|
||||
cd cmdb
|
||||
cp cmdb-api/settings.py.example cmdb-api/settings.py
|
||||
```
|
||||
**set database in config file cmdb-api/settings.py**
|
||||
|
||||
- in cmdb directory,start in order as follows:
|
||||
- enviroment: ```make env```
|
||||
- start API: ```make api```
|
||||
- start UI: ```make ui```
|
||||
- start worker: ```make worker```
|
||||
|
||||
|
||||
## DEMO
|
||||
##### resource view
|
||||

|
||||
|
||||
##### tree view
|
||||

|
||||
|
||||
##### relationship view
|
||||

|
||||
|
||||
##### user subscription
|
||||

|
||||
|
||||
##### define relationship view
|
||||

|
||||
|
||||
-----
|
||||
_**welcome to join us through QQ group(336164978)**_
|
||||
|
||||

|
||||
|
Reference in New Issue
Block a user