From 600023a8f3fe35d2211d2a7fc24ac18732778aad Mon Sep 17 00:00:00 2001 From: Zakhar Bessarab Date: Mon, 12 Dec 2022 23:17:22 +0400 Subject: [PATCH] {app/{vmbackup/vmrestore}: update path example to use Azure terminology for consistency (#3475) --- app/vmbackup/README.md | 4 ++-- app/vmbackup/main.go | 2 +- app/vmrestore/README.md | 4 ++-- app/vmrestore/main.go | 2 +- docs/vmbackup.md | 4 ++-- docs/vmrestore.md | 4 ++-- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/app/vmbackup/README.md b/app/vmbackup/README.md index 7b3b4d56fb..7d62c97937 100644 --- a/app/vmbackup/README.md +++ b/app/vmbackup/README.md @@ -21,7 +21,7 @@ creation of hourly, daily, weekly and monthly backups. * [GCS](https://cloud.google.com/storage/). Example: `gs:///` * [S3](https://aws.amazon.com/s3/). Example: `s3:///` -* [Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs/). Example: `azblob:///` +* [Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs/). Example: `azblob:///` * Any S3-compatible storage such as [MinIO](https://github.com/minio/minio), [Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/) or [Swift](https://platform.swiftstack.com/docs/admin/middleware/s3_middleware.html). See [these docs](#advanced-usage) for details. * Local filesystem. Example: `fs://`. Note that `vmbackup` prevents from storing the backup into the directory pointed by `-storageDataPath` command-line flag, since this directory should be managed solely by VictoriaMetrics or `vmstorage`. @@ -187,7 +187,7 @@ See [this article](https://medium.com/@valyala/speeding-up-backups-for-big-time- -customS3Endpoint string Custom S3 endpoint for use with S3-compatible storages (e.g. MinIO). S3 is used if not set -dst string - Where to put the backup on the remote storage. Example: gs://bucket/path/to/backup, s3://bucket/path/to/backup, azblob://bucket/path/to/backup or fs:///path/to/local/backup/dir + Where to put the backup on the remote storage. Example: gs://bucket/path/to/backup, s3://bucket/path/to/backup, azblob://container/path/to/backup or fs:///path/to/local/backup/dir -dst can point to the previous backup. In this case incremental backup is performed, i.e. only changed data is uploaded -enableTCP6 Whether to enable IPv6 for listening and dialing. By default only IPv4 TCP and UDP is used diff --git a/app/vmbackup/main.go b/app/vmbackup/main.go index 001f1d6d8d..57771ca64c 100644 --- a/app/vmbackup/main.go +++ b/app/vmbackup/main.go @@ -30,7 +30,7 @@ var ( snapshotDeleteURL = flag.String("snapshot.deleteURL", "", "VictoriaMetrics delete snapshot url. Optional. Will be generated from -snapshot.createURL if not provided. "+ "All created snapshots will be automatically deleted. Example: http://victoriametrics:8428/snapshot/delete") dst = flag.String("dst", "", "Where to put the backup on the remote storage. "+ - "Example: gs://bucket/path/to/backup, s3://bucket/path/to/backup, azblob://bucket/path/to/backup or fs:///path/to/local/backup/dir\n"+ + "Example: gs://bucket/path/to/backup, s3://bucket/path/to/backup, azblob://container/path/to/backup or fs:///path/to/local/backup/dir\n"+ "-dst can point to the previous backup. In this case incremental backup is performed, i.e. only changed data is uploaded") origin = flag.String("origin", "", "Optional origin directory on the remote storage with old backup for server-side copying when performing full backup. This speeds up full backups") concurrency = flag.Int("concurrency", 10, "The number of concurrent workers. Higher concurrency may reduce backup duration") diff --git a/app/vmrestore/README.md b/app/vmrestore/README.md index 45cf532092..31bf15995f 100644 --- a/app/vmrestore/README.md +++ b/app/vmrestore/README.md @@ -19,7 +19,7 @@ Run the following command to restore backup from the given `-src` into the given `vmrestore` can restore backups from the following storage types: * [GCS](https://cloud.google.com/storage/). Example: `-src=gs:///` * [S3](https://aws.amazon.com/s3/). Example: `-src=s3:///` - * [Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs/). Example: `-src=azblob:///` + * [Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs/). Example: `-src=azblob:///` * Any S3-compatible storage such as [MinIO](https://github.com/minio/minio), [Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/) or [Swift](https://platform.swiftstack.com/docs/admin/middleware/s3_middleware.html). See [these docs](#advanced-usage) for details. * Local filesystem. Example: `-src=fs://`. Note that `vmbackup` prevents from storing the backup @@ -162,7 +162,7 @@ i.e. the end result would be similar to [rsync --delete](https://askubuntu.com/q -skipBackupCompleteCheck Whether to skip checking for 'backup complete' file in -src. This may be useful for restoring from old backups, which were created without 'backup complete' file -src string - Source path with backup on the remote storage. Example: gs://bucket/path/to/backup, s3://bucket/path/to/backup, azblob://bucket/path/to/backup or fs:///path/to/local/backup + Source path with backup on the remote storage. Example: gs://bucket/path/to/backup, s3://bucket/path/to/backup, azblob://container/path/to/backup or fs:///path/to/local/backup -storageDataPath string Destination path where backup must be restored. VictoriaMetrics must be stopped when restoring from backup. -storageDataPath dir can be non-empty. In this case the contents of -storageDataPath dir is synchronized with -src contents, i.e. it works like 'rsync --delete' (default "victoria-metrics-data") -tls diff --git a/app/vmrestore/main.go b/app/vmrestore/main.go index 08d07827ad..66f72f335d 100644 --- a/app/vmrestore/main.go +++ b/app/vmrestore/main.go @@ -20,7 +20,7 @@ import ( var ( httpListenAddr = flag.String("httpListenAddr", ":8421", "TCP address for exporting metrics at /metrics page") src = flag.String("src", "", "Source path with backup on the remote storage. "+ - "Example: gs://bucket/path/to/backup, s3://bucket/path/to/backup, azblob://bucket/path/to/backup or fs:///path/to/local/backup") + "Example: gs://bucket/path/to/backup, s3://bucket/path/to/backup, azblob://container/path/to/backup or fs:///path/to/local/backup") storageDataPath = flag.String("storageDataPath", "victoria-metrics-data", "Destination path where backup must be restored. "+ "VictoriaMetrics must be stopped when restoring from backup. -storageDataPath dir can be non-empty. In this case the contents of -storageDataPath dir "+ "is synchronized with -src contents, i.e. it works like 'rsync --delete'") diff --git a/docs/vmbackup.md b/docs/vmbackup.md index 90001a93d3..65bed947df 100644 --- a/docs/vmbackup.md +++ b/docs/vmbackup.md @@ -25,7 +25,7 @@ creation of hourly, daily, weekly and monthly backups. * [GCS](https://cloud.google.com/storage/). Example: `gs:///` * [S3](https://aws.amazon.com/s3/). Example: `s3:///` -* [Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs/). Example: `azblob:///` +* [Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs/). Example: `azblob:///` * Any S3-compatible storage such as [MinIO](https://github.com/minio/minio), [Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/) or [Swift](https://platform.swiftstack.com/docs/admin/middleware/s3_middleware.html). See [these docs](#advanced-usage) for details. * Local filesystem. Example: `fs://`. Note that `vmbackup` prevents from storing the backup into the directory pointed by `-storageDataPath` command-line flag, since this directory should be managed solely by VictoriaMetrics or `vmstorage`. @@ -191,7 +191,7 @@ See [this article](https://medium.com/@valyala/speeding-up-backups-for-big-time- -customS3Endpoint string Custom S3 endpoint for use with S3-compatible storages (e.g. MinIO). S3 is used if not set -dst string - Where to put the backup on the remote storage. Example: gs://bucket/path/to/backup, s3://bucket/path/to/backup, azblob://bucket/path/to/backup or fs:///path/to/local/backup/dir + Where to put the backup on the remote storage. Example: gs://bucket/path/to/backup, s3://bucket/path/to/backup, azblob://container/path/to/backup or fs:///path/to/local/backup/dir -dst can point to the previous backup. In this case incremental backup is performed, i.e. only changed data is uploaded -enableTCP6 Whether to enable IPv6 for listening and dialing. By default only IPv4 TCP and UDP is used diff --git a/docs/vmrestore.md b/docs/vmrestore.md index eac807e2b4..f6981c22d1 100644 --- a/docs/vmrestore.md +++ b/docs/vmrestore.md @@ -23,7 +23,7 @@ Run the following command to restore backup from the given `-src` into the given `vmrestore` can restore backups from the following storage types: * [GCS](https://cloud.google.com/storage/). Example: `-src=gs:///` * [S3](https://aws.amazon.com/s3/). Example: `-src=s3:///` - * [Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs/). Example: `-src=azblob:///` + * [Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs/). Example: `-src=azblob:///` * Any S3-compatible storage such as [MinIO](https://github.com/minio/minio), [Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/) or [Swift](https://platform.swiftstack.com/docs/admin/middleware/s3_middleware.html). See [these docs](#advanced-usage) for details. * Local filesystem. Example: `-src=fs://`. Note that `vmbackup` prevents from storing the backup @@ -166,7 +166,7 @@ i.e. the end result would be similar to [rsync --delete](https://askubuntu.com/q -skipBackupCompleteCheck Whether to skip checking for 'backup complete' file in -src. This may be useful for restoring from old backups, which were created without 'backup complete' file -src string - Source path with backup on the remote storage. Example: gs://bucket/path/to/backup, s3://bucket/path/to/backup, azblob://bucket/path/to/backup or fs:///path/to/local/backup + Source path with backup on the remote storage. Example: gs://bucket/path/to/backup, s3://bucket/path/to/backup, azblob://container/path/to/backup or fs:///path/to/local/backup -storageDataPath string Destination path where backup must be restored. VictoriaMetrics must be stopped when restoring from backup. -storageDataPath dir can be non-empty. In this case the contents of -storageDataPath dir is synchronized with -src contents, i.e. it works like 'rsync --delete' (default "victoria-metrics-data") -tls