docs: add a notice prohibiting retention policies on backup targets

Longhorn 9795 Signed-off-by: Derek Su <derek.su@suse.com>
derekbit · Nov 14, 2024 · f4e03af · f4e03af
1 parent dcd7ace
commit f4e03af
Show file tree

Hide file tree

Showing 10 changed files with 58 additions and 24 deletions.
diff --git a/content/docs/1.6.0/snapshots-and-backups/backup-and-restore/set-backup-target.md b/content/docs/1.6.0/snapshots-and-backups/backup-and-restore/set-backup-target.md
@@ -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)

diff --git a/content/docs/1.6.1/snapshots-and-backups/backup-and-restore/set-backup-target.md b/content/docs/1.6.1/snapshots-and-backups/backup-and-restore/set-backup-target.md
@@ -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)

diff --git a/content/docs/1.6.2/snapshots-and-backups/backup-and-restore/set-backup-target.md b/content/docs/1.6.2/snapshots-and-backups/backup-and-restore/set-backup-target.md
@@ -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)

diff --git a/content/docs/1.6.3/snapshots-and-backups/backup-and-restore/set-backup-target.md b/content/docs/1.6.3/snapshots-and-backups/backup-and-restore/set-backup-target.md
@@ -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)

diff --git a/content/docs/1.6.4/snapshots-and-backups/backup-and-restore/set-backup-target.md b/content/docs/1.6.4/snapshots-and-backups/backup-and-restore/set-backup-target.md
@@ -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 will attempt to clean up the backup-related custom resources in the following scenarios:
+>   - 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).
+
+
 
 This page covers the following topics:
 

diff --git a/content/docs/1.7.0/snapshots-and-backups/backup-and-restore/set-backup-target.md b/content/docs/1.7.0/snapshots-and-backups/backup-and-restore/set-backup-target.md
@@ -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)

diff --git a/content/docs/1.7.1/snapshots-and-backups/backup-and-restore/set-backup-target.md b/content/docs/1.7.1/snapshots-and-backups/backup-and-restore/set-backup-target.md
@@ -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)

diff --git a/content/docs/1.7.2/snapshots-and-backups/backup-and-restore/set-backup-target.md b/content/docs/1.7.2/snapshots-and-backups/backup-and-restore/set-backup-target.md
@@ -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 will attempt to clean up the backup-related custom resources in the following scenarios:
+>   - 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).
 
 This page covers the following topics:
 

diff --git a/content/docs/1.7.3/snapshots-and-backups/backup-and-restore/set-backup-target.md b/content/docs/1.7.3/snapshots-and-backups/backup-and-restore/set-backup-target.md
@@ -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 will attempt to clean up the backup-related custom resources in the following scenarios:
+>   - 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).
 
 This page covers the following topics:
 

diff --git a/content/docs/1.8.0/snapshots-and-backups/backup-and-restore/set-backup-target.md b/content/docs/1.8.0/snapshots-and-backups/backup-and-restore/set-backup-target.md
@@ -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 will attempt to clean up the backup-related custom resources in the following scenarios:
+>   - 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).
 
 This page covers the following topics: