cmdb/README.md

4.1 KiB
Raw Blame History

CMDB

As far as possible to achieve more universal g and maintenance of IT resources

License UI API

English / 中文

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.

CMDB's main distinguishing features as compared to other resource systems are:

  • define attributes of resource objects dynamicallyyou 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 viewresource view,tree view,relational view
  • authority management

Install

There are various ways of installing CMDB.

Install by Docker

  • prepare: install docker and docker-compose
  • in directory cmdb
        docker-compose up -d
    
  • view: 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

    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 ..
  • 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: incmdb-apidirectory: pipenv run celery worker -A celery_worker.celery -E -Q cmdb_async --concurrency=1

    • homepage: 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 backend your ip

Install by Makefile

  • start mysql,redis

  • create mysql database: cmdb

  • pull code

    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

resource view

tree view

tree view

relationship view

relationship view

user subscription

user subscription

define relationship view

define relationship view

DEMO ONLINE

  • preview online: CMDB
    • username: demo
    • password: 123456

ATTENTION

ATTENTION: branch master may be unstable as the result of continued development, please pull code from releases


welcome to join us through QQ group336164978

QQgroup