Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

优化helm部署cmdb文档 #8241

Open
wants to merge 1 commit into
base: v3.14.x
Choose a base branch
from
Open

优化helm部署cmdb文档 #8241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 3 additions & 11 deletions docs/overview/source_compile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## 编译环境

- golang >= 1.17
- golang >= 1.20

- python >= 2.7.5

Expand Down Expand Up @@ -129,20 +129,12 @@ make package

### Docker 镜像制作

解压cmdb.tar.gz，进入cmdb目录执行以下命令：
执行打包后进入归档包存放位置，解压cmdb.tar.gz，进入cmdb目录执行以下命令：

``` shell
./image.sh -i <base_image>
./image.sh
```

**示例：**

```shell
./image.sh -i linux:latest
```

**注：-i 参数后面配置的参数是基础镜像，基础镜像可以自己制作，也可以使用公共镜像。**

## 编译问题及解决

### 源码下载问题
Expand Down
22 changes: 1 addition & 21 deletions docs/support-file/dockerfile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,4 @@
# BK-CMDB

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

本文档内容为如何根据提供的dockerfile制作cmdb镜像。

### 操作步骤
#### 对于cmdb各个服务。这里以adminserver为例：
（1）在adminserver目录里创建cmdb_adminserver目录
```
mkdir dockerfile/adminserver/cmdb_adminserver
```
（2）将adminserver的二进制拷贝到上述的cmdb_adminserver目录中

（3）在上述cmdb_adminserver目录创建conf目录，将errors,language
```
mkdir dockerfile/adminserver/cmdb_adminserver/conf
cp -r cmdb/{errors,language} dockerfile/adminserver/cmdb_adminserver/conf
```

（4）执行docker build构建镜像

注：其中webserver比较特殊，还需要将web目录以及docs/support-file/changelog_user目录拷贝到cmdb_webserver下，即与conf和二进制同级的目录下
蓝鲸配置平台（蓝鲸CMDB）镜像构建方式请参考[CMDB 编译指南](../../overview/source_compile.md)

82 changes: 36 additions & 46 deletions docs/support-file/helm/backend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@


# BK-CMDB
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

现在cmdb后台和webserver是两个chart，这两个chart如何联动起来，两者之间的关联是什么，部署的顺序流程，需要有对应的操作文档，然后再分别和自己的chart部署文档关联；之前主页那个「极速体验容器化部署蓝鲸CMDB」入口现在没改，应该就是跳到这里说的文档

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

好的我再优化下


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

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

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

Expand All @@ -21,32 +19,37 @@
- Kubernetes 1.12+
- Helm 3+

快速部署k8s集群可参考：[蓝鲸官方白皮书](https://bk.tencent.com/docs/markdown/ZH/DeploymentGuides/7.1/get-k8s-create-bcssh.md)

### 镜像制作

制作cmdb镜像请参考：[CMDB 编译指南](../../../overview/source_compile.md)

### 安装Chart

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

```shell
# 添加helm仓库
$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm repo add bkee <bkcmdb helm repo url>
$ helm install bkcmdb bkee/bkcmdb --set mongodb.auth.password=${password} --set redis.auth.password=${password}
# 更新并拉取依赖
$ helm dependency update
# 执行部署
$ helm install cmdb-backend bkee/cmdb-backend --set mongodb.auth.password=${password} --set redis.auth.password=${password}
```

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



上述命令将使用默认配置在Kubernetes集群中部署BK-CMDB 后台服务
注：执行部署前请检查values.yaml镜像配置中的镜像地址
### 卸载Chart

使用以下命令卸载`bkcmdb`:
使用以下命令卸载`cmdb-backend`:

```shell
$ helm uninstall bkcmdb
$ helm uninstall cmdb-backend
```

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


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

## Chart依赖

Expand All @@ -63,29 +66,35 @@ $ helm uninstall bkcmdb

| 参数 | 描述 | 默认值 |
| :-------------: | :----------: | :----------: |
| image.registry | 镜像源域名 | mirrors.tencent.com |
| image.registry | 镜像源域名 | hub.bktencent.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 |
| 参数 | 描述 | 默认值 |
|:------------------------:|:----------------------:|:----------:|
| migrate.enabled | 是否在执行helm时启动该job | true |
| migrate.image.repository | 初始化job所需要的镜像仓库地址 | migrate |
| migrate.image.tag | 初始化job所需要的镜像版本 | {TAG_NAME} |
| migrate.migrateDataId | 是否在启动时往GSE注册dataid | false |
| migrate.migrateOldDataId | 是否在启动时往GSE注册旧版本dataid | false |
| migrate.dataid.migrateWay | 通过何种方式调用gse接口注册dataid,可选值esb和apigw | esb |

### 蓝鲸产品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 |
| 参数 | 描述 | 默认值 |
| :------: |:-----------:|:----------------------------------------:|
| 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 |
| bkApigatewayName | 蓝鲸网关cmdb组件名 | bk-cmdb |
| bkGseApiGatewayUrl | 蓝鲸 GSE API Gateway url | http://bkapi.example.com |
| bkNoticeApiGatewayUrl | 蓝鲸 Notice API Gateway url | http://bkapi.example.com |
| bkCmdbApiGatewayUrl | CMDB API Gateway url | http://bkapi.example.com |

### adminserver服务配置说明

Expand Down Expand Up @@ -289,25 +298,6 @@ $ helm uninstall bkcmdb
| 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 |

### 服务开启鉴权开关

| 参数 | 描述 | 默认值 |
Expand Down
Loading