How tencentblueking/bk-sops works
BlueKing SOPS is a visual operations workflow authoring and execution SaaS. Its principal path is users composing a template, turning it into a task, then controlling and inspecting execution; it also provides reusable plugins, self-service apps, scheduled work, access control, and operational integrations. The graph captures documented capabilities and source-visible calls, while several unsampled subsystems are represented only at their exact enclosing directories. Some relationships are necessarily documented or unverified because the excerpts do not expose their runtime wiring.
Main entry points: models.py Task orchestration · template_manager.py Template manager · TemplateEdit/index.vue Template editor · TaskExecute/index.vue Execution controls
Components 25
Workflow authoring
- SOPS desktop
frontend/desktop/src/App.vue - Template editor
frontend/desktop/src/pages/template/TemplateEdit/index.vue - Workflow canvas
frontend/desktop/src/components/common/TemplateCanvas/index.vue - Template manager
gcloud/template_base/domains/template_manager.py - Template records
gcloud/tasktmpl3/models.py - Pipeline representation
pipeline_web/core/models.py - Tree validation
pipeline_web/parser/clean.py
Task execution
- Task creation
frontend/desktop/src/pages/task/TaskCreate/index.vue - Task orchestration
gcloud/taskflow3/models.py - Workflow engine
- Execution controls
frontend/desktop/src/pages/task/TaskExecute/index.vue - Node log API
gcloud/taskflow3/apis/drf/viewsets/engine_v2_node_log.py - Log data source
gcloud/taskflow3/domains/node_log.py - Scheduled tasks
gcloud/periodictask/models.py
Platform services
- Usage statistics
gcloud/analysis_statistics/tasks.py - IAM permissions
gcloud/iam_auth/res_factory.py - File handling
files/models.py
Plugins and integrations
- Plugin components
pipeline_plugins/components/collections/controller.py - CMDB host picker
pipeline_plugins/cmdb_ip_picker/query.py - NodeMan client
api/collections/nodeman.py - BlueKing services
Self-service
- Light applications
gcloud/contrib/appmaker/models.py - App maker UI
frontend/desktop/src/pages/appmaker/index.vue - Shared templates
gcloud/common_template/models.py
Other components
- Operator
Connections 25
- Operator → SOPS desktop: uses
- SOPS desktop → Template editor: opens
- Template editor → Workflow canvas: edits flow
- Template manager → Tree validation: cleans tree
gcloud/template_base/domains/template_manager.py - Template manager → Pipeline representation: persists tree
gcloud/template_base/domains/template_manager.py - Template manager → Template records: creates template
- Template editor → Template manager: saves template
- Operator → Task creation: creates task
- Task creation → Task orchestration: starts task
- Task orchestration → Workflow engine: creates instance
gcloud/taskflow3/models.py - Operator → Execution controls: controls run
- Execution controls → Task orchestration: operates task
- Task orchestration → Workflow engine: dispatches actions
gcloud/taskflow3/models.py - Execution controls → Node log API: requests logs
- Node log API → Log data source: fetches logs
gcloud/taskflow3/apis/drf/viewsets/engine_v2_node_log.py - Node log API → IAM permissions: authorizes task
gcloud/taskflow3/apis/drf/viewsets/engine_v2_node_log.py - Operator → App maker UI: uses self-service
- App maker UI → Light applications: configures app
- Shared templates → Template manager: shares workflows
- Scheduled tasks → Task orchestration: schedules tasks
- Task orchestration → Usage statistics: records execution
- Plugin components → BlueKing services: calls services
- CMDB host picker → NodeMan client: queries hosts
pipeline_plugins/cmdb_ip_picker/query.py - NodeMan client → BlueKing services: calls NodeMan
- Operator → File handling: uploads files