Fixed 694

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,10 @@
+---
+name: Bug Report
+about: Report a bug encountered while operating bk-job
+title: ''
+labels: kind/bug
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/enhancement.md

@@ -0,0 +1,10 @@
+---
+name: Enhancement Request
+about: Suggest an enhancement to the bk-job project
+title: ''
+labels: kind/enhancement
+assignees: ''
+
+---
+
+

.github/workflows/backend.yml

@@ -0,0 +1,47 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Backend CI
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the master branch
+on:
+  push:
+    branches: [ master ]
+    paths:
+      - 'src/backend/**'
+  pull_request:
+    branches: [ master, 3.* ]
+    paths:
+      - 'src/backend/**'
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+      - name: init mysql
+        run: |
+          sudo /etc/init.d/mysql start
+          export MYSQL_PWD=root
+          for i in */*.sql;do echo $i;mysql -h localhost -uroot < $i;done
+        working-directory: support-files/sql
+      - name: Set up JDK 1.8
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+      - name: Cache Gradle
+        uses: actions/cache@v1
+        with:
+          path: ~/.gradle/caches
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+      - name: Gradle Build
+        working-directory: src/backend
+        run: ./gradlew clean build -DmysqlURL=127.0.0.1:3306 -DmysqlUser=root -DmysqlPasswd=root -DmavenRepoUrl="http://maven.aliyun.com/nexus/content/groups/public/"

.github/workflows/frontend.yml

@@ -0,0 +1,27 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Frontend CI
+
+on:
+  push:
+    branches: [ master ]
+    paths:
+      - 'src/frontend/**'
+  pull_request:
+    branches: [ master, 3.* ]
+    paths:
+      - 'src/frontend/**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - run: echo "npm version=$(npm -v)"
+      - name: build
+        run: |
+          export JOB_VERSION=3.latest
+          npm i && npm run build
+        working-directory: src/frontend

.github/workflows/release.yml

@@ -0,0 +1,80 @@
+name: Tag Realse
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    name: Build whole project and release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up variables
+        id: variables
+        run: |
+          tag="$(basename $GITHUB_REF)"
+          version=${tag##v}
+          echo "::set-output name=tag::${tag}"
+          echo "::set-output name=version::${version}"
+      - name: init mysql
+        run: |
+          sudo /etc/init.d/mysql start
+          export MYSQL_PWD=root
+          for i in */*.sql;do echo $i;mysql -h localhost -uroot < $i;done
+        working-directory: support-files/sql
+      - name: Set up JDK 1.8
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+      - name: Cache Gradle
+        uses: actions/cache@v1
+        with:
+          path: ~/.gradle/caches
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+      - name: Gradle Build Backend
+        working-directory: src/backend
+        run: ./gradlew clean build -Dversion=${{ steps.variables.outputs.version }} -DmysqlURL=127.0.0.1:3306 -DmysqlUser=root -DmysqlPasswd=root -DmavenRepoUrl="http://maven.aliyun.com/nexus/content/groups/public/"
+
+      - name: Npm Build Frontend
+        run: |
+          echo "npm version=$(npm -v)"
+          export JOB_VERSION=${{ steps.variables.outputs.version }}
+          npm i && npm run build
+          mkdir -p release/job/frontend
+          cp -r dist/* release/job/frontend
+        working-directory: src/frontend
+
+      - name: Build VersionLogs
+        run: python genBundledVersionLog.py
+        working-directory: versionLogs
+
+      - name: Create artifact - make package
+        id: create_artifact
+        run: |
+          echo ${{ steps.variables.outputs.version }} > ./VERSION
+          chmod 755 ./package.sh
+          ./package.sh -m all -v ${{ steps.variables.outputs.version }}
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: bk-job ${{ github.ref }}
+          draft: true
+          prerelease: true
+
+      - name: Upload Release Asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./release/job_ce-${{ steps.variables.outputs.version }}.tgz
+          asset_name: job_ce-${{ steps.variables.outputs.version }}.tgz
+          asset_content_type: application/gzip

README.en.md

@@ -0,0 +1,82 @@
+![LOGO](docs/resource/img/bk-job.png)
+---
+[![license](https://img.shields.io/badge/license-mit-brightgreen.svg?style=flat)](https://github.com/Tencent/bk-job/blob/master/LICENSE.txt) [![Release Version](https://img.shields.io/github/v/release/Tencent/bk-job?include_prereleases)](https://github.com/Tencent/bk-job/releases)
+
+English | [简体中文](README.md)
+
+> **Notice**: During the process of development, the 'master' branch might be in an *unstable state or unavailable state*.
+Please access the stable binary file via [releases](https://github.com/tencent/bk-job/releases) instead of 'master'.
+
+The BK-JOB is a ops script management and execution system with the capability of dealing with multiple tasks simultaneously. In addition to script execution, file distribution, cron jobs, and other basic operation environments, it is also capable of putting together all the individual tasks into an automated workflow. All tasks, as individual nodes, can be offered to upper-level or peripheral systems/platforms, making it an automated cross-system dispatching system.
+
+## Benefits
+
+### Dependable Dangerous Command Detection Ability
+
+As an underlying atomic operation platform made for server OS, the verification of user command's validity and safety is of critical importance! The platform allows for regular expression detection rules for dangerous commands in various script languages, and provides a log for intercepted operations. Even when a command is made by a peripheral system via API, it'll be intercepted immediately, making the server more secure!
+
+### Comprehensive Script Version Management
+
+Cloud management of script versions, which is accordant with the modern concept of collaboration. Aided by the convenient platform and version management feature, BK-JOB users can share script resources, control the releasing status of various versions, and reduce loss if there's a security vulnerability.
+
+### Arrange Jobs for All Scenarios
+
+When an operation scenario requires multiple interconnected steps, clicking them one by one is too inefficient! Besides, it is inconvenient for later usage and maintenance.
+
+The task management feature offers an optimal solution. Users can set up the necessary steps on the "Job Template" before making up an "Executable Plan" as required by the scenario; As such, job templates and its instances are set apart rather than welded together, which is also beneficial to later management and maintenance.
+
+### The Authentic Cron Jobs
+
+Linux's original crontab job feature is preserved, allowing the maintenance team to access them easily. The friendly monitoring feature allows you to easily control and assess the situation of scheduled tasks.
+
+### Scalable File Source Management
+
+When it comes to file distribution, we not only use remote server and local files as source of transmission, we also need to retrieve files from different file systems/services such as object storage, FTP, and Samba.
+
+To meet the diversified demands, we have enabled the file source plug-in feature, which allows developers to develop plugins for the file management modules on the platform according to their own file system. As such, they can distribute files from various file systems.
+
+
+BK-JOB provides quick execution, task arrangement, cron job, and a wide range of core services, meeting the demands of all environments:
+- **Quick Execution**: Offers a temporary, versatile, quick access.
+- **Task Arrangement**: Transforms repetitive operations into "jobs" using the arrangement feature to make them easy to use and manage.
+- **Scheduled Execution**: Allows users to make up periodic or one-off execution plans according to the logical needs of their business.
+- **Script Management**: Manage scripts in a cloud-based mode, which further facilitates job arrangement and the flexibility of peripheral system scheduling.
+- **Account Management**: The execution account of that manages server OS, such as Linux root or Windows administrator, etc.
+- **Notification**: Allows businesses to send notifications on the execution result for various task statuses.
+- **File Source Management**: Enables file source plugins, allowing it to retrieve and transfer files from various file systems.
+- **Operation Analysis**: Displays platform operation statistics, which allows the administrator to have an all-around insight into the operation of the platform.
+- **Platform Management**: A versatile platform management tool whose features include, but not limited to, information modification, message channel settings, rules for detecting dangerous commands, feature limitation settings, public script management, background service status display, etc.
+
+## Overview
+
+- [Architecture Design](docs/overview/architecture.en.md)
+- [Code Directory](docs/overview/code_framework.en.md)
+- [Design Philosophy](docs/overview/design.en.md)
+
+## Features
+
+For more information, please check Blueking's official website [Platform Product Overview](https://bk.tencent.com/docs/document/6.0/125/5748)
+
+## Getting started
+- [Download and Compile](docs/overview/source_compile.en.md)
+- [Installation Setup](docs/overview/installation.en.md)
+
+## Support
+1. [GitHub Community](https://github.com/Tencent/bk-job/discussions)
+
+## BlueKing Community
+- [BK-BCS](https://github.com/Tencent/bk-bcs): Blueking Container Service is a container-based basic service platform that provides management service to microservice businesses.
+- [BK-BCS-SaaS](https://github.com/Tencent/bk-bcs-saas): Blueking Container Platform SaaS is based on two modes: original Kubernetes and self-developed Mesos, offering users highly scalable, flexible container service.
+- [BK-CI](https://github.com/Tencent/bk-ci): Blueking Continuous Integration platform is a free, open source CI service, which allows developers to automatically create - test - release workflow, and continuously, efficiently deliver their high-quality products.
+- [BK-CMDB](https://github.com/Tencent/bk-cmdb): BlueKing CMDB is an enterprise-level management platform designed for assets and applications.
+- [BK-PaaS](https://github.com/Tencent/bk-PaaS): Blueking PaaS is an open development platform that allows developers to efficiently create, develop, set up, and manage SaaS apps.
+- [BK-SOPS](https://github.com/Tencent/bk-sops): Blueking SOPS is a system that features workflow arrangement and execution using a graphical interface. It's a lightweight task scheduling and arrangement SaaS product of the Blueking system.
+
+## Contributing
+- For more information about bk-job's fork management, issue and PR rules, please check [Contributing](CONTRIBUTING.md).
+- [Tencent Open Source Incentive Plan](https://opensource.tencent.com/contribution) encourages developers to engage and contribute in the community. Join us now!
+
+
+## License
+BK-JOB is based on the MIT agreement. For more information, please check [LICENSE](LICENSE.txt).
+

README.md

@@ -2,6 +2,7 @@
 ---
 [![license](https://img.shields.io/badge/license-mit-brightgreen.svg?style=flat)](https://github.com/Tencent/bk-job/blob/master/LICENSE.txt) [![Release Version](https://img.shields.io/github/v/release/Tencent/bk-job?include_prereleases)](https://github.com/Tencent/bk-job/releases)
 
+[English](README.en.md) | 简体中文
 
 > **重要提示**: `master` 分支在开发过程中可能处于 *不稳定或者不可用状态* 。
 请通过[releases](https://github.com/tencent/bk-job/releases) 而非 `master` 去获取稳定的二进制文件。

UPGRADE.en.md

@@ -0,0 +1,28 @@
+## About Updates
+
+English | [简体中文](UPGRADE.md)
+
+### Version 3.3.4.x
+This version is joined by a new update tool (upgrader-3.3.4.x.jar, in the same directory with other binary packages). It needs to be run before and after restarting the process of Job binary Jar file update (all microservice processes), which is twice in total for the tool, in order to transfer permission data and encrypted account data.
+
+**Compatibility**  
+It is used for updates from 3.x.x.x to 3.3.4.x or higher. It doesn't need to be executed when updating within the 3.3.4.x version (e.g. 3.3.4.0-->3.3.4.3)
+
+**Using the Tool**   
+Launch the tool with the command: `java -Dfile.encoding=utf8 -Djob.log.dir=path/to/log/dir -Dconfig.file=/path/to/config/file -jar upgrader-[x.x.x.x].jar [fromVersion] [toVersion] [executeTime]` Next, enter the specific parameters of the version update task based on the command line prompts, then run the update tool.  
+
+/path/to/log/dir The log saving path for specified tools, mostly ${BK_HOME}/logs/job  
+/path/to/config/file The configuration file loaded by specific tools. The configuration file is automatically generated by the setup script. Its path is: ${BK_HOME}/etc/job/upgrader/upgrader.properties
+fromVersion is the current platform version, e.g. 3.2.7.3  
+toVersion is target platform version, e.g. 3.3.4.0  
+executeTime is the execution time of the update task, its has BEFORE_UPDATE_JOB and AFTER_UPDATE_JOB values. If you're running this tool before the platform update, enter BEFORE_UPDATE_JOB. If its after the update, enter AFTER_UPDATE_JOB  
+
+Example:  
+Before Job process update:    
+```shell script
+/opt/java/bin/java -Dfile.encoding=utf8 -Djob.log.dir=/data/bkee/logs/job -Dconfig.file=/data/bkee/etc/job/upgrader/upgrader.properties -jar upgrader-3.3.4.0.jar 3.2.7.3 3.3.4.0 BEFORE_UPDATE_JOB  
+```
+After Job process update:  
+```shell script
+/opt/java/bin/java -Dfile.encoding=utf8 -Djob.log.dir=/data/bkee/logs/job -Dconfig.file=/data/bkee/etc/job/upgrader/upgrader.properties -jar upgrader-3.3.4.0.jar 3.2.7.3 3.3.4.0 AFTER_UPDATE_JOB
+```

UPGRADE.md

@@ -0,0 +1,28 @@
+## 升级说明
+
+[English](UPGRADE.en.md) | 简体中文
+
+### 版本3.3.4.x
+该版本增加一个升级工具（upgrader-3.3.4.x.jar，与其他二进制包在同一目录），需要在更新Job二进制Jar文件重启进程（所有微服务进程）前后用不同参数分别执行一次，工具总共执行两次，用于迁移权限数据和账号加密数据。
+
+**适用范围**  
+适用于从3.x.x.x向3.3.4.x及以上版本升级，3.3.4.x版本内升级（如3.3.4.0-->3.3.4.3）无需执行。
+
+**工具用法**   
+使用命令`java -Dfile.encoding=utf8 -Djob.log.dir=path/to/log/dir -Dconfig.file=/path/to/config/file -jar upgrader-[x.x.x.x].jar [fromVersion] [toVersion] [executeTime]` 启动工具，再根据命令行提示输入与具体版本升级任务相关的特定参数，运行升级工具。  
+
+/path/to/log/dir用于指定工具日志保存路径，通常为${BK_HOME}/logs/job  
+/path/to/config/file用于指定工具读取的配置文件，该配置文件由部署脚本自动渲染生成，路径为${BK_HOME}/etc/job/upgrader/upgrader.properties
+fromVersion为当前作业平台版本，如3.2.7.3  
+toVersion为目标作业平台版本，如3.3.4.0  
+executeTime为升级任务执行的时间点，取值为BEFORE_UPDATE_JOB、AFTER_UPDATE_JOB，在更新作业平台进程前执行本工具填写BEFORE_UPDATE_JOB，更新进程后执行则填写AFTER_UPDATE_JOB  
+
+示例：  
+Job进程更新前：    
+```shell script
+/opt/java/bin/java -Dfile.encoding=utf8 -Djob.log.dir=/data/bkee/logs/job -Dconfig.file=/data/bkee/etc/job/upgrader/upgrader.properties -jar upgrader-3.3.4.0.jar 3.2.7.3 3.3.4.0 BEFORE_UPDATE_JOB  
+```
+Job进程更新后：  
+```shell script
+/opt/java/bin/java -Dfile.encoding=utf8 -Djob.log.dir=/data/bkee/logs/job -Dconfig.file=/data/bkee/etc/job/upgrader/upgrader.properties -jar upgrader-3.3.4.0.jar 3.2.7.3 3.3.4.0 AFTER_UPDATE_JOB
+```