Skip to content

Commit

Permalink
doc(recurring-job): introduce new task types
Browse files Browse the repository at this point in the history
Two new task types `snapshot-force-create` and `backup-force-create`

Ref: 4898

Signed-off-by: James Lu <james.lu@suse.com>
  • Loading branch information
mantissahz committed Mar 21, 2023
1 parent 2609e6f commit 6ea9a94
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ To create a recurring job, you can go to the `Recurring Job` page in Longhorn an

You can configure,
- Any groups that the job should belong to
- The type of schedule, either `backup`, `snapshot`, `snapshot-cleanup` or `snapshot-delete`
- The type of schedule, either `backup`, `backup-force-create`, `snapshot`, `snapshot-force-create`, `snapshot-cleanup` or `snapshot-delete`
- The time that the backup or snapshot will be created, in the form of a [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression)
- The number of backups or snapshots to retain
- The number of jobs to run concurrently
Expand Down Expand Up @@ -65,8 +65,10 @@ The following parameters should be specified for each recurring job selector:
- `name`: Name of the recurring job. Do not use duplicate names. And the length of `name` should be no more than 40 characters.

- `task`: Type of the job. Longhorn supports the following:
- `backup`: periodically create snapshots then do backups
- `snapshot`: periodically create snapshots
- `backup`: periodically create snapshots then do backups except for old snapshots cleanup failed before creating new snapshots
- `backup-force-create`: periodically create snapshots the do backups even if old snapshots cleanup failed
- `snapshot`: periodically create snapshots except for old snapshots cleanup failed before creating new snapshots
- `snapshot-force-create`: periodically create snapshots even if old snapshots cleanup failed
- `snapshot-cleanup`: periodically purge removable snapshots and system snapshots
> **Note:** retain value has no effect for this task, Longhorn automatically mutates the `retain` value to 0.
- `snapshot-delete`: periodically remove and purge all kinds of snapshots that exceed the retention count.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ To create a recurring job, you can go to the `Recurring Job` page in Longhorn an

You can configure,
- Any groups that the job should belong to
- The type of schedule, either `backup`, `snapshot`, `snapshot-cleanup` or `snapshot-delete`
- The type of schedule, either `backup`, `backup-force-create`, `snapshot`, `snapshot-force-create`, `snapshot-cleanup` or `snapshot-delete`
- The time that the backup or snapshot will be created, in the form of a [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression)
- The number of backups or snapshots to retain
- The number of jobs to run concurrently
Expand Down Expand Up @@ -65,8 +65,10 @@ The following parameters should be specified for each recurring job selector:
- `name`: Name of the recurring job. Do not use duplicate names. And the length of `name` should be no more than 40 characters.

- `task`: Type of the job. Longhorn supports the following:
- `backup`: periodically create snapshots then do backups
- `snapshot`: periodically create snapshots
- `backup`: periodically create snapshots then do backups except for old snapshots cleanup failed before creating new snapshots
- `backup-force-create`: periodically create snapshots the do backups even if old snapshots cleanup failed
- `snapshot`: periodically create snapshots except for old snapshots cleanup failed before creating new snapshots
- `snapshot-force-create`: periodically create snapshots even if old snapshots cleanup failed
- `snapshot-cleanup`: periodically purge removable snapshots and system snapshots
> **Note:** retain value has no effect for this task, Longhorn automatically mutates the `retain` value to 0.
- `snapshot-delete`: periodically remove and purge all kinds of snapshots that exceed the retention count.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ To create a recurring job, you can go to the `Recurring Job` page in Longhorn an

You can configure,
- Any groups that the job should belong to
- The type of schedule, either `backup`, `snapshot`, `snapshot-cleanup` or `snapshot-delete`
- The type of schedule, either `backup`, `backup-force-create`, `snapshot`, `snapshot-force-create`, `snapshot-cleanup` or `snapshot-delete`
- The time that the backup or snapshot will be created, in the form of a [CRON expression](https://en.wikipedia.org/wiki/Cron#CRON_expression)
- The number of backups or snapshots to retain
- The number of jobs to run concurrently
Expand Down Expand Up @@ -65,8 +65,10 @@ The following parameters should be specified for each recurring job selector:
- `name`: Name of the recurring job. Do not use duplicate names. And the length of `name` should be no more than 40 characters.

- `task`: Type of the job. Longhorn supports the following:
- `backup`: periodically create snapshots then do backups
- `snapshot`: periodically create snapshots
- `backup`: periodically create snapshots then do backups except for old snapshots cleanup failed before creating new snapshots
- `backup-force-create`: periodically create snapshots the do backups even if old snapshots cleanup failed
- `snapshot`: periodically create snapshots except for old snapshots cleanup failed before creating new snapshots
- `snapshot-force-create`: periodically create snapshots even if old snapshots cleanup failed
- `snapshot-cleanup`: periodically purge removable snapshots and system snapshots
> **Note:** retain value has no effect for this task, Longhorn automatically mutates the `retain` value to 0.
Expand Down

0 comments on commit 6ea9a94

Please sign in to comment.