Skip to content

Commit 2c9b73f

Browse files
authored
Merge pull request #582 from acekingke/fixDocBackupSchedule
doc: add backupschedule docs in zh
2 parents ed0e763 + 12134c8 commit 2c9b73f

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

docs/zh-cn/backup_cron.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
目录
2+
=============
3+
4+
# 简介
5+
目前,无论 S3 还是 NFS 备份,均支持定时备份,并支持使用 crontab 表达式来指定备份的时间策略。您只需直接在集群的 YAML 文件的 `spec` 下设置 `backupSchedule` 字段。例如:
6+
7+
```yaml
8+
...
9+
spec:
10+
replicas: 3
11+
mysqlVersion: "5.7"
12+
backupSchedule: "0 0 0 * * *" # daily
13+
...
14+
```
15+
# 定时备份配置方式
16+
17+
## cron 表达式格式
18+
19+
cron 表达式的格式为: `[秒] [分] [时] [日] [月] [星期]`,即由6个使用空格分隔的字段组成的时间组合。
20+
21+
22+
字段名 | 必配 | 允许值 | 允许的特殊符号
23+
---------- | ---------- | -------------- | --------------------------
24+
秒 | 是 | 0-59 | * / , -
25+
分 | 是 | 0-59 | * / , -
26+
时 | 是 | 0-23 | * / , -
27+
日 | 是 | 1-31 | * / , - ?
28+
月 | 是 | 1-12 or JAN-DEC | * / , -
29+
星期 | 是 | 0-6 or SUN-SAT | * / , - ?
30+
31+
> 注意:```星期` 字段值大小写不敏感,即 `SUN`, `Sun`, 和 `sun` 均接受。
32+
33+
### 特殊字符
34+
星号(*
35+
36+
星号可用在所有字段中,表示对应时间域的每一个时刻。例如,第 5 个字段(月)值为星号,表示每个月。
37+
38+
反斜线(/)
39+
40+
表示范围增量。例如,第 2 个字段(分钟)中的 3-59/15 表示从该小时的第 3 分钟开始,此后以 15 分钟为时间间隔执行备份。`*/y` 等同于 `min-max/y``n/y` 等同于 `n-max/y`,即从 n 开始使用增量, 直到特定范围结束。
41+
42+
逗号(,)
43+
44+
逗号用来隔离列表中的项目。例如,在第 5 个字段 (星期) 中使用 `MON,WED,FRI` 将表示周一、周三和周五。
45+
46+
连字符(-)
47+
48+
连字号用来指定范围。例如,在第 3 个字段 (小时) 中使用 `9-17` 表示从 9 点到 17 点间的每一个小时。
49+
50+
问号(?)
51+
52+
不指定值,仅日期和星期域支持该字符。当日期或星期域其中之一被指定了值以后,为了避免冲突,需要将另一个域的值设为`?`
53+
54+
@ 符号
55+
56+
你可以用如下的预定义时间来代替 cron 表达式。
57+
58+
值 | 描述 | 等同于
59+
----- | ----------- | -------------
60+
@yearly(或 @annually) | 每年执行一次,在 1 月 1 日夜晚 12 点执行 | 0 0 0 1 1 *
61+
@monthly | 每月执行一次,在每月第 1 天 夜晚 12 点执行 | 0 0 0 1 * *
62+
@weekly | 每周执行一次,在周六和周日之间的夜晚 12 点执行 | 0 0 0 * * 0
63+
@daily(或 @midnight) | 每日执行一次,在夜晚 12 点执行 | 0 0 0 * * *
64+
@hourly | 每小时执行一次,在第 1 分钟执行 | 0 0 * * * *

0 commit comments

Comments
 (0)