Skip to content

Commit

Permalink
docs: add a notice prohibiting retention policies on backup targets
Browse files Browse the repository at this point in the history
Longhorn 9795

Signed-off-by: Derek Su <derek.su@suse.com>
  • Loading branch information
derekbit committed Nov 14, 2024
1 parent dcd7ace commit f1a3d73
Show file tree
Hide file tree
Showing 14 changed files with 66 additions and 29 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ If you don't have access to AWS S3 or want to give the backupstore a try first,

Longhorn also supports setting up recurring snapshot/backup jobs for volumes, via Longhorn UI or Kubernetes Storage Class. See [here](../../scheduling-backups-and-snapshots) for details.

> **Notice**
>
> The lifecycle of Longhorn backups within the backup store is managed by Longhorn. Any retention policy on the backup store is prohibited.
This page covers the following topics:

- [Set up AWS S3 Backupstore](#set-up-aws-s3-backupstore)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ If you don't have access to AWS S3 or want to give the backupstore a try first,

Longhorn also supports setting up recurring snapshot/backup jobs for volumes, via Longhorn UI or Kubernetes Storage Class. See [here](../../scheduling-backups-and-snapshots) for details.

> **Notice**
>
> The lifecycle of Longhorn backups within the backup store is managed by Longhorn. Any retention policy on the backup store is prohibited.
This page covers the following topics:

- [Set up AWS S3 Backupstore](#set-up-aws-s3-backupstore)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ If you don't have access to AWS S3 or want to give the backupstore a try first,

Longhorn also supports setting up recurring snapshot/backup jobs for volumes, via Longhorn UI or Kubernetes Storage Class. See [here](../../scheduling-backups-and-snapshots) for details.

> **Notice**
>
> The lifecycle of Longhorn backups within the backup store is managed by Longhorn. Any retention policy on the backup store is prohibited.
This page covers the following topics:

- [Set up AWS S3 Backupstore](#set-up-aws-s3-backupstore)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ If you don't have access to AWS S3 or want to give the backupstore a try first,

Longhorn also supports setting up recurring snapshot/backup jobs for volumes, via Longhorn UI or Kubernetes Storage Class. See [here](../../scheduling-backups-and-snapshots) for details.

> **Notice**
>
> The lifecycle of Longhorn backups within the backup store is managed by Longhorn. Any retention policy on the backup store is prohibited.
This page covers the following topics:

- [Set up AWS S3 Backupstore](#set-up-aws-s3-backupstore)
Expand Down
2 changes: 1 addition & 1 deletion content/docs/1.6.4/deploy/important-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ versions.

Longhorn may unintentionally delete backup-related custom resources (such as `BackupVolume`, `BackupBackingImage`, `SystemBackup`, and `Backup`) and backup data on the remote backup server before Longhorn v{{< current-version >}} in the following scenarios:

- An empty response from the NFS server due to a brief server downtime.
- An empty response from the NFS server due to server downtime.
- A race condition could delete the remote backup volume and its corresponding backups when the backup target is reset within a short period.

Starting with v{{< current-version >}}, Longhorn handles backup-related custom resources in the following manner:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,17 @@ If you don't have access to AWS S3 or want to give the backupstore a try first,

Longhorn also supports setting up recurring snapshot/backup jobs for volumes, via Longhorn UI or Kubernetes Storage Class. See [here](../../scheduling-backups-and-snapshots) for details.

> Note:
> Longhorn will attempt to clean up the backup-related custom resources in the following scenarios:
> **Notice**
>
> - The lifecycle of Longhorn backups within the backup store is entirely managed by Longhorn. **Any retention policy directly on the backup store is strictly prohibited**.
>
> - An empty response from the NFS server due to a brief server downtime.
> - A race condition between related Longhorn backup controllers.
>
> The backup information will be resynchronized during the next polling interval. For more information, see [#9530](https://github.com/longhorn/longhorn/issues/9530).
> - Longhorn attempts to clean up the backup-related custom resources in the following scenarios:
> - An empty response from the NFS server due to server downtime.
> - A race condition between related Longhorn backup controllers.
>
> The backup information is resynchronized during the next polling interval. For more information, see [#9530](https://github.com/longhorn/longhorn/issues/9530).


This page covers the following topics:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ If you don't have access to AWS S3 or want to give the backupstore a try first,

Longhorn also supports setting up recurring snapshot/backup jobs for volumes, via Longhorn UI or Kubernetes Storage Class. See [here](../../scheduling-backups-and-snapshots) for details.

> **Notice**
>
> The lifecycle of Longhorn backups within the backup store is managed by Longhorn. Any retention policy on the backup store is prohibited.
This page covers the following topics:

- [Set up AWS S3 Backupstore](#set-up-aws-s3-backupstore)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ If you don't have access to AWS S3 or want to give the backupstore a try first,

Longhorn also supports setting up recurring snapshot/backup jobs for volumes, via Longhorn UI or Kubernetes Storage Class. See [here](../../scheduling-backups-and-snapshots) for details.

> **Notice**
>
> The lifecycle of Longhorn backups within the backup store is managed by Longhorn. Any retention policy on the backup store is prohibited.
This page covers the following topics:

- [Set up AWS S3 Backupstore](#set-up-aws-s3-backupstore)
Expand Down
2 changes: 1 addition & 1 deletion content/docs/1.7.2/important-notes/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ For more information, see [Issue #8184](https://github.com/longhorn/longhorn/iss

Longhorn may unintentionally delete backup-related custom resources (such as `BackupVolume`, `BackupBackingImage`, `SystemBackup`, and `Backup`) and backup data on the remote backup server before Longhorn v{{< current-version >}} in the following scenarios:

- An empty response from the NFS server due to a brief server downtime.
- An empty response from the NFS server due to server downtime.
- A race condition could delete the remote backup volume and its corresponding backups when the backup target is reset within a short period.

Starting with v{{< current-version >}}, Longhorn handles backup-related custom resources in the following manner:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,15 @@ If you don't have access to AWS S3 or want to give the backupstore a try first,

Longhorn also supports setting up recurring snapshot/backup jobs for volumes, via Longhorn UI or Kubernetes Storage Class. See [here](../../scheduling-backups-and-snapshots) for details.

> Note:
> Longhorn will attempt to clean up the backup-related custom resources in the following scenarios:
> **Notice**
>
> - The lifecycle of Longhorn backups within the backup store is entirely managed by Longhorn. **Any retention policy directly on the backup store is strictly prohibited**.
>
> - An empty response from the NFS server due to a brief server downtime.
> - A race condition between related Longhorn backup controllers.
>
> The backup information will be resynchronized during the next polling interval. For more information, see [#9530](https://github.com/longhorn/longhorn/issues/9530).
> - Longhorn attempts to clean up the backup-related custom resources in the following scenarios:
> - An empty response from the NFS server due to server downtime.
> - A race condition between related Longhorn backup controllers.
>
> The backup information is resynchronized during the next polling interval. For more information, see [#9530](https://github.com/longhorn/longhorn/issues/9530).
This page covers the following topics:

Expand Down
2 changes: 1 addition & 1 deletion content/docs/1.7.3/important-notes/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ For more information, see [Issue #8184](https://github.com/longhorn/longhorn/iss

Longhorn may unintentionally delete backup-related custom resources (such as `BackupVolume`, `BackupBackingImage`, `SystemBackup`, and `Backup`) and backup data on the remote backup server before Longhorn v{{< current-version >}} in the following scenarios:

- An empty response from the NFS server due to a brief server downtime.
- An empty response from the NFS server due to server downtime.
- A race condition could delete the remote backup volume and its corresponding backups when the backup target is reset within a short period.

Starting with v{{< current-version >}}, Longhorn handles backup-related custom resources in the following manner:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,15 @@ If you don't have access to AWS S3 or want to give the backupstore a try first,

Longhorn also supports setting up recurring snapshot/backup jobs for volumes, via Longhorn UI or Kubernetes Storage Class. See [here](../../scheduling-backups-and-snapshots) for details.

> Note:
> Longhorn will attempt to clean up the backup-related custom resources in the following scenarios:
> **Notice**
>
> - The lifecycle of Longhorn backups within the backup store is entirely managed by Longhorn. **Any retention policy directly on the backup store is strictly prohibited**.
>
> - An empty response from the NFS server due to a brief server downtime.
> - A race condition between related Longhorn backup controllers.
>
> The backup information will be resynchronized during the next polling interval. For more information, see [#9530](https://github.com/longhorn/longhorn/issues/9530).
> - Longhorn attempts to clean up the backup-related custom resources in the following scenarios:
> - An empty response from the NFS server due to server downtime.
> - A race condition between related Longhorn backup controllers.
>
> The backup information is resynchronized during the next polling interval. For more information, see [#9530](https://github.com/longhorn/longhorn/issues/9530).
This page covers the following topics:

Expand Down
7 changes: 5 additions & 2 deletions content/docs/1.8.0/important-notes/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Please see [here](https://github.com/longhorn/longhorn/releases/tag/v{{< current
- [Longhorn PVC with Block Volume Mode](#longhorn-pvc-with-block-volume-mode)
- [Container-Optimized OS Support](#container-optimized-os-support)
- [Upgrade Check Events](#upgrade-check-events)
- [Install/Upgrade with Helm Controller](#installupgrade-with-helm-controller)
- [Resilience](#resilience)
- [RWX Volumes Fast Failover](#rwx-volumes-fast-failover)
- [Timeout Configuration for Replica Rebuilding and Snapshot Cloning](#timeout-configuration-for-replica-rebuilding-and-snapshot-cloning)
Expand All @@ -30,6 +31,8 @@ Please see [here](https://github.com/longhorn/longhorn/releases/tag/v{{< current
- [Talos Linux](#talos-linux)
- [Backup](#backup)
- [Backup Data On The Remote Backup Server Might Be Deleted](#backup-data-on-the-remote-backup-server-might-be-deleted)
- [System Backup And Restore](#system-backup-and-restore)
- [Volume Backup Policy](#volume-backup-policy)
- [V2 Data Engine](#v2-data-engine)
- [Longhorn System Upgrade](#longhorn-system-upgrade)
- [Enable Both `vfio_pci` and `uio_pci_generic` Kernel Modules](#enable-both-vfio_pci-and-uio_pci_generic-kernel-modules)
Expand All @@ -40,7 +43,7 @@ Please see [here](https://github.com/longhorn/longhorn/releases/tag/v{{< current
- [Snapshot Creation Time As Shown in the UI Occasionally Changes](#snapshot-creation-time-as-shown-in-the-ui-occasionally-changes)
- [Unable To Revert a Volume to a Snapshot Created Before Longhorn v1.7.0](#unable-to-revert-a-volume-to-a-snapshot-created-before-longhorn-v170)
- [Disaster Recovery Volumes](#disaster-recovery-volumes)
- [Auto-Salvage Volumes](#auto-salvage-volumes)
- [Auto-salvage Volumes](#auto-salvage-volumes)

## Deprecation

Expand Down Expand Up @@ -219,7 +222,7 @@ Longhorn v1.8.0 and later versions support usage of V2 volumes in Talos Linux cl

Longhorn may unintentionally delete backup-related custom resources (such as `BackupVolume`, `BackupBackingImage`, `SystemBackup`, and `Backup`) and backup data on the remote backup server before Longhorn v{{< current-version >}} in the following scenarios:

- An empty response from the NFS server due to a brief server downtime.
- An empty response from the NFS server due to server downtime.
- A race condition could delete the remote backup volume and its corresponding backups when the backup target is reset within a short period.

Starting with v{{< current-version >}}, Longhorn handles backup-related custom resources in the following manner:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,15 @@ If you don't have access to AWS S3 or want to give the backupstore a try first,

Longhorn also supports setting up recurring snapshot/backup jobs for volumes, via Longhorn UI or Kubernetes Storage Class. See [here](../../scheduling-backups-and-snapshots) for details.

> Note:
> Longhorn will attempt to clean up the backup-related custom resources in the following scenarios:
> **Notice**
>
> - The lifecycle of Longhorn backups within the backup store is entirely managed by Longhorn. **Any retention policy directly on the backup store is strictly prohibited**.
>
> - An empty response from the NFS server due to a brief server downtime.
> - A race condition between related Longhorn backup controllers.
>
> The backup information will be resynchronized during the next polling interval. For more information, see [#9530](https://github.com/longhorn/longhorn/issues/9530).
> - Longhorn attempts to clean up the backup-related custom resources in the following scenarios:
> - An empty response from the NFS server due to server downtime.
> - A race condition between related Longhorn backup controllers.
>
> The backup information is resynchronized during the next polling interval. For more information, see [#9530](https://github.com/longhorn/longhorn/issues/9530).
This page covers the following topics:

Expand Down

0 comments on commit f1a3d73

Please sign in to comment.