Skip to content

Latest commit

 

History

History
164 lines (119 loc) · 5.71 KB

dev_deploy.md

File metadata and controls

164 lines (119 loc) · 5.71 KB
Raw

开发环境后台部署

部署蓝鲸社区版

标准运维 SaaS 的登录鉴权依赖于蓝鲸智云PaaS平台，业务信息需要从蓝鲸智云配置平台提供的接口获取，所以你需要部署蓝鲸PaaS平台和蓝鲸配置平台，作为开发联调环境。

1）如果你只需要定制开发标准运维，不需要改动蓝鲸PaaS和蓝鲸配置平台的源码，建议你直接从官方下载蓝鲸智云社区版完整包进行。

2）如果你希望使用蓝鲸所有开源产品，进行定制开发，你可以部署开源的蓝鲸智云PaaS平台和蓝鲸智云配置平台。

部署方法请参考各个开源产品的相关文档，在蓝鲸智云PaaS平台部署完成后，你还需要上传部署标准运维SaaS并开通应用免登录态验证白名单。 你可以点击这里下载标准运维Release版本，然后前往蓝鲸PaaS平台的"开发者中心"->"S-mart应用"上传部署新应用。 你可以参考蓝鲸PaaS平台的"开发者中心"->"API网关"->"使用指南"->"API调用说明"页面中"用户认证"文档，添加默认标准运维APP_ID即bk_sops到应用免登录态验证白名单。

准备本地 rabbitmq 资源

在本地安装 rabbitmq，并启动 rabbitmq-server，服务监听的端口保持默认（5672）。

准备本地 redis 资源

在本地安装 redis，并启动 redis-server，服务监听的端口保持默认（6379）。

准备本地 mysql

在本地安装 mysql，并启动 mysql-server，服务监听的端口保持默认（3306）。

安装 python 和包

在本地安装 python2.7 和 pip，目前暂不支持 py3，后续版本会兼容 py2 和 py3。 通过 git 拉取源代码到工程目录后，并进入目录下运行 pip 命令安装 python 包。

pip install -r requirements.txt

部分 python 包需要安装依赖软件，如 libmagic，macOS 可以使用如下命令安装：

brew install libmagic

配置本地环境变量和数据库

  1. 设置环境变量
    设置环境变量的目的是让项目运行时能正确获取以下变量的值： BK_PAAS_HOST、BK_CC_HOST、BK_JOB_HOST 分别改为你部署的蓝鲸PaaS平台域名、配置平台域名、作业平台域名（需要加上 http 前缀；如果是 https 域名，请改为 https 前缀）。 APP_ID 设置为你的社区版标准运维应用ID，默认设置为 bk_sops。APP_TOKEN 设置为你的社区版标准运维应用 TOKEN，默认可以访问 http://{BK_PAAS_HOST}/admin/app/app/，找到名为"标准运维"的应用，查看详情获取 Token 字段值。

有三种方式设置本地开发需要的环境变量，一是手动设置，即执行如下命令

export APP_ID="bk_sops"
export APP_TOKEN="{APP_TOKEN}"
export BK_PAAS_HOST="{BK_PAAS_HOST}"
export BK_CC_HOST="{BK_CC_HOST}"
export BK_JOB_HOST="{BK_JOB_HOST}"

二是直接修改 scripts/develop/sites/community/env.sh，然后执行

source scripts/develop/sites/community/env.sh

第三种方式，你可以直接修改项目的 settings 配置，先修改 config/__init__.py ，设置项目的基础信息

APP_ID = 'bk_sops'
APP_TOKEN = '{APP_TOKEN}'
BK_PAAS_HOST = '{BK_PAAS_HOST}'

然后修改 config/dev.py ，追加配置平台域名、作业平台域名配置

BK_CC_HOST = '{BK_CC_HOST}'
BK_JOB_HOST = '{BK_JOB_HOST}'
  1. 修改 config/dev.py，设置本地开发用的数据库信息，添加 Redis 本地信息
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',  # 默认用mysql
        'NAME': APP_ID,       # 数据库名 (默认与APP_ID相同)
        'USER': 'root',       # 你的数据库user
        'PASSWORD': '',       # 你的数据库password
        'HOST': 'localhost',  # 数据库HOST
        'PORT': '3306',       # 默认3306
    },
}

REDIS = {
    'host': 'localhost',
    'port': 6379,
}

创建并初始化数据库

  1. 在 mysql 中创建名为 bk_sops 的数据库
CREATE DATABASE `bk_sops` DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
  1. 在工程目录下执行以下命令初始化数据库
python manage.py migrate
python manage.py createcachetable django_cache

打包并收集前端静态资源

1）安装依赖包
进入 frontend/desktop/，执行以下命令安装

npm install

2）本地打包 在 frontend/desktop/ 目录下，继续执行以下命令打包前端静态资源

npm run build -- --STATIC_ENV=dev [--VERSION={STATIC_VERSION}]

其中 VERSION 是可选参数，建议正式打包加上该参数，{STATIC_VERSION} 是 config/default.py 中的 STATIC_VERSION 值。

3）收集静态资源 回到项目根目录，执行以下命令收集前端静态资源到 static 目录下

python manage.py collectstatic --noinput

前端资源文件需要单独拷贝收集，执行如下命令

rm -rf static/dev static/images
mv frontend/desktop/static/dev static/
mv frontend/desktop/static/images static/

配置本地 hosts

windows: 在 C:\Windows\System32\drivers\etc\host 文件中添加“127.0.0.1 dev.{BK_PAAS_HOST}”。
mac: 执行 “sudo vim /etc/hosts”，添加“127.0.0.1 dev.{BK_PAAS_HOST}”。

启动进程

python manage.py celery worker -l info
python manage.py celery beat -l info
python manage.py runserver 8000

访问页面

使用浏览器开发 http://dev.{BK_PAAS_HOST}:8000/ 访问应用。