tencent / bk-sops

蓝鲸智云标准运维(SOPS)

(English Documents Available)

标准运维（SOPS）是通过可视化的图形界面进行任务流程编排和执行的系统，是腾讯蓝鲸产品体系中一款轻量级的调度编排类SaaS产品。

标准运维有两大核心服务。一个是流程编排服务：基于腾讯蓝鲸PaaS平台的API网关服务，对接企业内部各个系统 API的能力， 将在多系统间切换的工作模式整合到一个流程中，实现一键自动化调度。另一个是自助化服务：标准运维屏蔽了底层系统之间的差异， 让运维人员可以将业务日常的运维工作交给产品、开发、测试等人员执行，实现业务发布、变更等日常工作的自助化，除此之外，为降低非运维人员的操作成本， 标准运维与蓝鲸PaaS平台深度整合，为用户提供了“轻应用”和“职能化”功能，提高自助率。

标准运维后台使用 Python 作为开发语言，使用 Django 开发框架；前端使用 Vue 开发页面，使用 jQuery 开发标准插件，通过配置式的开发模式， 不断降低用户开发标准插件前端表单的难度。

底层流程引擎 SDK：bamboo-engine

Overview

• 架构设计
• 代码目录
• 使用场景

Features

• 多元接入支持：标准运维对接了蓝鲸通知、作业平台、配置平台等服务，作为官方标准插件库提供服务，还支持用户自定义接入企业内部系统，定制开发标准插件。
• 可视化流程编排：通过拖拽方式组合标准插件节点到一个流程模板。
• 多种流程模式：支持标准插件节点的串行、并行，支持子流程，可以根据全局参数自动选择分支执行，节点失败处理机制可配置。
• 参数引擎：支持参数共享，支持参数替换。
• 可交互的任务执行：任务执行中可以随时暂停、继续、撤销，节点失败后可以重试、跳过。
• 通用权限管理：通过配置平台同步业务角色，支持流程模板的使用权限控制。

了解更多功能，请参考标准运维白皮书

Getting started

• 开发环境后台部署
• 开发环境前端部署
• 正式环境源码部署
• 正式环境上传部署
• 移动端部署
• 标准插件开发
• 标准插件开发最佳实践
• 标准运维开发者工具包

Usage

• API使用说明
• 标准插件说明
• 标准插件远程加载
• 变量引擎
• Tag使用和开发说明
• 移动端使用说明
• redis 部署模式支持
• 版本升级注意事项
• 故障排查手册

Releases

• 已发布版本

BlueKing Community

• BK-CMDB：蓝鲸配置平台（蓝鲸 CMDB）是一个面向资产及应用的企业级配置管理平台。
• BK-CI：蓝鲸持续集成平台是一个开源的持续集成和持续交付系统，可以轻松将你的研发流程呈现到你面前。
• BK-BCS：蓝鲸容器管理平台是以容器技术为基础，为微服务业务提供编排管理的基础服务平台。
• BK-PaaS：蓝鲸 PaaS 平台是一个开放式的开发平台，让开发者可以方便快捷地创建、开发、部署和管理 SaaS 应用。
• BK-SOPS：标准运维（SOPS）是通过可视化的图形界面进行任务流程编排和执行的系统，是蓝鲸体系中一款轻量级的调度编排类 SaaS 产品。
• BK-JOB：蓝鲸作业平台(Job)是一套运维脚本管理系统，具备海量任务并发处理能力。

Support

• 源码
• wiki
• 白皮书
• 蓝鲸论坛
• 蓝鲸 DevOps 在线视频教程
• 联系我们，加入腾讯蓝鲸运维开发交流群：878501914

Contributing

如果你有好的意见或建议，欢迎给我们提 Issues 或 Pull Requests，为蓝鲸开源社区贡献力量。关于标准运维分支管理、Issue 以及 PR 规范， 请阅读 Contributing Guide。

腾讯开源激励计划 鼓励开发者的参与和贡献，期待你的加入。

FAQ

FAQ

License

标准运维是基于 MIT 协议， 详细请参考 LICENSE 。

我们承诺未来不会更改适用于交付给任何人的当前项目版本的开源许可证（MIT 协议）。

bk-sops's Issues

部分python文件头部coding: utf-8格式不统一

问题描述

• 部分文件头部多一行 # -- coding=utf-8 -、# coding=utf-8、# -- coding:utf-8 --，如 blueapps/account/components/bk_token/models.py

重要提醒: 请优先尝试部署使用最新发布的版本 (发布清单： https://github.com/Tencent/bk-sops/releases), 如果问题不能在最新发布的版本里重现，说明此问题已经被修复。

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

webpack 配置图片引用路径错误，导致图片加载失败

问题描述

webpack 配置图片引用路径错误，导致图片加载失败。

重现方法

访问不存在的 url，页面会跳转到 404 页面，404 页面的图片加载失败。

重要提醒: 请优先尝试部署使用最新发布的版本 (发布清单： https://github.com/Tencent/bk-sops/releases), 如果问题不能在最新发布的版本里重现，说明此问题已经被修复。

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

pipeline_plugins.tests.components.utils.sites.open在运行单元测试时未生效

问题描述

pipeline_plugins.tests.components.utils.sites.open在运行单元测试时未生效

重现方法

<列出如何重现的方法或操作步骤>

重要提醒: 请优先尝试部署使用最新发布的版本 (发布清单： https://github.com/Tencent/bk-sops/releases), 如果问题不能在最新发布的版本里重现，说明此问题已经被修复。

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

子流程更新时保留当前输入参数值

问题描述

流程模版编辑时，所引用的子流程节点有更新时，点击更新需要保留用户当前编辑输入参数表单的值。

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

Tag 文件名称命名规则统一为驼峰

问题描述

Tag 文件名称命名规则统一为驼峰

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

添加节点回调 API

问题描述

目前提供的 API 中没有节点回调的 API

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本: 3.3.9

数据统计页面拉取所有业务

问题描述

数据统计页面拉取所有业务

关键信息

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

V3.3.10 release日志不能包含 API 更新

问题描述

V3.3.10 release日志不能包含 API 更新，放到下个大版本实现

重现方法

关键信息

请提供以下信息:

• bk-sops 版本 (发布版本号 或 git tag)： V3.3.10

【远程包源及包管理模块】删除本地配置中的包源配置时数据库中的配置未删除

问题描述

【远程包源及包管理模块】删除本地配置中的包源配置时数据库中的配置未删除

关键信息

请提供以下信息:

• bk-sops 版本： 3.3.11

【远程包源及包管理模块】- 包源及包配置

问题描述

【远程包源及包管理模块】- 包源及包配置

关键信息

请提供以下信息:

• bk-sops 版本：3.3.11

We found potential security vulnerabilities in your dependencies.

问题描述

We found potential security vulnerabilities in your dependencies.
requests 需要升级

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.1.32-ce

公共流程和业务流程数据展示的问题

问题描述

公共流程和业务流程页面多次快速切换时，在接口数据返回时间较长的情况下，展示的列表数据会出现不对应的情况，比如在业务流程页面展示的是公共流程的数据。

关键信息

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

轻应用页面重构

问题描述

• 轻应用可以查看流程权限配置
• 轻应用可以查看更新人和更新时间
• 轻应用可以在编辑时跳转到对应的流程模板

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.X

代码结构优化，bk_api没必要单独作为一个模块

问题描述

• bk_api 没必要单独作为一个 app，可以移到 gcloud 内部

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

本地开发local_settings模板文件优化

问题描述

本地开发local_settings模板文件优化，需要添加 redis 配置

重现方法

<列出如何重现的方法或操作步骤>

重要提醒: 请优先尝试部署使用最新发布的版本 (发布清单： https://github.com/Tencent/bk-sops/releases), 如果问题不能在最新发布的版本里重现，说明此问题已经被修复。

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

职能化认领页面点击认领按钮页面会整体刷新

问题描述

在职能化认领页面，点击认领任务按钮，跳转到任务执行页面时，整站会整体刷新一次。

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

标准插件Tag表单新增 changeHook 方法

问题描述

任务节点在编辑输入参数时，当参数勾选为全局变量后，在标准插件配置项定义的事件回调里，支持调用 changeHook 方法来去掉对应表单的勾选状态。

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

添加【节点回调】及【修改周期策略】API DOC

问题描述

添加【节点回调】及【修改周期策略】API DOC

关键信息

• bk-sops 版本： 3.3.11

自定义全局变量列表和配置项从接口获取

问题描述

• 自定义全局变量的列表由接口获取
• 对应变量的配置项由后台接口获取

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

【远程包源及包管理模块】- 启动时加载远程模块

问题描述

【远程包源及包管理模块】- 启动时加载远程模块

关键信息

请提供以下信息:

• bk-sops 版本：3.3.11

issue tip test

问题描述

<这里写问题描述>

重现方法

<列出如何重现的方法或操作步骤>

重要提醒: 请优先尝试部署使用最新发布的版本 (发布清单： https://github.com/Tencent/bk-sops/releases), 如果问题不能在最新发布的版本里重现，说明此问题已经被修复。

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): <示例： V3.1.32-ce 或者 git sha. 请不要使用 "最新版本" 或 "当前版本"等无法准确定位代码版本的语句描述>
• 蓝鲸PaaS 版本: <示例：PaaS 3.0.58、PaaSAgent 3.0.9>
• bk_sops 异常日志

django工程的静态资源最好能提前收集到 static 目录

问题描述

django工程的静态资源最好能提前收集到 static 目录，通过自动化 CI 执行 collecstatic 依赖 mysql、python 等环境，成本较高

重现方法

python manage.py collectstatic --noinput

重要提醒: 请优先尝试部署使用最新发布的版本 (发布清单： https://github.com/Tencent/bk-sops/releases), 如果问题不能在最新发布的版本里重现，说明此问题已经被修复。

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops V3.3.8

节点执行耗时在超过一天时不准确

问题描述

节点执行耗时超过 1 天时，后台返回的耗时总秒数不正确。

重现方法

执行一个耗时超过 1 天的计时节点

关键信息

• bk_sops 版本: 3.3.9

任务节点执行失败后，展开重试面板，点击重试按钮只能执行一次操作

问题描述

任务节点执行失败后，展开重试面板，点击重试按钮再次失败后，重试按钮的点击事件不会触发任务的重试接口调用。

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

ip选择器样式优化、云区域名称字段替换

问题描述

• ip选择器组件搜索框、静态ip操作项下拉框的样式优化
• 云区域名称的字段替换

重要提醒: 请优先尝试部署使用最新发布的版本 (发布清单： https://github.com/Tencent/bk-sops/releases), 如果问题不能在最新发布的版本里重现，说明此问题已经被修复。

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

优化gcloud.apigw模块是否加载bkoauth的逻辑，通过sites配置实现

问题描述

优化gcloud.apigw模块是否加载bkoauth的逻辑，通过sites配置实现

重现方法

<列出如何重现的方法或操作步骤>

重要提醒: 请优先尝试部署使用最新发布的版本 (发布清单： https://github.com/Tencent/bk-sops/releases), 如果问题不能在最新发布的版本里重现，说明此问题已经被修复。

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.X

流程状态获取接口 API 返回的节点名与实际节点名不符

问题描述

流程状态获取接口 API 返回的节点名与实际节点名不符

关键信息

• bk_sops 版本: 3.3.9

JOB-执行作业查看IP日志详情未展示所有状态的IP日志

问题描述

JOB-执行作业查看IP日志详情未展示所有状态的IP日志

关键信息

请提供以下信息:

• bk_sops 版本: 3.3.9

代码优化，template/get_business_basic_info/{biz_cc_id}/ 接口迁移到 core/api/get_basic_info

问题描述

• 代码优化，template/get_business_basic_info/{biz_cc_id}/ 接口迁移到 core/api/get_basic_info
• 需要等前端迁移后，后台删除 template/get_business_basic_info/{biz_cc_id}/ 接口

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

【远程包源及包管理模块】非标准代码导入器

问题描述

提供一个能够从外部（如文件系统，网络，zip 包等）导入模块的导入器基类，并允许开发者继承该基类进行功能扩展。

关键信息

请提供以下信息:

• bk_sops 版本: 3.3.9

获取节点详情及创建任务 API 返回任务树及任务链接

问题描述

获取节点详情及创建任务 API 需要返回任务树及任务链接

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本: 3.3.9

【远程包源及包管理模块】- 模块版本管理模型

问题描述

【远程包源及包管理模块】- 模块版本管理模型

关键信息

请提供以下信息:

• bk-sops 版本：3.3.11

页面体验优化，本地缓存表格、输入参数tooltip层级、任务执行修改参数loading时机修改

问题描述

前端页面体验优化：

• 本地缓存表格实现方式改为 table 元素
• 输入参数 tooltip z-index 层级调整为 TagSelect loading 层级
• 任务执行参数 loading 状态取消，需要等待所有参数加载完毕

重要提醒: 请优先尝试部署使用最新发布的版本 (发布清单： https://github.com/Tencent/bk-sops/releases), 如果问题不能在最新发布的版本里重现，说明此问题已经被修复。

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

自定义全局变量input、textarea等全部改为后台实现，和前端解耦

问题描述

• 自定义全局变量input、textarea等全部改为后台实现
• 自定义全局变量和标准插件一样，支持用户开发扩展
• 自定义全局变量从 VariableLibary获取，支持远程加载

重现方法

关键信息

请提供以下信息:

• bk-sops 版本 (发布版本号 或 git tag)： V3.3.10

页面体验样式问题优化

问题描述

• 弹窗提交取消按钮里面文字没有纵向居中对齐
• 下拉框下拉图标没有纵向居中对齐
• 原子节点个数跟模板名称居中对齐
• 展开收起过渡动画不太理想
• 全局变量删除 icon 和页面其他删除 icon 不统一
• 导入模板数据时表格未对齐
• 模版列表页操作按钮错误设置为右对齐
• 输入参数表格样式错位
• 流程模版列表、任务列表、审计列表、职能化列表、轻应用列表最左侧一列左边距太小

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

readme 未显示单元测试和测试覆盖率 badge

问题描述

未显示单元测试和测试覆盖率 badge

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag):
  3.3.8

流程模版编辑增加新建任务按钮

问题描述

流程模版编辑增加新建任务按钮

关键信息

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

轻应用页面增加高级搜索功能

问题描述

轻应用页面增加高级搜索功能

关键信息

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

部署文档source_code_deploy和目前的代码目录不匹配

问题描述

部署文档source_code_deploy和目前的代码目录不匹配，如修改代码的 conf/settings_testing.py 和 conf/settings_production.py

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

docs中本地部署文档中收集前端静态资源部分未生效

问题描述

如题，按照本地部署文档中执行python manage.py collectstatic --noinput，前端npm打包后的静态资源未被复制到 static 目录下，需要手动复制

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

部分版本webpack无法动态导入vue组件

问题描述

更新 webpack 版本到4.29.0及以上版本后，代码构建失败。

错误：

ERROR in ./src/routers/index.js 35:11
Module parse failed: Unexpected token (35:11)
You may need an appropriate loader to handle this file type.
| */
| var NotFoundComponent = function NotFoundComponent() {
>     return import('@/components/layout/NotFoundComponent.vue');
| };
|
 @ ./src/main.js 189:13-42

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

JOB 执行作业插件不填 IP 参数为空时使用 JOB 侧配置的默认值

问题描述

JOB 执行作业插件不填 IP 参数为空时使用 JOB 侧配置的默认值

关键信息

• bk_sops 版本: 3.3.9

前端打包报错，提示 analysis/instance/index.vue 文件不存在

问题描述

前端打包执行 npm run build:dev 报错文件不存在

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本： V3.1.32-ce

任务执行节点树查看按照广度优先排序

问题描述

任务执行页面查看参数，节点树的排序需要按照广度优先排序。

关键信息

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

使用流程模板新建任务时，需要查看未引用的全局变量

问题描述

• 使用流程模板新建任务时，需要查看未引用的全局变量

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.X

全局变量配置项未加载完成不允许保存

问题描述

全局变量编辑或者新建时，配置项没有加载完成，禁用掉保存按钮。

关键信息

重要提醒: 这些关键信息会辅助我们快速定位问题。

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

职能化中心列表、审计中心列表增加高级搜索功能

问题描述

职能化中心列表、审计中心列表增加高级搜索功能

关键信息

请提供以下信息:

• bk_sops 版本 (发布版本号 或 git tag): V3.3.9

【远程包源及包管理模块】从 git 仓库导入模块的导入器

问题描述

需要编写一个继承自非标准导入器的 git 仓库模块导入器，允许从 git 仓库中进行 Python 模块的导入。

关键信息

请提供以下信息:

• bk_sops 版本: 3.3.9

V3.1.32打包后生成的版本包部署失败

问题描述

V3.1.32打包后生成的版本包部署失败

重现方法

第一次部署

关键信息

请提供以下信息:

• bk_sops V3.1.32-ce
• 蓝鲸PaaS 版本
  open_paas: 3.0.94
  paas_agent: 3.0.8
• bk_sops 异常日志

------STARTING: Migrate Database------
Traceback (most recent call last):
  File "manage.py", line 27, in <module>
    execute_from_command_line(sys.argv)
  File "/cache/.bk/env/lib/python2.7/site-packages/django/core/management/__init__.py", line 354, in execute_from_command_line
    utility.execute()
  File "/cache/.bk/env/lib/python2.7/site-packages/django/core/management/__init__.py", line 328, in execute
    django.setup()
  File "/cache/.bk/env/lib/python2.7/site-packages/django/__init__.py", line 18, in setup
    apps.populate(settings.INSTALLED_APPS)
  File "/cache/.bk/env/lib/python2.7/site-packages/django/apps/registry.py", line 85, in populate
    app_config = AppConfig.create(entry)
  File "/cache/.bk/env/lib/python2.7/site-packages/django/apps/config.py", line 112, in create
    mod = import_module(mod_path)
  File "/cache/.bk/env/lib/python2.7/importlib/__init__.py", line 37, in import_module
    __import__(name)
  File "/data/app/code/pipeline/apps.py", line 18, in <module>
    from rediscluster import StrictRedisCluster
  File "/cache/.bk/env/lib/python2.7/site-packages/rediscluster/__init__.py", line 7, in <module>
    from .client import StrictRedisCluster, RedisCluster
  File "/cache/.bk/env/lib/python2.7/site-packages/rediscluster/client.py", line 10, in <module>
    from .connection import (
  File "/cache/.bk/env/lib/python2.7/site-packages/rediscluster/connection.py", line 11, in <module>
    from .nodemanager import NodeManager
  File "/cache/.bk/env/lib/python2.7/site-packages/rediscluster/nodemanager.py", line 12, in <module>
    from redis._compat import b, unicode, bytes, long, basestring
ImportError: cannot import name b
------FAILURE: Migrate Database------

【远程包源及包管理模块】- 包源及包模型

问题描述

【远程包源及包管理模块】- 包源及包模型

关键信息

请提供以下信息:

• bk-sops 版本：3.3.11