Skip to content

Commit da73313

Browse files
authored
Merge pull request #145 from jhkrug/1.7.0
1.7.0
2 parents 5c77faa + 7f26a9e commit da73313

11 files changed

+14
-14
lines changed

modules/en/pages/snapshots-backups/system-backups/create-system-backup.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ You can create a Longhorn system backup using the Longhorn UI. Or with the `kube
3737

3838
=== Prerequisite
3939

40-
* xref:snapshots-and-backups/backup-and-restore/set-backup-target.adoc[Set the backup target]. Longhorn saves the system backups to the remote backup store. You will see an error during creation when the backup target is unset.
40+
* xref:snapshots-backups/volume-snapshots-backups/configure-backup-target.adoc[]. Longhorn saves the system backups to the remote backup store. You will see an error during creation when the backup target is unset.
4141
+
4242
NOTE: Unsetting the backup target clears the existing `SystemBackup` custom resource. Longhorn syncs to the remote backup store after setting the backup target. Another cluster can also sync to the same list of system backups when the backup target is the same.
4343

modules/en/pages/snapshots-backups/system-backups/restore-system.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
== Longhorn System Restore Rollouts
55

6-
* Longhorn restores the resource from the xref:advanced-resources/system-backup-restore/backup-longhorn-system.adoc#_longhorn_system_backup_bundle[Longhorn System Backup Bundle].
6+
* Longhorn restores the resource from the xref:snapshots-backups/system-backups/create-system-backup.adoc#_longhorn_system_backup_bundle[Longhorn System Backup Bundle].
77
* Longhorn does not restore existing `Volumes` and their associated `PersistentVolume` and `PersistentVolumeClaim`.
88
* Longhorn automatically restores a `Volume` from its latest backup.
99
* To prevent overwriting eligible settings, Longhorn does not restore the `ConfigMap/longhorn-default-setting`.
@@ -25,7 +25,7 @@ You can restore the Longhorn system using Longhorn UI. Or with the `kubectl` com
2525
* Set up the `Nodes` and disk tags for `StorageClass`.
2626
* Have a Longhorn system backup.
2727
+
28-
See xref:advanced-resources/system-backup-restore/backup-longhorn-system.adoc#_create_longhorn_system_backup[Backup Longhorn System - Create Longhorn System Backup] for instructions.
28+
See xref:snapshots-backups/system-backups/create-system-backup.adoc#_create_longhorn_system_backup[Backup Longhorn System - Create Longhorn System Backup] for instructions.
2929

3030
* All existing `Volumes` are detached.
3131

modules/en/pages/snapshots-backups/system-backups/restore-to-cluster-using-rancher-snapshot.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This doc describes what users need to do after restoring the cluster with a Ranc
2727
* If the following happens after the snapshot and before the cluster restore:
2828
** A volume is unchanged: Users don't need to do anything.
2929
** The data is updated: Users don't need to do anything typically. Longhorn will automatically fail the replicas that don't contain the latest data.
30-
** A new volume is created: This volume will disappear after the restore. Users need to recreate a new volume, launch xref:advanced-resources/data-recovery/export-from-replica.adoc[a single replica volume] based on the replica of the disappeared volume, then transfer the data to the new volume.
30+
** A new volume is created: This volume will disappear after the restore. Users need to recreate a new volume, launch xref:data-integrity-recovery/data-recovery/retrieve-volume-data-from-replica.adoc[a single replica volume] based on the replica of the disappeared volume, then transfer the data to the new volume.
3131
** A volume is deleted: Since the data is cleaned up when the volume is removed, the restored volume contains no data. Users may need to re-delete it.
3232
** For DR volumes: Users don't need to do anything. Longhorn will redo a full restore.
3333
** Some operations are applied for a volume:
@@ -36,7 +36,7 @@ This doc describes what users need to do after restoring the cluster with a Ranc
3636
*** Replica rebuilding & replica removal:
3737
**** If there are new replicas rebuilt, those replicas will disappear from the Longhorn system after the restoring. Users need to clean up the replica data manually, or use the data directories of these replicas to export a single replica volume then do data recovery if necessary.
3838
**** If there are some failed/removed replicas and there is at least one replica keeping healthy, those failed/removed replicas will be back after the restoration. Then Longhorn can detect these restored replicas do not contain any data, and copy the latest data from the healthy replica to these replicas.
39-
**** If all replicas are replaced by new replicas after the snapshot, the volume will contain invalid replicas only after the restore. Then users need to export xref:advanced-resources/data-recovery/export-from-replica.adoc[a single replica volume] for the data recovery.
39+
**** If all replicas are replaced by new replicas after the snapshot, the volume will contain invalid replicas only after the restore. Then users need to export xref:data-integrity-recovery/data-recovery/retrieve-volume-data-from-replica.adoc[a single replica volume] for the data recovery.
4040
*** Engine image upgrade: Users need to redo the upgrade.
4141
*** Expansion: The spec size of the volume will be smaller than the current size. This is like someone requesting volume shrinking but actually Longhorn will refuse to handle it internally. To recover the volume, users need to scale down the workloads and re-do the expansion.
4242
** *Notice*: If users don't know how to recover a problematic volume, the simplest way is always restoring a new volume from backup.

modules/en/pages/snapshots-backups/volume-snapshots-backups/create-recurring-backup-snapshot-job.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ You can configure,
1414
* The number of jobs to run concurrently
1515
* Any labels that should be applied to the backup or snapshot
1616
* Parameters that should be applied to the backup
17-
** `full-backup-interval`: Number of incremental backups that must be completed before Longhorn performs a full backup. This integer parameter is applied only to the backup. Notice that if the value is 0, Longhorn performs a incremental backup every time. For more information, see <<_periodic_full_backup,Periodic Full Backup>> and xref:snapshots-and-backups/backup-and-restore/create-a-backup.adoc[Create a Backup].
17+
** `full-backup-interval`: Number of incremental backups that must be completed before Longhorn performs a full backup. This integer parameter is applied only to the backup. Notice that if the value is 0, Longhorn performs a incremental backup every time. For more information, see <<_periodic_full_backup,Periodic Full Backup>> and xref:snapshots-backups/volume-snapshots-backups/create-backup.adoc[Create a Backup].
1818
1919
Recurring jobs can be set up using the Longhorn UI, `kubectl`, or by using a Longhorn `RecurringJob`.
2020

modules/en/pages/snapshots-backups/volume-snapshots-backups/sync-backup-volumes-manually.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ After creating a backup, Longhorn creates a backup volume that corresponds to th
55

66
Earlier Longhorn versions poll and update all backup volumes at a xref:longhorn-system/settings.adoc#_backupstore_poll_interval[fixed interval]. Longhorn v1.6.2 provides a way for you to manually synchronize backup volumes with the backup target.
77

8-
IMPORTANT: You must set up a xref:snapshots-and-backups/backup-and-restore/set-backup-target.adoc[backup target] and verify that a backup volume was created before attempting to synchronize. Longhorn returns an error when no backup target and backup volume exist.
8+
IMPORTANT: You must set up a xref:snapshots-backups/volume-snapshots-backups/configure-backup-target.adoc[backup target] and verify that a backup volume was created before attempting to synchronize. Longhorn returns an error when no backup target and backup volume exist.
99

1010
* Synchronize all backup volumes:
1111
.. On the Longhorn UI, go to *Backup*.

modules/en/pages/snapshots-backups/volume-snapshots-backups/volume-snapshots-backups.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Since v1.2.0, Longhorn started using an asynchronous backup operations to resolv
1313
1414
This enhancement is scalable for the backup query to assist with resolving the costly resources caused by the blocking way. This was because all backups are saved as custom resources instead of querying from the remote target directly.
1515
16-
NOTE: After the Longhorn upgrade, if a volume has not been upgraded to the latest Longhorn engine (≥v1.2.0). When creating a backup, it will have the intermediate transition state of the name of the created backup (due to the different backup name handling in the latest longhorn version ≥ v1.2.0). Longhorn will then ensure the backup is synced with the remote backup target and the backup will be updated to the final correct state with the remote backup target is the single source of truth. To upgrade the Longhorn engine, refer to xref:snapshots-and-backups/deploy/upgrade/upgrade-engine.adoc[Manually Upgrade Longhorn Engine] or xref:upgrades/longhorn-components/auto-upgrade-engine.adoc[Automatically Upgrade Longhorn Engine].
16+
NOTE: After the Longhorn upgrade, if a volume has not been upgraded to the latest Longhorn engine (≥v1.2.0). When creating a backup, it will have the intermediate transition state of the name of the created backup (due to the different backup name handling in the latest longhorn version ≥ v1.2.0). Longhorn will then ensure the backup is synced with the remote backup target and the backup will be updated to the final correct state with the remote backup target is the single source of truth. To upgrade the Longhorn engine, refer to xref:upgrades/longhorn-components/manually-upgrade-engine.adoc[] or xref:upgrades/longhorn-components/auto-upgrade-engine.adoc[].
1717
____
1818

1919
* link:./set-backup-target[Setting a Backup Target]

modules/en/pages/upgrades/kubernetes/upgrade-k8s-on-eks.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ In Longhorn, set `replica-replenishment-wait-interval` to `0`.
55

66
See https://docs.aws.amazon.com/eks/latest/userguide/update-cluster.html[Updating a cluster] for instructions.
77

8-
NOTE: If you have created xref:advanced-resources/support-managed-k8s-service/manage-node-group-on-eks.adoc#_create_additional_volume[addition disks] for Longhorn, you will need to manually add the path of the mounted disk into the disk list of the upgraded nodes.
8+
NOTE: If you have created xref:nodes/managed-kubernetes/eks-managed-node-pools.adoc#_create_additional_volume[addition disks] for Longhorn, you will need to manually add the path of the mounted disk into the disk list of the upgraded nodes.

modules/en/pages/upgrades/longhorn-components/auto-upgrade-engine.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Longhorn automatically does an offline upgrade for detached volume.
2929

3030
. Disaster Recovery Volumes
3131
+
32-
Longhorn doesn't automatically upgrade xref:snapshots-and-backups/setup-disaster-recovery-volumes.adoc[disaster recovery volumes] to the new default engine image because it would trigger a full restoration for the disaster recovery volumes.
32+
Longhorn doesn't automatically upgrade xref:data-integrity-recovery/disaster-recovery-volumes.adoc[disaster recovery volumes] to the new default engine image because it would trigger a full restoration for the disaster recovery volumes.
3333
The full restoration might affect the performance of other running Longhorn volumes in the system.
3434
So, Longhorn leaves it to you to decide when it is the good time to manually upgrade the engine for disaster recovery volumes (e.g., when the system is idle or during the maintenance time).
3535
+

modules/en/pages/upgrades/longhorn-components/manually-upgrade-engine.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Upgrade the Longhorn manager before upgrading the Longhorn engine.
1313

1414
Follow these steps if the live upgrade is not available, or if the volume is stuck in degraded state:
1515

16-
. Follow xref:nodes-and-volumes/volumes/detaching-volumes.adoc[the detach procedure for relevant workloads].
16+
. Follow xref:data-integrity-recovery/disaster-recovery-volumes.adoc[the detach procedure for relevant workloads].
1717
. Select all the volumes using batch selection. Click the batch operation button *Upgrade Engine*, and choose the engine image available in the list. It's the default engine shipped with the manager for this release.
1818
. Resume all workloads. Any volume not part of a Kubernetes workload must be attached from the Longhorn UI.
1919

modules/en/pages/upgrades/longhorn-components/upgrade-longhorn-manager.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Engine live upgrade is supported from v1.6.x to v{current-version}.
99

1010
For airgap upgrades when Longhorn is installed as a Rancher app, you will need to modify the image names and remove the registry URL part.
1111

12-
For example, the image `registry.example.com/longhorn/longhorn-manager:v{current-version}` is changed to `longhorn/longhorn-manager:v{current-version}` in Longhorn images section. For more information, see the air gap installation steps xref:deploy/install/airgap.adoc#_using_a_rancher_app[here.]
12+
For example, the image `registry.example.com/longhorn/longhorn-manager:v{current-version}` is changed to `longhorn/longhorn-manager:v{current-version}` in Longhorn images section. For more information, see the air gap installation steps xref:installation-setup/installation/airgapped-environment.adoc#_using_a_rancher_app[here.]
1313

1414
=== Preparing for the Upgrade
1515

@@ -127,7 +127,7 @@ Then wait for all the pods to become running and Longhorn UI working. e.g.:
127127
csi-provisioner-869bdc4b79-sn6zr 1/1 Running 1 (30s ago) 43s
128128
longhorn-csi-plugin-b2zzj 2/2 Running 0 24s
129129

130-
Next, xref:deploy/upgrade/upgrade-engine.adoc[upgrade Longhorn engine.]
130+
Next, xref:upgrades/longhorn-components/manually-upgrade-engine.adoc[upgrade Longhorn engine.]
131131

132132
== Upgrading from Unsupported Versions
133133

modules/en/pages/volumes/backing-images/backing-images.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ You can prepare a backing image using four different kinds of data sources.
1717
. Download a backing image file (using a URL).
1818
. Upload a file from your local machine. This option is available to Longhorn UI users.
1919
. Export an existing in-cluster volume as a backing image.
20-
. Restore a backing image from the backupstore, For more information, see xref:snapshot-backups/backing-image-backups.adoc[Backing Image Backup].
20+
. Restore a backing image from the backupstore, For more information, see xref:snapshots-backups/backing-image-backups.adoc[Backing Image Backup].
2121
. Clone a backing image.
2222

2323
==== The checksum of a backing image

0 commit comments

Comments
 (0)