Skip to content

Commit 3fd0d72

Browse files
m-ildefonsm-ildefons
committed
fix review comments
Signed-off-by: Moritz Röhrich <[email protected]>
1 parent bfe5aaf commit 3fd0d72

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

‎docs/vm/backup-restore.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -34,34 +34,34 @@ Backup support is currently limited to Longhorn V1 Data Engine volumes. Harveste
3434

3535
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`.
3636

37-
Common Parameters:
37+
The following table outlines the parameters that are common to all backup targets.
3838

39-
| Parameter | Type | Description |
40-
| :--------------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------- |
41-
| Type | string | Choose S3 or NFS |
42-
| Refresh Interval | integer | The interval at which the backups will be synced with the backup target. If `0`, backups will only be synced iff all backup volumes are in `ready` state. |
39+
| Parameter | Type | Description |
40+
| :--------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------- |
41+
| Type | string | Type of server that stores the backups of volumes used by virtual machines. You can select either `NFS` or `S3`. |
42+
| 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. |
4343

4444
<Tabs>
4545
<TabItem value="s3" label="S3" default>
4646

47-
| Parameter | Type | Description |
48-
| :----------------- | :----- | :--------------------------------------------------------------------------------------------- |
49-
| Endpoint | string | A hostname or an IP address. It can be left empty for AWS S3. |
50-
| BucketName | string | Name of the bucket |
51-
| BucketRegion | string | Region of the bucket |
52-
| AccessKeyID | string | A user-id that uniquely identifies your account |
53-
| SecretAccessKey | string | The password to your account |
54-
| Certificate | string | Paste to use a self-signed SSL certificate of your S3 server |
55-
| VirtualHostedStyle | bool | Use virtual host style URLs of the form `bucket.example.com`; e.g., Alibaba Cloud (Aliyun) OSS |
47+
| Parameter | Type | Description |
48+
| :----------------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------- |
49+
| Endpoint | string | (Optional) Hostname or IP address of the endpoint used to access the S3 server |
50+
| BucketName | string | Name of the S3 bucket |
51+
| BucketRegion | string | AWS Region in which the S3 bucket was created |
52+
| AccessKeyID | string | First part of the access key you use to authenticate requests to AWS services (for example, AKIAIOSFODNN7EXAMPLE) |
53+
| SecretAccessKey | string | Second part of the access key you use to authenticate requests to AWS services (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY) |
54+
| Certificate | string | Paste to use a self-signed SSL certificate of your S3 server |
55+
| VirtualHostedStyle | bool | Use virtual host style URLs of the form `bucket.example.com`; e.g., Alibaba Cloud (Aliyun) OSS |
5656

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

5959
</TabItem>
6060
<TabItem value="nfs" label="NFS">
6161

62-
| Parameter | Type | Description |
63-
| :----------------- | :----- | :--------------------------------------------------------------------------------------- |
64-
| Endpoint | string | The URL of the NFS server. [More info](https://longhorn.io/docs/1.6.0/snapshots-and-backups/backup-and-restore/set-backup-target/#set-up-nfs-backupstore) |
62+
| Parameter | Type | Description |
63+
| :----------------- | :----- | :----------------------------------------------------------------------------------------------------------------------------------------- |
64+
| 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) |
6565

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

0 commit comments

Comments
 (0)