docs(recurring job): behavior changed #678

mantissahz · 2023-03-21T01:55:54Z

Update important-notes for v1.3.3, v1.4.2 and v1.5.0.

Ref: longhorn/longhorn#4898

mantissahz · 2023-03-22T00:38:04Z

cc @c3y1huang @innobead

innobead

@mantissahz Please correct the doc as per the suggestions.

I did not make all the suggested changes, so you need to recheck this PR and fix them all.

innobead · 2023-04-18T22:35:05Z

content/docs/1.3.3/deploy/important-notes/index.md

@@ -14,3 +14,4 @@ Please see [here](https://github.com/longhorn/longhorn/releases/tag/v{{< current
 4. There are two important fixes that will prevent rarely potential data corruption during replica rebuilding, and also improve write performance via the specific filesystem block size.
   - [4354](https://github.com/longhorn/longhorn/issues/4354): Introduce Data Alignment Correction for existing volumes if the filesystem block size is less than 4096.
   - [4594](https://github.com/longhorn/longhorn/issues/4594): Use the specific block size for the filesystem to avoid unnecessary Ready-Modify-Write operations between volume head and snapshots.
+5. After the upgrade, the behavior of recurring job task types `Snapshot` and `Backup` will be changed to check the number of old snapshots first. If the number of old snapshots exceeds the retain count, older snapshots will be cleaned up first before taking a new snapshot. And introduce two new recurring job task types `Snapshot Force Create` and `Backup Force Create` and the new task type `Snapshot Force Create` will behave the same as the original behavior of the task type `Snapshot` as well as task types `Backup Force Create` and `Backup`.


Suggested change

5. After the upgrade, the behavior of recurring job task types `Snapshot` and `Backup` will be changed to check the number of old snapshots first. If the number of old snapshots exceeds the retain count, older snapshots will be cleaned up first before taking a new snapshot. And introduce two new recurring job task types `Snapshot Force Create` and `Backup Force Create` and the new task type `Snapshot Force Create` will behave the same as the original behavior of the task type `Snapshot` as well as task types `Backup Force Create` and `Backup`.

5. After the upgrade, the behavior of the recurring job types `Snapshot` and `Backup` will attempt to delete old snapshots first if they exceed the retained count before creating a new snapshot. Additionally, two new recurring job types have been introduced, `Snapshot Force Create` and `Backup Force Create`. They retain the original behavior of taking a snapshot or backup first before deleting outdated snapshots.

Modified. Thanks

innobead · 2023-04-18T22:41:29Z

content/docs/1.3.3/snapshots-and-backups/scheduling-backups-and-snapshots.md

@@ -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


Suggested change

- `backup`: periodically create snapshots then do backups except for old snapshots cleanup failed before creating new snapshots

- `backup`: periodically create snapshots then do backups after cleaning up outdated snapshots

Modified for all related files. Thanks

innobead · 2023-04-18T22:41:57Z

content/docs/1.3.3/snapshots-and-backups/scheduling-backups-and-snapshots.md

-  - `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


Suggested change

- `snapshot`: periodically create snapshots except for old snapshots cleanup failed before creating new snapshots

- `snapshot`: periodically create snapshots after cleaning up outdated snapshots

Modified for all related files. Thanks

innobead · 2023-04-18T22:44:41Z

content/docs/1.3.3/snapshots-and-backups/scheduling-backups-and-snapshots.md

+  - `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


Suggested change

- `snapshot-force-create`: periodically create snapshots even if old snapshots cleanup failed

- `snapshot-force-create`: periodically create snapshots

Modified for all related files. Thanks

innobead · 2023-04-18T22:46:05Z

content/docs/1.4.2/deploy/important-notes/index.md

@@ -14,6 +14,8 @@ Please ensure your Kubernetes cluster is at least v1.21 before upgrading to Long
 ### Recurring Jobs
 After the upgrade, the recurring job settings of volumes will be migrated to new recurring job resources, and the `RecurringJobs` field in the volume spec will be deprecated. [[doc](https://longhorn.io/docs/{{< current-version >}}/deploy/upgrade/#4-automatically-migrate-recurring-jobs)]

+And the behavior of recurring job task types `Snapshot` and `Backup` will be changed to check the number of old snapshots first. If the number of old snapshots exceeds the retain count, older snapshots will be cleaned up first before taking a new snapshot. And introduce two new recurring job task types `Snapshot Force Create` and `Backup Force Create` and the new task type `Snapshot Force Create` will behave the same as the original behavior of the task type `Snapshot` as well as task types `Backup Force Create` and `Backup`.


Suggested change

And the behavior of recurring job task types `Snapshot` and `Backup` will be changed to check the number of old snapshots first. If the number of old snapshots exceeds the retain count, older snapshots will be cleaned up first before taking a new snapshot. And introduce two new recurring job task types `Snapshot Force Create` and `Backup Force Create` and the new task type `Snapshot Force Create` will behave the same as the original behavior of the task type `Snapshot` as well as task types `Backup Force Create` and `Backup`.

The behavior of the recurring job types `Snapshot` and `Backup` will attempt to delete old snapshots first if they exceed the retained count before creating a new snapshot. Additionally, two new recurring job types have been introduced, `Snapshot Force Create` and `Backup Force Create`. They retain the original behavior of taking a snapshot or backup first before deleting outdated snapshots.

Modified. Thanks

innobead · 2023-04-18T22:46:51Z

content/docs/1.5.0/deploy/important-notes/index.md

@@ -14,6 +14,8 @@ Please ensure your Kubernetes cluster is at least v1.21 before upgrading to Long
 ### Recurring Jobs
 After the upgrade, the recurring job settings of volumes will be migrated to new recurring job resources, and the `RecurringJobs` field in the volume spec will be deprecated. [[doc](https://longhorn.io/docs/{{< current-version >}}/deploy/upgrade/#4-automatically-migrate-recurring-jobs)]

+And the behavior of recurring job task types `Snapshot` and `Backup` will be changed to check the number of old snapshots first. If the number of old snapshots exceeds the retain count, older snapshots will be cleaned up first before taking a new snapshot. And introduce two new recurring job task types `Snapshot Force Create` and `Backup Force Create` and the new task type `Snapshot Force Create` will behave the same as the original behavior of the task type `Snapshot` as well as task types `Backup Force Create` and `Backup`.


Suggested change

And the behavior of recurring job task types `Snapshot` and `Backup` will be changed to check the number of old snapshots first. If the number of old snapshots exceeds the retain count, older snapshots will be cleaned up first before taking a new snapshot. And introduce two new recurring job task types `Snapshot Force Create` and `Backup Force Create` and the new task type `Snapshot Force Create` will behave the same as the original behavior of the task type `Snapshot` as well as task types `Backup Force Create` and `Backup`.

The behavior of the recurring job types `Snapshot` and `Backup` will attempt to delete old snapshots first if they exceed the retained count before creating a new snapshot. Additionally, two new recurring job types have been introduced, `Snapshot Force Create` and `Backup Force Create`. They retain the original behavior of taking a snapshot or backup first before deleting outdated snapshots.

Modified. Thanks

Update `important-notes` for v1.3.3, v1.4.2 and v1.5.0. Ref: 4898 Signed-off-by: James Lu <james.lu@suse.com>

Two new task types `snapshot-force-create` and `backup-force-create` Ref: 4898 Signed-off-by: James Lu <james.lu@suse.com>

innobead

LGTM.

mantissahz requested a review from innobead March 21, 2023 01:55

mantissahz self-assigned this Mar 21, 2023

mantissahz marked this pull request as draft March 21, 2023 02:02

mantissahz force-pushed the issue4898-behavior-changed branch from b19c5d0 to 6ea9a94 Compare March 21, 2023 02:14

mantissahz marked this pull request as ready for review March 21, 2023 02:52

mantissahz requested review from a team and c3y1huang March 22, 2023 00:38

mantissahz force-pushed the issue4898-behavior-changed branch from 6ea9a94 to 0b80823 Compare April 10, 2023 07:48

mantissahz requested a review from a team as a code owner April 10, 2023 07:48

mantissahz force-pushed the issue4898-behavior-changed branch from 0b80823 to 009382f Compare April 18, 2023 02:35

innobead requested changes Apr 18, 2023

View reviewed changes

mantissahz added 2 commits April 19, 2023 09:55

docs(recurring-job): behavior changed

156e6c8

Update `important-notes` for v1.3.3, v1.4.2 and v1.5.0. Ref: 4898 Signed-off-by: James Lu <james.lu@suse.com>

doc(recurring-job): introduce new task types

0e2147f

Two new task types `snapshot-force-create` and `backup-force-create` Ref: 4898 Signed-off-by: James Lu <james.lu@suse.com>

mantissahz force-pushed the issue4898-behavior-changed branch from 009382f to 0e2147f Compare April 19, 2023 02:12

mantissahz requested a review from innobead April 19, 2023 02:16

innobead approved these changes Apr 19, 2023

View reviewed changes

innobead merged commit 6004994 into longhorn:master Apr 19, 2023
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(recurring job): behavior changed #678

docs(recurring job): behavior changed #678

mantissahz commented Mar 21, 2023

mantissahz commented Mar 22, 2023

innobead left a comment

innobead Apr 18, 2023

mantissahz Apr 19, 2023

innobead Apr 18, 2023

mantissahz Apr 19, 2023

innobead Apr 18, 2023

mantissahz Apr 19, 2023

innobead Apr 18, 2023

mantissahz Apr 19, 2023

innobead Apr 18, 2023

mantissahz Apr 19, 2023

innobead Apr 18, 2023

mantissahz Apr 19, 2023

innobead left a comment

	- `backup`: periodically create snapshots then do backups except for old snapshots cleanup failed before creating new snapshots
	- `backup`: periodically create snapshots then do backups after cleaning up outdated snapshots

	- `snapshot`: periodically create snapshots except for old snapshots cleanup failed before creating new snapshots
	- `snapshot`: periodically create snapshots after cleaning up outdated snapshots

	- `snapshot-force-create`: periodically create snapshots even if old snapshots cleanup failed
	- `snapshot-force-create`: periodically create snapshots

docs(recurring job): behavior changed #678

docs(recurring job): behavior changed #678

Conversation

mantissahz commented Mar 21, 2023

mantissahz commented Mar 22, 2023

innobead left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

innobead left a comment

Choose a reason for hiding this comment