Skip to content

Commit

Permalink
Merge pull request radondb#582 from acekingke/fixDocBackupSchedule
Browse files Browse the repository at this point in the history
doc: add backupschedule docs in zh
  • Loading branch information
acekingke authored Jul 11, 2022
2 parents ed0e763 + 12134c8 commit 2c9b73f
Showing 1 changed file with 64 additions and 0 deletions.
64 changes: 64 additions & 0 deletions docs/zh-cn/backup_cron.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
目录
=============

# 简介
目前,无论 S3 还是 NFS 备份,均支持定时备份,并支持使用 crontab 表达式来指定备份的时间策略。您只需直接在集群的 YAML 文件的 `spec` 下设置 `backupSchedule` 字段。例如:

```yaml
...
spec:
replicas: 3
mysqlVersion: "5.7"
backupSchedule: "0 0 0 * * *" # daily
...
```
# 定时备份配置方式

## cron 表达式格式

cron 表达式的格式为: `[秒] [分] [时] [日] [月] [星期]`,即由6个使用空格分隔的字段组成的时间组合。


字段名 | 必配 | 允许值 | 允许的特殊符号
---------- | ---------- | -------------- | --------------------------
秒 | 是 | 0-59 | * / , -
分 | 是 | 0-59 | * / , -
时 | 是 | 0-23 | * / , -
日 | 是 | 1-31 | * / , - ?
月 | 是 | 1-12 or JAN-DEC | * / , -
星期 | 是 | 0-6 or SUN-SAT | * / , - ?

> 注意:```星期` 字段值大小写不敏感,即 `SUN`, `Sun`, 和 `sun` 均接受。
### 特殊字符
星号(*

星号可用在所有字段中,表示对应时间域的每一个时刻。例如,第 5 个字段(月)值为星号,表示每个月。

反斜线(/)

表示范围增量。例如,第 2 个字段(分钟)中的 3-59/15 表示从该小时的第 3 分钟开始,此后以 15 分钟为时间间隔执行备份。`*/y` 等同于 `min-max/y``n/y` 等同于 `n-max/y`,即从 n 开始使用增量, 直到特定范围结束。

逗号(,)

逗号用来隔离列表中的项目。例如,在第 5 个字段 (星期) 中使用 `MON,WED,FRI` 将表示周一、周三和周五。

连字符(-)

连字号用来指定范围。例如,在第 3 个字段 (小时) 中使用 `9-17` 表示从 9 点到 17 点间的每一个小时。

问号(?)

不指定值,仅日期和星期域支持该字符。当日期或星期域其中之一被指定了值以后,为了避免冲突,需要将另一个域的值设为`?`

@ 符号

你可以用如下的预定义时间来代替 cron 表达式。

值 | 描述 | 等同于
----- | ----------- | -------------
@yearly(或 @annually) | 每年执行一次,在 1 月 1 日夜晚 12 点执行 | 0 0 0 1 1 *
@monthly | 每月执行一次,在每月第 1 天 夜晚 12 点执行 | 0 0 0 1 * *
@weekly | 每周执行一次,在周六和周日之间的夜晚 12 点执行 | 0 0 0 * * 0
@daily(或 @midnight) | 每日执行一次,在夜晚 12 点执行 | 0 0 0 * * *
@hourly | 每小时执行一次,在第 1 分钟执行 | 0 0 * * * *

0 comments on commit 2c9b73f

Please sign in to comment.