Skip to content

Commit bf494ea

Browse files
committed
docs: risk level
1 parent ec6ea6d commit bf494ea

File tree

3 files changed

+18
-8
lines changed

3 files changed

+18
-8
lines changed

content/docs/_layout.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,6 @@ expand_section_list: ['Self-host']
9191

9292
#### [Custom Approval](/administration/custom-approval)
9393

94-
#### [Risk Center](/administration/risk-center)
95-
9694
### Roll out
9795

9896
#### [Rollout Policy](/administration/environment-policy/rollout-policy)
@@ -129,6 +127,8 @@ expand_section_list: ['Self-host']
129127

130128
#### [Webhook](/change-database/webhook)
131129

130+
#### [Risk Center](/administration/risk-center)
131+
132132
#### [Issue](/change-database/issue)
133133

134134
#### [Schema Template](/administration/schema-template)

content/docs/administration/risk-center.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,36 @@ feature_name: CUSTOM_APPROVAL
55

66
In **Settings > Risk Center**, you can define different risk levels for each operation types ([DML, DDL, Create Database](/docs/change-database/change-workflow/), [Request Query](/docs/security/database-permission/query/), [Request Export](/docs/security/database-permission/export/)) with custom rules.
77

8-
Once an issue matches the risk conditions, it will be assigned to the corresponding risk level you've defined.
9-
If an issue matches more than one risk levels, the highest level will be used.
8+
Once an operation matches the risk conditions, it will be assigned to the corresponding risk level you've defined.
9+
If an operation matches more than one risk levels, the highest level will be used.
10+
11+
## Usage
12+
13+
### Custom Approval
1014

1115
You can configure different [custom approval flows](/docs/administration/custom-approval) for each operation types and risk levels.
1216

1317
![ddl-dml](/content/docs/administration/risk-center/ddl-dml.webp)
1418

1519
![request-query](/content/docs/administration/risk-center/request-query.webp)
1620

17-
### Configuration
21+
### SQL Review
22+
23+
[SQL review](/docs/sql-review/overview/) returns the associated risk level for the checked SQL statement. Bytebase GitHub action can also surface the risk level under a [PR](https://github.com/bytebase/release-cicd-workflows-example/pull/4).
24+
25+
![sql-review](/content/docs/administration/risk-center/github-actions-risk.webp)
26+
27+
## Configuration
1828

1929
Click **Add rule** to create a new risk rule.
2030

21-
#### General information
31+
### General
2232

2333
Name the rule so that you may know what it cares about. Select the operation type of rule. The **Risk** can be defined as **High**, **Moderate** or **Low**.
2434

2535
![basic-info](/content/docs/administration/risk-center/basic-info.webp)
2636

27-
#### Condition
37+
### Condition
2838

2939
Configure the condition of the rule. You may use a combination of conditions and condition groups.
3040

@@ -33,7 +43,7 @@ Configure the condition of the rule. You may use a combination of conditions and
3343

3444
![condition](/content/docs/administration/risk-center/condition.webp)
3545

36-
#### Templates
46+
### Templates
3747

3848
A template is a system preset example of useful conditions that might be frequently used.
3949

35.1 KB
Loading

0 commit comments

Comments
 (0)