Skip to content

docs: more specific backup target docs #816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 33 additions & 10 deletions docs/vm/backup-restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,39 @@ Backup support is currently limited to Longhorn V1 Data Engine volumes. Harveste

A backup target is an endpoint used to access a backup store in Harvester. A backup store is an NFS server or S3 compatible server that stores the backups of VM volumes. The backup target can be set at `Settings > backup-target`.

| Parameter | Type | Description |
| :----------------- | :----- | :--------------------------------------------------------------------------------------- |
| Type | string | Choose S3 or NFS |
| Endpoint | string | A hostname or an IP address. It can be left empty for AWS S3. |
| BucketName | string | Name of the bucket |
| BucketRegion | string | Region of the bucket |
| AccessKeyID | string | A user-id that uniquely identifies your account |
| SecretAccessKey | string | The password to your account |
| Certificate | string | Paste to use a self-signed SSL certificate of your S3 server |
| VirtualHostedStyle | bool | Use `VirtualHostedStyle` access only; e.g., Alibaba Cloud (Aliyun) OSS |
The following table outlines the parameters that are common to all backup targets.

| Parameter | Type | Description |
| :--------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Type | string | Type of server that stores the backups of volumes used by virtual machines. You can select either `NFS` or `S3`. |
| Refresh Interval | integer | Number of seconds that Harvester waits before syncing backups with the backupstore. When the value is `0`, backups are synced only if all backup volumes are in the `Ready` state. |

<Tabs>
<TabItem value="s3" label="S3" default>

| Parameter | Type | Description |
| :----------------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------- |
| Endpoint | string | (Optional) Hostname or IP address of the endpoint used to access the S3 server |
| BucketName | string | Name of the S3 bucket |
| BucketRegion | string | AWS Region in which the S3 bucket was created |
| AccessKeyID | string | First part of the access key you use to authenticate requests to AWS services (for example, AKIAIOSFODNN7EXAMPLE) |
| SecretAccessKey | string | Second part of the access key you use to authenticate requests to AWS services (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY) |
| Certificate | string | Paste to use a self-signed SSL certificate of your S3 server |
| VirtualHostedStyle | bool | Use virtual host style URLs of the form `bucket.example.com`; e.g., Alibaba Cloud (Aliyun) OSS |

![backuptarget-s3.png](/img/backuptarget-s3.png)

</TabItem>
<TabItem value="nfs" label="NFS">

| Parameter | Type | Description |
| :----------------- | :----- | :----------------------------------------------------------------------------------------------------------------------------------------- |
| Endpoint | string | URL of the [NFS server](https://longhorn.io/docs/1.8.0/snapshots-and-backups/backup-and-restore/set-backup-target/#set-up-nfs-backupstore) |

![backuptarget-nfs.png](/img/backuptarget-nfs.png)

</TabItem>
</Tabs>

### Create a VM backup

Expand Down
Binary file added static/img/backuptarget-nfs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/backuptarget-s3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.