Skip to content

Commit

Permalink
chore: smart包部署配置调整
Browse files Browse the repository at this point in the history
  • Loading branch information
@wcy00000000000000
wcy00000000000000 committed May 23, 2024
1 parent dfcb1d0 commit b02d9e9
Show file tree
Hide file tree
Showing 7 changed files with 83 additions and 52 deletions.
5 changes: 2 additions & 3 deletions docs/smart/web/app_desc.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ spec_version: 3
app_version: "0.0.1"
app:
region: "default"
bkAppCode: "bk-cmdb"
bkAppName: "bk-cmdb"
bkAppCode: "bk_cmdb"
bkAppName: "bk_cmdb"
market:
introduction: "蓝鲸配置平台"
description: "蓝鲸配置平台"
Expand All @@ -13,7 +13,6 @@ app:
modules:
- name: "web"
isDefault: true
sourceDir: "bk-cmdb"
language: "Go"
spec:
processes:
Expand Down
5 changes: 5 additions & 0 deletions docs/smart/web/extra-data/bin/post-compile
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/bin/bash
mv ./bin/web_server ./bin/cmdb_webserver
rm -rf ./bin/go-pre-compile
rm -rf ./bin/post-compile
mkdir ./logs
2 changes: 1 addition & 1 deletion docs/smart/web/extra-data/bin/start-web.sh
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#! env bash
cat /app/configure/web.yaml.tmpl | /app/bin/envsutsb > /app/configure/web.yaml

web_server --logtostderr=false --v=3 --config=/app/configure/web.yaml --log-dir=/data/cmdb/cmdb_webserver/logs --addrport=0.0.0.0:80 --deployment-method=blueking
cmdb_webserver --logtostderr=false --v=3 --config=/app/configure/web.yaml --log-dir=/app/logs --addrport=0.0.0.0:80 --deployment-method=blueking
82 changes: 41 additions & 41 deletions docs/smart/web/extra-data/configure/readme.md
View file
Original file line number Diff line number Diff line change
@@ -1,42 +1,42 @@
### 变量说明
| 变量名称 | 变量含义 | 可直接设置成的变量值 |
|--------------------------|-------------------|-----|
| BK_CMDB_ERRORS_RES | cmdb errors文件的路径 | /app/resources/errors |
| BK_CMDB_LANGUAGE_RES | cmdb language文件的路径 | /app/resources/language |
| BK_CMDB_ES_STATUS | cmdb elasticsearch开启状态 | "off" |
| BK_COMPONENT_API_URL | esb地址 | |
| BK_CMDB_APP_CODE | cmdb app code | |
| BK_CMDB_APP_SECRET | cmdb app secret | |
| BK_CMDB_PUBLIC_URL | 该值表示部署完成后,输入到浏览器中访问的cmdb 网址 |
| BK_PAAS_PUBLIC_ADDR | paas地址 | |
| BK_PAAS_PRIVATE_ADDR | paas后端地址 | |
| BK_CMDB_WEB_RES | 前端文件地址 | /app/src/bin/build/web/ |
| BK_CMDB_AUTH_SCHENE | 权限模式，web页面使用，可选值: internal, iam | iam |
| BK_PASS2_URL | 蓝鲸桌面地址 | |
| BK_PAAS_BK_DOMAIN | 用于配置前端需要的cookie domain地址 | |
| BK_HTTP_SCHEMA | 访问协议 | |
| BK_IAM_APP_CODE | 权限中心app code | |
| BK_CMDB_CHANGELOG_RES | cmdb 版本日志存放路径 | /app/docs/support-file/changelog_user |
| BK_NOTICE_ENABLED | 是否启用消息通知, true或false | |
| BK_API_GATEWAY_BK_CMDB_JTW_ENABLED | 是否通过jwt调用apigw, true或false | true |
| BK_API_GATEWAY_BK_CMDB_JTW_PUBLICKEY | cmdb API GATEWAY网关公钥 | |
| BK_API_GATEWAY_BK_NOTICE_URL | 消息通知中心API GATEWAY网关地址 | |
| BK_API_GATEWAY_CMDB_URL | cmdb API GATEWAY网关地址 | |
| BK_CMDB_MONGODB_HOST | cmdb mongodb地址 | |
| BK_CMDB_MONGODB_PORT | cmdb mongodb端口 | |
| BK_CMDB_MONGODB_USERNAME | cmdb mongodb用户 | |
| BK_CMDB_MONGODB_PASSWORD | cmdb mongodb密码 | |
| BK_CMDB_MONGODB_DATABASE | cmdb mongodb数据库名称 | cmdb |
| BK_CMDB_MONGODB_MAX_OPEN_CONNS | cmdb mongodb最大连接数 | 3000 |
| BK_CMDB_MONGODB_MAX_OPEN_CONNS | cmdb mongodb最大空闲连接数 | 100 |
| BK_CMDB_MONGODB_MECHANISM | cmdb mongodb mechanism | SCRAM-SHA-1 |
| BK_CMDB_MONGODB_RS_NAME | cmdb mongodb rsName | rs0 |
| BK_CMDB_MONGODB_SOCKET_TIMEOUT_SECONDS | cmdb mongodb socket连接的超时时间 | 10 |
| BK_CMDB_REDIS_SENTINEL_HOST | cmdb redis sentinel地址 | |
| BK_CMDB_REDIS_SENTINEL_PORT | cmdb redis sentinel端口 | |
| BK_CMDB_REDIS_PASSWORD | cmdb redis密码 | |
| BK_CMDB_REDIS_SENTINEL_PASSWORD | cmdb redis sentinel密码 | |
| BK_CMDB_REDIS_DATABASE | cmdb redis数据库名称 | "0" |
| BK_CMDB_REDIS_MAX_OPEN_CONNS | cmdb redis最大连接数 | 3000 |
| BK_CMDB_REDIS_MAX_IDLE_CONNS | cmdb redis最大空闲连接数 | 1000 |
| BK_CMDB_REDIS_MASTER_NAME| cmdb redis master 名称 | |
| 变量名称 | 变量含义 | 可直接设置成的变量值 |
|----------------------------------------|---------------------------------|---------------------|
| BK_CMDB_ERRORS_RES | cmdb errors文件的路径 | /app/conf/errors |
| BK_CMDB_LANGUAGE_RES | cmdb language文件的路径 | /app/conf/language |
| BK_CMDB_ES_STATUS | cmdb elasticsearch开启状态 | "off" |
| BK_COMPONENT_API_URL | esb地址 | |
| BK_CMDB_APP_CODE | cmdb app code | |
| BK_CMDB_APP_SECRET | cmdb app secret | |
| BK_CMDB_PUBLIC_URL | 该值表示部署完成后,输入到浏览器中访问的cmdb 网址 |
| BK_PAAS_PUBLIC_ADDR | paas地址 | |
| BK_PAAS_PRIVATE_ADDR | paas后端地址 | |
| BK_CMDB_WEB_RES | 前端文件地址 | /app/web/ |
| BK_CMDB_AUTH_SCHENE | 权限模式，web页面使用，可选值: internal, iam | iam |
| BK_PASS2_URL | 蓝鲸桌面地址 | |
| BK_PAAS_BK_DOMAIN | 用于配置前端需要的cookie domain地址 | |
| BK_HTTP_SCHEMA | 访问协议 | |
| BK_IAM_APP_CODE | 权限中心app code | |
| BK_CMDB_CHANGELOG_RES | cmdb 版本日志存放路径 | /app/changelog_user |
| BK_NOTICE_ENABLED | 是否启用消息通知, true或false | |
| BK_API_GATEWAY_BK_CMDB_JTW_ENABLED | 是否通过jwt调用apigw, true或false | true |
| BK_API_GATEWAY_BK_CMDB_JTW_PUBLICKEY | cmdb API GATEWAY网关公钥 | |
| BK_API_GATEWAY_BK_NOTICE_URL | 消息通知中心API GATEWAY网关地址 | |
| BK_API_GATEWAY_CMDB_URL | cmdb API GATEWAY网关地址 | |
| BK_CMDB_MONGODB_HOST | cmdb mongodb地址 | |
| BK_CMDB_MONGODB_PORT | cmdb mongodb端口 | |
| BK_CMDB_MONGODB_USERNAME | cmdb mongodb用户 | |
| BK_CMDB_MONGODB_PASSWORD | cmdb mongodb密码 | |
| BK_CMDB_MONGODB_DATABASE | cmdb mongodb数据库名称 | cmdb |
| BK_CMDB_MONGODB_MAX_OPEN_CONNS | cmdb mongodb最大连接数 | 3000 |
| BK_CMDB_MONGODB_MAX_IDLE_CONNS | cmdb mongodb最大空闲连接数 | 100 |
| BK_CMDB_MONGODB_MECHANISM | cmdb mongodb mechanism | SCRAM-SHA-1 |
| BK_CMDB_MONGODB_RS_NAME | cmdb mongodb rsName | rs0 |
| BK_CMDB_MONGODB_SOCKET_TIMEOUT_SECONDS | cmdb mongodb socket连接的超时时间 | 10 |
| BK_CMDB_REDIS_SENTINEL_HOST | cmdb redis sentinel地址 | |
| BK_CMDB_REDIS_SENTINEL_PORT | cmdb redis sentinel端口 | |
| BK_CMDB_REDIS_PASSWORD | cmdb redis密码 | |
| BK_CMDB_REDIS_SENTINEL_PASSWORD | cmdb redis sentinel密码 | |
| BK_CMDB_REDIS_DATABASE | cmdb redis数据库名称 | "0" |
| BK_CMDB_REDIS_MAX_OPEN_CONNS | cmdb redis最大连接数 | 3000 |
| BK_CMDB_REDIS_MAX_IDLE_CONNS | cmdb redis最大空闲连接数 | 1000 |
| BK_CMDB_REDIS_MASTER_NAME | cmdb redis master 名称 | |
9 changes: 2 additions & 7 deletions docs/smart/web/extra-data/configure/web.yaml.tmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,9 @@ webServer:
#英文版版本日志存放路径
en: ${BK_CMDB_CHANGELOG_RES}/en
jwt:
enabled: false
enabled: ${BK_API_GATEWAY_BK_CMDB_JTW_ENABLED}
# jwt公钥
publicKey:
publicKey: ${BK_API_GATEWAY_BK_CMDB_JTW_PUBLICKEY}
# jwt私钥
privateKey:
#是否启用消息通知
Expand Down Expand Up @@ -130,11 +130,6 @@ openTelemetry:
bkDataID:
bkDataToken:

apiServer:
jwt:
enabled: ${BK_API_GATEWAY_BK_CMDB_JTW_ENABLED}
publicKey: ${BK_API_GATEWAY_BK_CMDB_JTW_PUBLICKEY}

# 调用apigw接口相关配置
apiGW:
bkNoticeApiGatewayUrl: ${BK_API_GATEWAY_BK_NOTICE_URL}
Expand Down
Binary file added docs/smart/web/logo.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 32 additions & 0 deletions docs/smart/web/readme.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
S-Mart包构建
===========

## 目录结构

构建前需要将CMDB的代码目录调整为如下目录结构：

```
. CMDB代码根目录
├── app_desc.yaml S-Mart包配置
├── logo.png CMDB的logo
├── bin extra-data目录中的bin目录
│ ├── envsubst 用于将环境变量渲染到SaaS的配置文件中
│ ├── go-pre-compile S-Mart包编译前的前置处理脚本
│ ├── post-compile S-Mart包编译后的后置处理脚本
│ └── start-web.sh SaaS启动脚本
├── configure extra-data目录中的configure目录
│ ├── readme.md 配置文件变量说明
│ └── web.yaml.tmpl 配置文件模板
├── web 编译好的前端包
├── conf 对应cmdb的resources目录
│ ├── errors 错误码配置
│ └── language 国际化配置
├── changelog_user 版本日志目录，对应cmdb的docs/support-file/changelog_user目录
├── src CMDB的代码目录
│ ├── web_server web_server的代码目录，S-Mart包构建时会使用该目录进行编译，编译好的二进制会放到bin目录中
...
```

## 构建方式

使用`蓝鲸S-Mart源码包构建工具`蓝盾流水线插件指定源码路径为CMDB代码根目录进行构建

0 comments on commit b02d9e9

Please sign in to comment.