From 37780a0516eb2587ca10c6e9c22e681617520e65 Mon Sep 17 00:00:00 2001 From: tscuite Date: Wed, 6 Sep 2023 16:15:51 +0800 Subject: [PATCH] feat: add docker --- .github/workflows/release.yaml | 49 +++++++++ docs/getting-started/start-shangye.md | 137 ++++++++++++++++++++++++++ docusaurus.config.js | 2 +- sidebars.js | 5 +- 4 files changed, 190 insertions(+), 3 deletions(-) create mode 100644 docs/getting-started/start-shangye.md diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index e1d55da..c147859 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -29,3 +29,52 @@ jobs: mkdir -p ~/.ssh/ && echo "$KEY" > ~/.ssh/id_rsa && chmod 600 ~/.ssh/id_rsa ssh-keyscan github.com >> ~/.ssh/known_hosts scp -o StrictHostKeyChecking=no -r ./build/* ${{ secrets.DEPLOY_HOST }} + + Release-DongTai-Infra-Service: + runs-on: ubuntu-latest + strategy: + matrix: + node-version: ['16.x'] + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set up QEMU + uses: docker/setup-qemu-action@v2 + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v2 + - name: Login to DockerHub + uses: docker/login-action@v2 + with: + username: ${{ secrets.DONGTAI_DOCKERHUB_USERNAME }} + password: ${{ secrets.DONGTAI_DOCKERHUB_TOKEN }} + + - name: Login to Aliyun Registry + uses: docker/login-action@v2 + with: + registry: ${{ secrets.ALIYUN_REGISTRY }} + username: ${{ secrets.ALIYUN_DOCKERHUB_USER }} + password: ${{ secrets.ALIYUN_DOCKERHUB_PASSWORD }} + + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v2.1.2 + with: + node-version: ${{ matrix.node-version }} + - name: build + run: | + sed -i "s#custom.css#custom1.css#g" docusaurus.config.js + yarn + yarn build + + - name: Build and push + uses: docker/build-push-action@v3 + with: + context: . + platforms: linux/amd64,linux/arm64 + push: true + tags: | + dongtai/dongtai-doc-v5:latest + dongtai/dongtai-doc-v5:0.0.${{github.run_number}} + registry.cn-hongkong.aliyuncs.com/secnium/dongtai-doc:latest + registry.cn-hongkong.aliyuncs.com/secnium/dongtai-doc:max-develop-latest + registry.cn-hongkong.aliyuncs.com/secnium/dongtai-doc:max-beta-latest + registry.cn-hongkong.aliyuncs.com/secnium/dongtai-doc:max-main-latest diff --git a/docs/getting-started/start-shangye.md b/docs/getting-started/start-shangye.md new file mode 100644 index 0000000..8772ee9 --- /dev/null +++ b/docs/getting-started/start-shangye.md @@ -0,0 +1,137 @@ +# 商业版部署文档 + +### 一、iast部署使用（1.14.0+） +:::info 使用 iastctl 安装优点： + - redis密码变更为随机密码. + - security_secret_key 变更为随机数. + - 启动时会自动生成xray等转换器token. +1. 执行用户需要有sudo权限。 +2. 低于1.13.0版本使用会有不兼容问题，需要手动升级至1.13.0，推荐新用户部署使用。 +3. 旧用户单节点部署的用户只支持使用 docker-compose -p dongtai 部署的用户。 +4. 旧用户三节点部署的用户只支持指定vm1,vm2,vm3做项目名的用户使用。 + - docker-compose -p vm1 (server节点) + - docker-compose -p vm2 (mysql节点) + - docker-compose -p vm3 (检测节点) +5. 旧用户升级使用需要先使用 ./iastctl iast apply 配置，再执行 ./iastctl iast upgrade 更新。 +6. 进入iast安装包执行如下命令安装。 +::: + +##### 1. 一键安装 +``` +(解压后，进入安装包目录执行) + ./iastctl iast apply +``` + +##### 2. 使用 iastctl iast apply 时的配置 + +###### 单节点配置 +``` +? 请输入您要使用的网段 (默认 172.31.200.0/24): 不变更网段直接回车使用默认即可 +? 请输入您要使用的域名 (默认 http://127.0.0.1:8000): （分享链接域名） +? 请输入您的sca地址 (默认 https://sca.huoxian.cn/): （填写sca域名） +? 请输入您的sca_token (不使用sca检测留空): （sca_token ,不使用云端sca直接回车） +? 请输入您的scale数量 (默认1) : 2 （server部署数量，扩容数） +``` + +###### 三节点额外配置 +``` +? 请输入第2台服务器的ip (用于部署mysql, redis): 输入服务器内网IP +? 请输入ssh端口号(默认 22): （直接回车使用默认） +? 请输入用户名(默认 root): （直接回车使用默认） +? 请输入密码 (密钥留空即可): （直接回车使用默认） +? 请输入第3台服务器的ip (用于部署检测组件): 输入服务器内网IP +? 请输入ssh端口号 (默认 22): （直接回车使用默认） +? 请输入用户名 (默认 root): （直接回车使用默认） +? 请输入密码 (密钥留空即可): （直接回车使用默认） +``` +更新完成后会自动生成DAST转换器token + +##### 3. 更新配置信息 +``` + //重新配置apply时输入的配置（不会执行导入镜像） + ./iastctl iast config +``` + + +##### 4. 启动iast服务 +``` + ./iastctl iast start + ``` + +##### 5. 停止iast服务 +``` + ./iastctl iast stop +``` + +##### 5. 更新iast服务 +``` + //更新iast（低于1.13.0版本使用会有不兼容问题，需要手动升级至1.13.0） + ./iastctl iast upgrade +``` + + + +### 二、sca部署使用（2.0.5+） + +:::info sca 部署： +(解压后，进入安装包目录执行) +::: + +##### 部署 +``` +./iastctl sca apply +``` +更新 +``` +./iastctl sca upgrade +``` +启动 +``` +./iastctl sca start +``` +停止 +``` +./iastctl sca stop +``` + + +### 三、attach使用 [ beta ] + +##### 插桩本机docker中的java服务 +``` +./iastctl attach docker +``` + +##### 插桩本机中的java服务 +``` +./iastctl attach localhost +``` + + +### 四、使用日志监控 ERROR 日志 +``` +1.需要先修改logstash把发送到es中才可以监控. +2.可先参考飞书文档 agent日志推送es 配置logstash, 后续会加入 iastctl 自动部署 +3.在配置文件中填写自部署的es配置, 以及要监控的索引, 然后配置飞书机器人接收 +``` + +在当前目录创建配置文件 config.yaml +``` +cat < config.yaml +elasticsearch: + useEs7: true #开启检测 + hosts: ["http://127.0.0.1:9200"] #es地址 + index: "iast_index_*" #要检测的索引 + +webhook: + minute: 1 # 检测间隔时间 + size: 5 # 每次检测查询数据量条数 + # 要发送的飞书地址 + feishu: https://open.feishu.cn/open-apis/bot/v2/hook/xxxxxxxxxxxxxxxxxxxxxxxxxxxx +EOF +``` + +运行任务 +``` +./iastctl run monitor +``` \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 322cfde..2084709 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -42,7 +42,7 @@ const config = { includeCurrentVersion: true, }, theme: { - customCss: require.resolve('./src/css/custom.css'), + customCss: require.resolve('./src/css/custom1.css'), }, }), ], diff --git a/sidebars.js b/sidebars.js index 73d7f31..45b9bf5 100644 --- a/sidebars.js +++ b/sidebars.js @@ -83,8 +83,9 @@ const sidebars = { }, ], }, - 'getting-started/start-xjpc', - ], + 'getting-started/start-xjpc', + 'getting-started/start-shangye', + ], }, { type: 'category',