安装cmdb

后端项目

git clone https://gitcafe.com/hudson/cmdb.git
python setup.py install

前端项目

cd app
git clone https://gitcafe.com/hudson/cmdb-front.git

run cmdb

python -m app/server

安装数据库

使用 couchdb 作为后端数据库,安装依赖

sudo yum -y install autoconf
sudo yum -y install autoconf-archive
sudo yum -y install automake
sudo yum -y install curl-devel
sudo yum -y install erlang-asn1
sudo yum -y install erlang-erts
sudo yum -y install erlang-eunit
sudo yum -y install erlang-os_mon
sudo yum -y install erlang-xmerl
sudo yum -y install help2man
sudo yum -y install js-devel
sudo yum -y install libicu-devel
sudo yum -y install libtool
sudo yum -y install perl-Test-Harness

下载

wget http://mirrors.hust.edu.cn/apache/couchdb/source/1.6.1/apache-couchdb-1.6.1.tar.gz
tar xzf apache-couchdb-1.6.1.tar.gz
cd apache-couchdb-1.6.1
./configure --with-erlang=/usr/lib64/erlang/usr/include/
make && sudo make install

启动

Linux

sudo adduser -r -d /usr/local/var/lib/couchdb couchdb
sudo chown -R couchdb /usr/local/var/lib/couchdb
sudo chown -R couchdb /usr/local/var/log/couchdb
sudo chown -R couchdb /usr/local/etc/couchdb/local.ini
sudo chown -R couchdb /usr/local/var/run/couchdb

sudo -u couchdb /usr/local/bin/couchdb -b

or
/usr/local/etc/init.d/couchdb start

MacOS

/usr/local/Cellar/couchdb/1.6.1_3/bin/couchdb

初始化

建库,desgin

./db.sh

test

curl http://localhost:5984/cmdb/_design/service/_view/list
curl http://localhost:5984/cmdb/_design/service/_list/get_service/list?name=tomcat
curl http://localhost:5984/cmdb/_design/project/_view/list?group=true

couchdb design 设计

_design/service

文档内容在design/service.json

views 里定义了list的map函数，作用是列出所有type为service的doc的文档信息 key是doc_id, value是文档的name字段,假设数据库名是cmdb，并且库中有type为service的文档，那么:

curl http://localhost:5984/cmdb/_design/service/_view/list
{"total_rows":4,"offset":0,"rows":[
{"id":"1.2.3.4:3306","key":"1.2.3.4:3306","value":"mysql"},
{"id":"11.22.33.25:4501","key":"11.22.33.25:4501","value":"mysql"},
{"id":"172.16.200.100:2181","key":"172.16.200.100:2181","value":"zookeeper"},
{"id":"172.16.200.100:61616","key":"172.16.200.100:61616","value":"activemq"}
]}

lists 定义了get_service函数，用来处理views返回数据，可以根据name字段过滤doc_id，例如我们只想看name字段是mysql的doc_id:

curl http://localhost:5984/cmdb/_design/service/_list/get_service/list?name=mysql
["1.2.3.4:3306","11.22.33.25:4501"]

_design/project

文档内容在design/project.json

views 里定义了list的map函数，和service的design一样，返回所有type为project的文档信息:

curl http://localhost:5984/cmdb/_design/project/_view/list
{"total_rows":2,"offset":0,"rows":[
{"id":"62f99ca284fb4b028ed2518364378fb1","key":"tlw","value":null},
{"id":"5fbe788baaea2f8fbe863378f504662c","key":"user-center","value":null}
]}

search 函数可以实现查看项目文档内部所有的服务文档信息，服务文档的doc_id都在services字段

curl http://localhost:5984/cmdb/_design/project/_view/search?include_docs=true
{"total_rows":9,"offset":0,"rows":[
{"id":"5fbe788baaea2f8fbe863378f504662c","key":"5fbe788baaea2f8fbe863378f504662c","value":{"_id":"172.16.200.100:2181"},"doc":{"_id":"172.16.200.100:2181","_rev":"1-dc20e6557a0237b8e792cf51f6939be4","ip":"172.16.200.100","type":"service","name":"zookeeper","port":"2181"}},
{"id":"5fbe788baaea2f8fbe863378f504662c","key":"5fbe788baaea2f8fbe863378f504662c","value":{"_id":"172.16.200.100:61616"},"doc":{"_id":"172.16.200.100:61616","_rev":"1-28dd71488be8f386b0096f3e3dfef360","ip":"172.16.200.100","type":"service","name":"activemq","port":"61616"}},
...
{"id":"62f99ca284fb4b028ed2518364378fb1","key":"62f99ca284fb4b028ed2518364378fb1","value":{"_id":"172.16.200.100:2181"},"doc":{"_id":"172.16.200.100:2181","_rev":"1-dc20e6557a0237b8e792cf51f6939be4","ip":"172.16.200.100","type":"service","name":"zookeeper","port":"2181"}}
]}

lists 有2个函数，getPidByName，顾名思义就是根据project的name字段找到doc_id

curl http://localhost:5984/cmdb/_design/project/_list/getPidByName/project/list?name=tlw
62f99ca284fb4b028ed2518364378fb1

第二个search函数用来实现配置管理的，例如查看田联网的zookeeper服务的信息:

curl http://localhost:5984/cmdb/_design/project/_list/search/project/search?include_docs=true&key="62f99ca284fb4b028ed2518364378fb1"&q=zookeeper
{"zookeeper":[
    {"_id":"172.16.200.100:2181","_rev":"1-dc20e6557a0237b8e792cf51f6939be4","ip":"172.16.200.100","type":"service","name":"zookeeper","port":"2181"},
    {"_id":"172.16.200.99:2181","_rev":"1-223ecf6b554a0851e8507afd3acd97fe","ip":"172.16.200.99","type":"service","name":"zookeeper","port":"2181"}
    ]
}

api

database 数据库

/api/v1/

database 是部署环境的概念，例如dev 开发,test 测试, prod正式

在cmdb中每个环境是couchdb 上的不同数据库，用数据库来隔离不同的环境

创建数据库

数据库名只能以小写字母开头,内容必须是字母数字和-,_

curl -X POST http://localhost:8005/api/v1/database/couch-test
{"ok":true}

查看所有数据库

curl http://localhost:8005/api/v1/cmdb
["cmdb", "couch-test"]

删除数据库

curl -X DELETE http://localhost:8005/api/v1/database/couch-test
{"ok":true}

service 服务

/api/v1//service/

service id 用服务的ip和端口表示,例如 192.168.1.1:8080 就是一个service id

这样可以确保id的唯一性

查看服务

列出所有服务的id,返回数组

curl http://localhost:8005/api/v1/cmdb/service/list
["192.168.1.1:8080"，"192.168.1.2:3306" ...]

查看单个服务器的详细情况

curl http://localhost:8005/api/v1/cmdb/service/1.1.1.1:8080
{"name": "tomcat", "ip": "1.1.1.1", "_rev": "229-688a685b088505c1bb8afe94c0458b4f", "_id": "1.1.1.1:8080", "type": "service", "port": "8080"}

查看服务下面某个具体的属性

curl http://localhost:8005/api/v1/cmdb/service/1.1.1.1:8080?q=name
tomcat

添加服务

curl -X POST http://localhost:8005/api/v1/cmdb/service/1.1.1.1:8080 -d 'name=hello'
{"ok":true,"id":"1.1.1.2:8080","rev":"1-356d10b7a0f931b32c1b9820e3c23781"}

服务的名称必须是ip:port的形式，如果服务的端口是2181,3306,8080,11211,22201或者61616可以不用在body中指定name字段

name字段是服务的名称

更新服务

修改一个服务,需要带上服务的当前版本号"_rev",接口上不允许修改ip,port,type这3个字保留字段

请求的body应该写入服务的所有字段属性，例如下面的请求

curl -X PUT http://localhost:8005/api/v1/cmdb/service/1.1.1.1:8080 -d '{"_rev":"1-356d10b7a0f931b32c1b9820e3c23781","name"="jetty"}'
{"ok":true,"id":"1.1.1.2:8080","rev":"2-1bc1ba6164085b23887a7570d4b184ce"}

注意:这个请求的结果并不是把1.1.1.1:8080的name字段修改为'jetty'，而是把1.1.1.1:8080所有非保留字段删除，然后加上name字段，并赋值jetty

删除服务

删除整个服务

curl -X DELETE http://127.0.0.1:8005/api/v1/cmdb/service/1.1.1.1:8080
{"ok": true}

project项目

/api/v1/service/

查看项目

项目id是全局唯一uuid，就是couchdb的doc_id，项目的名字定义在name字段

返回所有项目信息

curl http://127.0.0.1:8005/api/v1/cmdb/project/list
[{"name": "tlw", "id": "62f99ca284fb4b028ed2518364378fb1"}, {"name": "user-center", "id": "5fbe788baaea2f8fbe863378f504662c"}]

查看单个项目

curl http://127.0.0.1:8005/api/v1/cmdb/project/62f99ca284fb4b028ed2518364378fb1
{
  "services": ["172.16.200.100:2181", "172.16.200.99:2181"],
  "_rev": "3-401038697cac9f7939742213aaacb3df",
  "_id": "62f99ca284fb4b028ed2518364378fb1",
  "type": "project", 
  "name": "tlw"
}

单独查看某个属性

curl http://127.0.0.1:8005/api/v1/cmdb/project/62f99ca284fb4b028ed2518364378fb1?q=name
"tlw"
curl http://127.0.0.1:8005/api/v1/cmdb/project/62f99ca284fb4b028ed2518364378fb1?q=services
["172.16.200.100:2181", "172.16.200.99:2181"]
}

查看项目的service详细信息

curl http://127.0.0.1:8005/api/v1/cmdb/search?p=62f99ca284fb4b028ed2518364378fb1
{"project": {"_id": "62f99ca284fb4b028ed2518364378fb1", "name": "tlw"},
 "zookeeper": [
 {"name": "zookeeper", "ip": "172.16.200.100", "_rev": "1-dc20e6557a0237b8e792cf51f6939be4", "_id": "172.16.200.100:2181", "type": "service", "port": "2181"},
 {"name": "zookeeper", "ip": "172.16.200.99", "_rev": "1-223ecf6b554a0851e8507afd3acd97fe", "_id": "172.16.200.99:2181", "type": "service", "port": "2181"}
 ]
 }

添加项目

~~项目id可以是中文，如果自己构造请求需要进行url转义~~ 待完善

curl -X POST http://localhost:8005/api/v1/cmdb/project/<project name> -d 'field=hello'

更新项目

curl -X POST http://localhost:8005/api/v1/cmdb/project/<pid> -d 'field=world'

项目中使用services字段来关联服务，字段值是服务id组成的数组

为项目添加服务

curl -X PUT http://localhost:8005/api/v1/project/<pid> -d 'services=["1.1.1.1:8080","2.2.2.2:9090"]'

删除项目

curl -X DELETE http://localhost:8005/api/v1/project/<pid>

Name		Name	Last commit message	Last commit date
Latest commit History 109 Commits
app		app
design		design
test		test
.gitignore		.gitignore
__init__.py		__init__.py
db.sh		db.sh
readme.md		readme.md
setup.py		setup.py

liuyangc3/cmdb

Folders and files

Latest commit

History

Repository files navigation