vmrestore restores data from backups created by vmbackup.
v1.29.0 and newer versions must be used for working with the restored data.
Restore process can be interrupted at any time. It is automatically resumed from the inerruption point
vmrestore with the same args.
VictoriaMetrics must be stopped during the restore process.
vmrestore -src=gcs://<bucket>/<path/to/backup> -storageDataPath=<local/path/to/restore>
<bucket>is GCS bucket name.
<path/to/backup>is the path to backup made with vmbackup on GCS bucket.
<local/path/to/restore>is the path to folder where data will be restored. This folder must be passed to VictoriaMetrics in
-storageDataPathcommand-line flag after the restore process is complete.
-storageDataPath directory may contain old files. They will be susbstituted by the files from backup,
i.e. the end result would be similar to rsync –delete.
vmrestoreeats all the network bandwidth, then set
-maxBytesPerSecondto the desired value.
vmrestorehas been interrupted due to temporary error, then just restart it with the same args. It will resume the restore process.
vmrestore -help in order to see all the available options:
-concurrency int The number of concurrent workers. Higher concurrency may reduce restore duration (default 10) -configFilePath string Path to file with S3 configs. Configs are loaded from default location if not set. See https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html -configProfile string Profile name for S3 configs. If no set, the value of the environment variable will be loaded (AWS_PROFILE or AWS_DEFAULT_PROFILE), or if both not set, DefaultSharedConfigProfile is used -credsFilePath string Path to file with GCS or S3 credentials. Credentials are loaded from default locations if not set. See https://cloud.google.com/iam/docs/creating-managing-service-account-keys and https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html -customS3Endpoint string Custom S3 endpoint for use with S3-compatible storages (e.g. MinIO). S3 is used if not set -envflag.enable Whether to enable reading flags from environment variables additionally to command line. Command line flag values have priority over values from environment vars. Flags are read only from command line if this flag isn't set -envflag.prefix string Prefix for environment variables if -envflag.enable is set -fs.disableMmap Whether to use pread() instead of mmap() for reading data files. By default mmap() is used for 64-bit arches and pread() is used for 32-bit arches, since they cannot read data files bigger than 2^32 bytes in memory. mmap() is usually faster for reading small data chunks than pread() -loggerErrorsPerSecondLimit int Per-second limit on the number of ERROR messages. If more than the given number of errors are emitted per second, then the remaining errors are suppressed. Zero value disables the rate limit (default 10) -loggerFormat string Format for logs. Possible values: default, json (default "default") -loggerLevel string Minimum level of errors to log. Possible values: INFO, WARN, ERROR, FATAL, PANIC (default "INFO") -loggerOutput string Output for the logs. Supported values: stderr, stdout (default "stderr") -maxBytesPerSecond value The maximum download speed. There is no limit if it is set to 0 Supports the following optional suffixes for values: KB, MB, GB, KiB, MiB, GiB (default 0) -memory.allowedBytes value Allowed size of system memory VictoriaMetrics caches may occupy. This option overrides -memory.allowedPercent if set to non-zero value. Too low value may increase cache miss rate, which usually results in higher CPU and disk IO usage. Too high value may evict too much data from OS page cache, which will result in higher disk IO usage Supports the following optional suffixes for values: KB, MB, GB, KiB, MiB, GiB (default 0) -memory.allowedPercent float Allowed percent of system memory VictoriaMetrics caches may occupy. See also -memory.allowedBytes. Too low value may increase cache miss rate, which usually results in higher CPU and disk IO usage. Too high value may evict too much data from OS page cache, which will result in higher disk IO usage (default 60) -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: gcs://bucket/path/to/backup/dir, s3://bucket/path/to/backup/dir or fs:///path/to/local/backup/dir -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") -version Show VictoriaMetrics version
How to build from sources
It is recommended using binary releases - see
vmutils-* archives there.
- Install Go. The minimum supported version is Go 1.13.
make vmrestorefrom the root folder of the repository. It builds
vmrestorebinary and puts it into the
- Install docker.
make vmrestore-prodfrom the root folder of the repository. It builds
vmrestore-prodbinary and puts it into the
Building docker images
make package-vmrestore. It builds
victoriametrics/vmrestore:<PKG_TAG> docker image locally.
<PKG_TAG> is auto-generated image tag, which depends on source code in the repository.
<PKG_TAG> may be manually set via
PKG_TAG=foobar make package-vmrestore.
By default the image is built on top of alpine image. It is possible to build the package on top of any other base image
by setting it via
<ROOT_IMAGE> environment variable. For example, the following command builds the image on top of scratch image:
ROOT_IMAGE=scratch make package-vmrestore