-
Notifications
You must be signed in to change notification settings - Fork 162
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: publish 1.7.1 doc, add 1.7.2 dev doc
Longhorn 9346 Signed-off-by: Derek Su <derek.su@suse.com>
- Loading branch information
Showing
160 changed files
with
13,944 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| --- | ||
| title: The Longhorn Documentation | ||
| description: Cloud native distributed block storage for Kubernetes | ||
| weight: 1 | ||
| --- | ||
|
|
||
| **Longhorn** is a lightweight, reliable, and powerful distributed [block storage](https://cloudacademy.com/blog/object-storage-block-storage/) system for Kubernetes. | ||
|
|
||
| Longhorn implements distributed block storage using containers and microservices. Longhorn creates a dedicated storage controller for each block device volume and synchronously replicates the volume across multiple replicas stored on multiple nodes. The storage controller and replicas are themselves orchestrated using Kubernetes. | ||
|
|
||
| ## Features | ||
|
|
||
| * Enterprise-grade distributed block storage with no single point of failure | ||
| * Incremental snapshot of block storage | ||
| * Backup to secondary storage ([NFS](https://www.extrahop.com/resources/protocols/nfs/) or [S3](https://aws.amazon.com/s3/)-compatible object storage) built on efficient change block detection | ||
| * Recurring snapshots and backups | ||
| * Automated, non-disruptive upgrades. You can upgrade the entire Longhorn software stack without disrupting running storage volumes. | ||
| * An intuitive GUI dashboard |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| --- | ||
| title: Advanced Resources | ||
| weight: 9 | ||
| --- |
4 changes: 4 additions & 0 deletions
4
content/docs/1.7.2/advanced-resources/backing-image/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| --- | ||
| title: Backing Image | ||
| weight: 7 | ||
| --- |
103 changes: 103 additions & 0 deletions
103
content/docs/1.7.2/advanced-resources/backing-image/backing-image-backup.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| --- | ||
| title: Backing Image Backup | ||
| weight: 2 | ||
| --- | ||
|
|
||
| As of v1.6.0, Longhorn supports backing up of backing images. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| You must first [set up a backup target](../../../snapshots-and-backups/backup-and-restore/set-backup-target). If you skip this crucial step, the missing backup target will prevent Longhorn from creating a backup of the backing image. | ||
|
|
||
| ## Create a Backup of a Backing Image | ||
|
|
||
| Because backing images are globally unique within the Longhorn system, the corresponding backups are also globally unique and are identified using the same name. | ||
|
|
||
| ### Create a Backup Using YAML | ||
|
|
||
| Example of backing image: | ||
| ```yaml | ||
| apiVersion: longhorn.io/v1beta2 | ||
| kind: BackingImage | ||
| metadata: | ||
| name: parrot | ||
| namespace: longhorn-system | ||
| spec: | ||
| sourceType: download | ||
| sourceParameters: | ||
| url: https://longhorn-backing-image.s3-us-west-1.amazonaws.com/parrot.raw | ||
| checksum: 304f3ed30ca6878e9056ee6f1b02b328239f0d0c2c1272840998212f9734b196371560b3b939037e4f4c2884ce457c2cbc9f0621f4f5d1ca983983c8cdf8cd9a | ||
| ``` | ||
| Example of YAML code used to create a backup of the sample backing image: | ||
| ```yaml | ||
| apiVersion: longhorn.io/v1beta2 | ||
| kind: BackupBackingImage | ||
| metadata: | ||
| name: parrot | ||
| namespace: longhorn-system | ||
| spec: | ||
| userCreated: true | ||
| labels: | ||
| usecase: test | ||
| type: raw | ||
| ``` | ||
| > **IMPORTANT:** | ||
| > - `name`: Use the same name for the backing image and its backup. If the names are not identical, Longhorn will not be able to find the backing image. | ||
| > - `userCreated`: Set the value to `true` to indicate that you created the backup custom resource, which enabled the creation of the backup in the backupstore. The value `false` indicates that the backup custom resource was synced from the backupstore. | ||
| > - `labels`: You can add labels to the backing image backup. | ||
|
|
||
| ### Create a Backup Using the Longhorn UI | ||
| 1. Go to **Setting** > **Backing Image**. | ||
| 2. Select the backing image that you want to back up, and then click **Back Up** in the **Operation** menu. | ||
|
|
||
| Longhorn creates the backup and adds the details to the **Backing Image Backup** list. The names of the backup and the source backing image are identical. | ||
|
|
||
| {{< figure src="/img/screenshots/backing-image/backup.png" >}} | ||
|
|
||
|
|
||
| ## Restore a Backing Image from a Backup | ||
| You can restore a backing image in another cluster after creating a backup in the backupstore. | ||
|
|
||
| Example of YAML code used to restore a backing image: | ||
| ```yaml | ||
| apiVersion: longhorn.io/v1beta2 | ||
| kind: BackingImage | ||
| metadata: | ||
| name: parrot-restore | ||
| namespace: longhorn-system | ||
| spec: | ||
| sourceType: restore | ||
| sourceParameters: | ||
| # change to your backup URL | ||
| # backup-url: nfs://longhorn-test-nfs-svc.default:/opt/backupstore?backingImage=parrot | ||
| backup-url: s3://backupbucket@us-east-1/?backingImage=parrot | ||
| concurrent-limit: "2" | ||
| checksum: 304f3ed30ca6878e9056ee6f1b02b328239f0d0c2c1272840998212f9734b196371560b3b939037e4f4c2884ce457c2cbc9f0621f4f5d1ca983983c8cdf8cd9a | ||
| ``` | ||
|
|
||
| > **IMPORTANT:** | ||
| > - `sourceType`: Set the value to `restore`. | ||
| > - `sourceParameters`: Configure the following parameters: | ||
| > - `backup-url`: URL of the backing image resource in the backupstore. You can find this information in the status of the backup custom resource `.Status.URL`. | ||
| > - `concurrent-limit`: Maximum number of worker threads that can concurrently run for each restore operation. When unspecified, Longhorn uses the default value. | ||
| > - `checksum`: You can specify the expected SHA-512 checksum of the backing image file, which Longhorn uses to validate the restored file. When unspecified, Longhorn uses the checksum of the restored file as the truth. | ||
|
|
||
| ### Restore from a Backup Using the Longhorn UI | ||
| 1. Go to **Setting** > **Backing Image**. | ||
| 2. Select the backup that you want to use, and then click **Restore** in the **Operation** menu. | ||
| 3. If you are restoring an encrypted backing image, specify the `Secret` and `Secret Namespace`. | ||
| 4. Click **OK**. | ||
|
|
||
| {{< figure src="/img/screenshots/backing-image/restore.png" >}} | ||
|
|
||
| > **IMPORTANT:** | ||
| > | ||
| > Longhorn currently does not store secret-related information in backing image backups. You must specify the secret and secret namespace when restoring encrypted backing images. This issue will be addressed in a future release. | ||
|
|
||
| ## Volume with a Backing Image | ||
|
|
||
| When you create a backup of a volume, Longhorn automatically creates a backup of its backing image. | ||
|
|
||
| You can restore a volume with a backing image. If the image already exists in the cluster, Longhorn uses the image directly. If the image exists in the backupstore but not in the cluster, Longhorn automatically restores the backing image. |
Oops, something went wrong.