BK-CMDB

蓝鲸配置平台（蓝鲸CMDB）是一个面向资产及应用的企业级配置管理平台。

本文档内容为如何在 Kubernetes 集群上部署 BK-CMDB 服务。

说明：内置的mongodb、redis、zookeeper、elasticsearch等组件仅用于测试环境，正式环境部署必须配置为外部组件。

BK-CMDB 部署项目

架构设计

点击这里

部署

环境要求

Kubernetes 1.12+
Helm 3+

安装Chart

使用以下命令安装名称为bkcmdb的release, 其中<bkcmdb helm repo url>代表helm仓库地址, password为自己设置的任意密码:

$ helm repo add bkee <bkcmdb helm repo url>
$ helm install bkcmdb bkee/bkcmdb --set mongodb.auth.password=${password} --set redis.auth.password=${password}

上述命令将使用默认配置在Kubernetes集群中部署bkcmdb, 并输出访问指引。

卸载Chart

使用以下命令卸载bkcmdb:

$ helm uninstall bkcmdb

上述命令将移除所有和bkrepo相关的Kubernetes组件。

Chart依赖

bitnami/mongodb
bitnami/redis
bitnami/zookeeper
bitnami/elasticsearch

配置说明

各项配置集中在仓库的一个values.yaml文件之中

镜像配置

参数	描述	默认值
image.registry	镜像源域名	mirrors.tencent.com
image.pullPolicy	镜像拉取策略	IfNotPresent

启动时初始化配置说明

启动时会执行job，分别对cmdb依赖的mongodb数据库进行初始化操作，以及往GSE注册dataid

参数	描述	默认值
migrate.enabled	是否在执行helm时启动该job	true
migrate.image.repository	初始化job所需要的镜像仓库地址	migrate
migrate.image.tag	初始化job所需要的镜像版本	{TAG_NAME}
migrateDataId	是否在启动时往GSE注册dataid	false

蓝鲸产品URL配置

参数	描述	默认值
bkPaasUrl	paas地址	http://paas.example.com
bkIamApiUrl	bkiam后端地址	http://bkiam-web
bkComponentApiUrl	蓝鲸ESB地址	http://bkapi.paas.example.com
bkLoginApiUrl	蓝鲸登录地址	http://bk-login-web
bkNodemanUrl	节点管理地址	http://apps.paas.example.com/bk--nodeman

adminserver服务配置说明

参数	描述	默认值
adminserver.enabled	是否在执行helm时启动	true
adminserver.image.repository	服务镜像名	cmdb_adminserver
adminserver.image.tag	服务镜像版本	{TAG_NAME}
adminserver.replicas	pod副本数量	1
adminserver.port	服务端口	80
adminserver.configDir	需要的配置文件路径	/data/cmdb/cmdb_adminserver/configure
adminserver.errors	需要的错误文件路径	/data/cmdb/cmdb_adminserver/conf/errors
adminserver.language	需要的语言文件路径	/data/cmdb/cmdb_adminserver/conf/language
adminserver.command.logDir	日志存放路径	/data/cmdb/cmdb_adminserver/logs
adminserver.command.logLevel	日志等级	3
adminserver.command.logToStdErr	是否把日志输出到stderr	false
adminserver.workDir	工作目录	/data/cmdb/cmdb_adminserver

apiserver服务配置说明

参数	描述	默认值
apiserver.enabled	是否在执行helm时启动	true
apiserver.image.repository	服务镜像名	cmdb_apiserver
apiserver.image.tag	服务镜像版本	{TAG_NAME}
apiserver.replicas	pod副本数量	1
apiserver.port	服务端口	80
apiserver.command.logDir	日志存放路径	/data/cmdb/cmdb_apiserver/logs
apiserver.command.logLevel	日志等级	3
apiserver.command.logToStdErr	是否把日志输出到stderr	false
apiserver.workDir	工作目录	/data/cmdb/cmdb_apiserver

authserver服务配置说明

参数	描述	默认值
authserver.enabled	是否在执行helm时启动	true
authserver.image.repository	服务镜像名	cmdb_authserver
authserver.image.tag	服务镜像版本	{TAG_NAME}
authserver.replicas	pod副本数量	1
authserver.port	服务端口	80
authserver.ingress.enabled	开启ingress访问	true
authserver.ingress.hosts	ingress代理访问的域名	cmdb-auth.example.com
authserver.command.logDir	日志存放路径	/data/cmdb/cmdb_authserver/logs
authserver.command.logLevel	日志等级	3
authserver.command.logToStdErr	是否把日志输出到stderr	false
authserver.workDir	工作目录	/data/cmdb/cmdb_authserver

cacheservice服务配置说明

参数	描述	默认值
cacheservice.enabled	是否在执行helm时启动	true
cacheservice.image.repository	服务镜像名	cmdb_cacheservice
cacheservice.image.tag	服务镜像版本	{TAG_NAME}
cacheservice.replicas	pod副本数量	1
cacheservice.port	服务端口	80
cacheservice.command.logDir	日志存放路径	/data/cmdb/cmdb_cacheservice/logs
cacheservice.command.logLevel	日志等级	3
cacheservice.command.logToStdErr	是否把日志输出到stderr	false
cacheservice.workDir	工作目录	/data/cmdb/cmdb_cacheservice

cloudserver服务配置说明

参数	描述	默认值
cloudserver.enabled	是否在执行helm时启动	true
cloudserver.image.repository	服务镜像名	cmdb_cloudserver
cloudserver.image.tag	服务镜像版本	{TAG_NAME}
cloudserver.replicas	pod副本数量	1
cloudserver.port	服务端口	80
cloudserver.command.logDir	日志存放路径	/data/cmdb/cmdb_cloudserver/logs
cloudserver.command.logLevel	日志等级	3
cloudserver.command.logToStdErr	是否把日志输出到stderr	false
cloudserver.command.enableCryptor	是否开启加密服务	false
cloudserver.workDir	工作目录	/data/cmdb/cmdb_cloudserver

coreservice服务配置说明

参数	描述	默认值
coreservice.enabled	是否在执行helm时启动	true
coreservice.image.repository	服务镜像名	cmdb_coreservice
coreservice.image.tag	服务镜像版本	{TAG_NAME}
coreservice.replicas	pod副本数量	1
coreservice.port	服务端口	80
coreservice.command.logDir	日志存放路径	/data/cmdb/cmdb_coreservice/logs
coreservice.command.logLevel	日志等级	3
coreservice.command.logToStdErr	是否把日志输出到stderr	false
coreservice.workDir	工作目录	/data/cmdb/cmdb_coreservice

datacollection服务配置说明

参数	描述	默认值
datacollection.enabled	是否在执行helm时启动	true
datacollection.image.repository	服务镜像名	cmdb_datacollection
datacollection.image.tag	服务镜像版本	{TAG_NAME}
datacollection.replicas	pod副本数量	1
datacollection.port	服务端口	80
datacollection.command.logDir	日志存放路径	/data/cmdb/cmdb_datacollection/logs
datacollection.command.logLevel	日志等级	3
datacollection.command.logToStdErr	是否把日志输出到stderr	false
datacollection.workDir	工作目录	/data/cmdb/cmdb_datacollection

eventserver服务配置说明

参数	描述	默认值
eventserver.enabled	是否在执行helm时启动	true
eventserver.image.repository	服务镜像名	cmdb_eventserver
eventserver.image.tag	服务镜像版本	{TAG_NAME}
eventserver.replicas	pod副本数量	1
eventserver.port	服务端口	80
eventserver.command.logDir	日志存放路径	/data/cmdb/cmdb_eventserver/logs
eventserver.command.logLevel	日志等级	3
eventserver.command.logToStdErr	是否把日志输出到stderr	false
eventserver.workDir	工作目录	/data/cmdb/cmdb_eventserver

hostserver服务配置说明

参数	描述	默认值
hostserver.enabled	是否在执行helm时启动	true
hostserver.image.repository	服务镜像名	cmdb_hostserver
hostserver.image.tag	服务镜像版本	{TAG_NAME}
hostserver.replicas	pod副本数量	1
hostserver.port	服务端口	80
hostserver.command.logDir	日志存放路径	/data/cmdb/cmdb_hostserver/logs
hostserver.command.logLevel	日志等级	3
hostserver.command.logToStdErr	是否把日志输出到stderr	false
hostserver.workDir	工作目录	/data/cmdb/cmdb_hostserver

operationserver服务配置说明

参数	描述	默认值
operationserver.enabled	是否在执行helm时启动	true
operationserver.image.repository	服务镜像名	cmdb_operationserver
operationserver.image.tag	服务镜像版本	{TAG_NAME}
operationserver.replicas	pod副本数量	1
operationserver.port	服务端口	80
operationserver.command.logDir	日志存放路径	/data/cmdb/cmdb_operationserver/logs
operationserver.command.logLevel	日志等级	3
operationserver.command.logToStdErr	是否把日志输出到stderr	false
operationserver.workDir	工作目录	/data/cmdb/cmdb_operationserver

procserver服务配置说明

参数	描述	默认值
procserver.enabled	是否在执行helm时启动	true
procserver.image.repository	服务镜像名	cmdb_procserver
procserver.image.tag	服务镜像版本	{TAG_NAME}
procserver.replicas	pod副本数量	1
procserver.port	服务端口	80
procserver.command.logDir	日志存放路径	/data/cmdb/cmdb_procserver/logs
procserver.command.logLevel	日志等级	3
procserver.command.logToStdErr	是否把日志输出到stderr	false
procserver.workDir	工作目录	/data/cmdb/cmdb_procserver

taskserver服务配置说明

参数	描述	默认值
taskserver.enabled	是否在执行helm时启动	true
taskserver.image.repository	服务镜像名	cmdb_taskserver
taskserver.image.tag	服务镜像版本	{TAG_NAME}
taskserver.replicas	pod副本数量	1
taskserver.port	服务端口	80
taskserver.command.logDir	日志存放路径	/data/cmdb/cmdb_taskserver/logs
taskserver.command.logLevel	日志等级	3
taskserver.command.logToStdErr	是否把日志输出到stderr	false
taskserver.workDir	工作目录	/data/cmdb/cmdb_taskserver

toposerver服务配置说明

参数	描述	默认值
toposerver.enabled	是否在执行helm时启动	true
toposerver.image.repository	服务镜像名	cmdb_toposerver
toposerver.image.tag	服务镜像版本	{TAG_NAME}
toposerver.replicas	pod副本数量	1
toposerver.port	服务端口	80
toposerver.command.logDir	日志存放路径	/data/cmdb/cmdb_toposerver/logs
toposerver.command.logLevel	日志等级	3
toposerver.command.logToStdErr	是否把日志输出到stderr	false
toposerver.workDir	工作目录	/data/cmdb/cmdb_toposerver

synchronizeserver服务配置说明

参数	描述	默认值
synchronizeserver.enabled	是否在执行helm时启动	true
synchronizeserver.image.repository	服务镜像名	cmdb_synchronizeserver
synchronizeserver.image.tag	服务镜像版本	{TAG_NAME}
synchronizeserver.replicas	pod副本数量	1
synchronizeserver.port	服务端口	80
synchronizeserver.command.logDir	日志存放路径	/data/cmdb/cmdb_synchronizeserver/logs
synchronizeserver.command.logLevel	日志等级	3
synchronizeserver.command.logToStdErr	是否把日志输出到stderr	false
synchronizeserver.workDir	工作目录	/data/cmdb/cmdb_synchronizeserver

webserver服务配置说明

参数	描述	默认值
webserver.enabled	是否在执行helm时启动	true
webserver.image.repository	服务镜像名	cmdb_webserver
webserver.image.tag	服务镜像版本	{TAG_NAME}
webserver.replicas	pod副本数量	1
webserver.port	服务端口	80
webserver.ingress.enabled	开启ingress访问	true
webserver.ingress.hosts	ingress代理访问的域名	cmdb.example.com
webserver.service.type	服务类型	ClusterIP
webserver.service.targetPort	代理的目标端口	80
webserver.service.nodePort	访问端口
webserver.command.logDir	日志存放路径	/data/cmdb/cmdb_webserver/logs
webserver.command.logLevel	日志等级	3
webserver.command.logToStdErr	是否把日志输出到stderr	false
webserver.workDir	工作目录	/data/cmdb/cmdb_webserver

服务开启鉴权开关

参数	描述	默认值
iam.auth.enable	是否开启鉴权	false

common开头的配置

以common开头的配置，对应的是cmdb中common.yaml的配置文件中的各项配置，可根据原common.yaml中的配置对common开头的配置进行修改

mongodb配置

参数	描述	默认值
mongodb.enabled	是否部署mognodb，如果需要使用外部数据库，设置为`false`并配置`mongodb.externalMongodb`和`mongodb.watch`下关于外部mongodb的配置	true

mongodb.externalMongodb 和 mongodb.watch 开头的配置，可根据原mongodb.yaml中的配置进行修改

redis配置

参数	描述	默认值
redis.enabled	是否部署redis，如果需要使用外部数据库，设置为`false`并配置`redis.redis`、`redis.snapshotRedis`、`redis.discoverRedis`、`redis.netCollectRedis`下关于外部redis的配置	true

redis.redis、redis.snapshotRedis、redis.discoverRedis、redis.netCollectRedis 开头的配置，可根据原redis.yaml中的配置进行修改

zookeeper配置

参数	描述	默认值
zookeeper.enabled	是否部署zookeeper作为配置发现中心、服务发现中心，如果需要使用外部zookeeper组件，设置为`false`并配置`configAndServiceCenter.addr`	true

配置发现中心、服务发现中心配置

参数	描述	默认值
configAndServiceCenter.addr	外部配置发现中心、服务发现中心地址，当zookeeper.enabled配置为`false`时，使用此参数连接外部组件

elasticsearch配置

参数	描述	默认值
common.es.fullTextSearch	开启全文索引开关，可选值为`on` 和 `off`, 默认关闭	off
common.es.url	连接外部es的url
common.es.usr	连接外部es的用户名
common.es.pwd	连接外部es的密码
elasticsearch.enabled	是否启动内部部署的es，如果需要使用外部es组件，设置为`false`并配置`common.es.url`、`common.es.usr`、`common.es.pwd`的外部组件信息	false
elasticsearch.master.replicas	内置es的master节点数	1
elasticsearch.coordinating.replicas	内置es的协调节点数	1
elasticsearch.data.replicas	内置es的数据节点数	1

monstache配置

monstache是一个用于将mongodb的数据同步到es去创建索引的一个组件

参数	描述	默认值
monstache.enabled	是否启动内部部署的monstache，如果需要使用外部monstache组件，设置为`false`	false
monstache.image.repository	服务镜像名	cmdb_monstache
monstache.image.tag	服务镜像版本	{TAG_NAME}
monstache.replicas	pod副本数量	1
monstache.port	服务端口	80
monstache.workDir	工作路径	/data/cmdb/monstache
monstache.configDir	需要的配置文件路径	/data/cmdb/monstache/etc
monstache.directReadDynamicIncludeRegex	monstache配置内容	内容过长请查看原value.yaml文件
monstache.mapperPluginPath	monstache配置内容	/data/cmdb/monstache/monstache-plugin.so
monstache.elasticsearchShardNum	monstache配置内容	1
monstache.elasticsearchReplicaNum	monstache配置内容	1

bkLogConfig配置

bkLogConfig配置用于配置接入蓝鲸日志平台功能

参数	描述	默认值
bkLogConfig.file.enabled	是否采集容器内落地文件日志	false
bkLogConfig.file.dataId	采集容器内落地文件日志的dataid，dataid在日志平台上申请分配	1
bkLogConfig.std.enabled	是否采集容器标准输出日志	false
bkLogConfig.std.dataId	采集容器标准输出日志的dataid，dataid在日志平台上申请分配	1

serviceMonitor配置

serviceMonitor配置用于配置服务监控功能

参数	描述	默认值
serviceMonitor.enabled	是否开启服务监控，采集cmdb业务指标数据	false
serviceMonitor.interval	cmdb业务指标数据采集间隔时间	15s

证书相关配置

参数	描述	默认值
certPath	证书的挂载pod里的路径	"/data/cmdb/cert"
gseCert.ca	gse的CA证书	""
gseCert.cmdbCert	cmdb连接gse服务所需要的证书	""
gseCert.cmdbKey	cmdb连接gse服务所需要的证书的密钥	""

配置案例

1. 使用外接mongodb

mongodb:
  enabled: false
  ...
  # external mongo configuration
  externalMongodb:
    enabled: xxx
    usr: xxx
    pwd: xxx
    database: xxx
    host: 127.0.0.1:27017
    maxOpenConns: xxx
    maxIdleConns: xxx
    mechanism: xxx
    rsName: xxx
    socketTimeoutSeconds: xxx
  watch:
    usr: xxx
    pwd: xxx
    database: xxx
    host: 127.0.0.1:27017
    maxOpenConns: xxx
    maxIdleConns: xxx
    mechanism: xxx
    rsName: xxx
    socketTimeoutSeconds: xxx

2. 使用外接redis

redis:
  enabled: false
  ...
  # external redis configuration
  redis:
    host: 127.0.0.1:6379
    pwd: xxx
    database: xxx
    maxOpenConns: xxx
    maxIdleConns: xxx
    sentinelPwd: xxx
    masterName: xxx

  snapshotRedis:
    host: 127.0.0.1:6379
    pwd: xxx
    database: xxx
    maxOpenConns: xxx
    maxIdleConns: xxx
    sentinelPwd: xxx
    masterName: xxx

  discoverRedis:
    host: 127.0.0.1:6379
    pwd: xxx
    database: xxx
    maxOpenConns: xxx
    maxIdleConns: xxx
    sentinelPwd: xxx
    masterName: xxx

  netCollectRedis:
    host: 127.0.0.1:6379
    pwd: xxx
    database: xxx
    maxOpenConns: xxx
    maxIdleConns: xxx
    sentinelPwd: xxx
    masterName: xxx

3. 使用外接zookeeper作为配置发现中心和服务发现中心

zookeeper:
  enabled: false
configAndServiceCenter:
  addr: 127.0.0.1:2181

4. 使用elasticsearch相关操作

如果在cmdb中使用es，首先需要开始es的开关

common:
  es:
    fullTextSearch: "on"

在cmdb中使用elasticsearch需要依赖两个组件，一个是elasticsearch本身，一个monstache（用于将mongodb数据同步到elasticsearch）

（1）使用内置组件

helm chart中有内置的elasticsearch和monstache，可通过下面操作打开：
```
elasticsearch:
  enabled: true

··

monstache:
  enabled: true
```
将elasticsearch和monstache的enabled变为true即可

（2）使用外接组件

这里仅需配置连接外置的elasticsearch，这时外置的monstach已经与cmdb没有配置上的联系
```
common:
  es: 
    url: xxx
    usr: xxx
    pwd: xxx
```
配置上外部es的url，账户密码的信息即可
当然也可以使用内置的monstache，连接外部的elasticsearch
```
monstache:
  enabled: true
	
···

common:
  es: 
    url: xxx
    usr: xxx
    pwd: xxx
```
将monstache.enabled变为true，配置好外部的elasticsearch的配置即可

5. 配置webserver不同的服务暴露方式

默认通过Ingress暴露服务，也可以使用以下方式：

使用NodePort直接访问

webserver:
  ingress:
    enabled: false
    ...
  service:
    type: "NodePort"   
    ports:
      ...
        nodePort: 32033 # 端口可以自定义

common:
  ...
  site:
    domainUrl: http://127.0.0.1:32033/ # ip需要根据实际情况的进行配置，端口为上面配置的同一端口

修改上述配置后，即可通过ip:32033的方式访问

6. 开启权限验证

通过进行下面的配置：

开启权限
iam:
  auth:
    enabled: true

// 配置权限中心和esb地址、app code、app secret，开启前端的auth
bkIamApiUrl: xxx
bkComponentApiUrl: xxx

common:
 ...
  auth:
    appCode: xxx
    appSecret: xxx
  esb:
    appCode: xxx
    appSecret: xxx
 ...
  webServer:
    site:
      authScheme: iam

7. blueking方式登陆

通过将登陆方式设置为蓝鲸登陆方式和配置蓝鲸登陆地址等信息：

# pass地址
bkPaasUrl: xxx
# bk-login地址
bkLoginApiUrl: xxx

common:
  ...
  webServer:
    site:
      appCode: bk_cmdb
    ...
    login:
      version: blueking

8. 配置authserver不同的服务暴露方式

默认通过Ingress暴露服务，也可以使用以下方式：

使用NodePort直接访问

authserver:
  ingress:
    enabled: false
    ...
  service:
    type: "NodePort"   
    ports:
      ...
        nodePort: 32033 # 端口可以自定义

修改上述配置后，即可通过ip:32033方式对外暴露访问

常见问题

1. cmdb的helm chart启动后如何访问

答：因为默认的访问方式是通过ingress访问，域名为 cmdb.bk.com，所以需要配置 cmdb.bk.com 的dns解析，例如在机器的/usr/hosts文件中配置：

127.0.0.1 cmdb.bk.com

在minikube环境通过下面指令启用Ingress控制器

  minikube addons enable ingress

配置完后，通过访问cmdb.bk.com/login地址进行登陆，默认的账号为cc，密码为cc

2. cmdb启动不起来

答：

1、cmdb启动需要依赖的redis、mongodb、zookeeper等，部分服务需要等依赖的组件ready后才可以启动，再加上需要等adminserver启动完后，有一个bootstrap的job需要执行，所以需要等待一段时间服务才能启动

2、authserver需要相关配置连接权限中心，如果没有配置是启动不来的，根据默认配置无法启动。可通过修改

authserver:
  enabled: false

变为false不启动authserver服务或者配置权限中心所需要的配置

如果长时间有些服务无法启动，如：toposerver，请确认job是否启动并执行完成

3. 想要配置多个外置zookeeper地址作为服务中心怎么办？

答：通过,(逗号)分隔，如下：

configAndServiceCenter:
  addr: 127.0.0.1:2181,127.0.0.2:2181

4. 想要配置多个外置redis地址怎么办？

答：通过,(逗号)分隔，如下：

redis:
  ...
  # external redis configuration
  redis:
    host: 127.0.0.1:6379,128.0.0.1:6379

5. 想要配置多个外置mongo地址怎么办？

答：通过,(逗号)分隔，如下：

mongodb:
  # external mongo configuration
  externalMongodb:
    enabled: xxx
    usr: xxx
    pwd: xxx
    database: xxx
    host: 127.0.0.1:27017,127.0.0.1:27018

Files

README.md

Latest commit

History

README.md

File metadata and controls

BK-CMDB

BK-CMDB 部署项目

架构设计

部署

环境要求

安装Chart

卸载Chart

Chart依赖

配置说明

镜像配置

启动时初始化配置说明

蓝鲸产品URL配置

adminserver服务配置说明

apiserver服务配置说明

authserver服务配置说明

cacheservice服务配置说明

cloudserver服务配置说明

coreservice服务配置说明

datacollection服务配置说明

eventserver服务配置说明

hostserver服务配置说明

operationserver服务配置说明

procserver服务配置说明

taskserver服务配置说明

toposerver服务配置说明

synchronizeserver服务配置说明

webserver服务配置说明

服务开启鉴权开关

common开头的配置

mongodb配置

redis配置

zookeeper配置

配置发现中心、服务发现中心配置

elasticsearch配置

monstache配置

bkLogConfig配置

serviceMonitor配置

证书相关配置

配置案例

1. 使用外接mongodb

2. 使用外接redis

3. 使用外接zookeeper作为配置发现中心和服务发现中心

4. 使用elasticsearch相关操作

5. 配置webserver不同的服务暴露方式

6. 开启权限验证

7. blueking方式登陆

8. 配置authserver不同的服务暴露方式

常见问题

1. cmdb的helm chart启动后如何访问

2. cmdb启动不起来

3. 想要配置多个外置zookeeper地址作为服务中心怎么办？

4. 想要配置多个外置redis地址怎么办？

5. 想要配置多个外置mongo地址怎么办？