mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-12-15 00:13:30 +01:00
docs vmbackupmanager update flags
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
This commit is contained in:
parent
12cf2d8b44
commit
5815ea4160
@ -324,14 +324,14 @@ If restore mark doesn't exist at `storageDataPath`(restore wasn't requested) `vm
|
|||||||
[{"name":"daily/2023-04-07","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:07+00:00"},{"name":"hourly/2023-04-07:11","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:06+00:00"},{"name":"latest","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:04+00:00"},{"name":"monthly/2023-04","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:10+00:00"},{"name":"weekly/2023-14","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:09+00:00"}]
|
[{"name":"daily/2023-04-07","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:07+00:00"},{"name":"hourly/2023-04-07:11","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:06+00:00"},{"name":"latest","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:04+00:00"},{"name":"monthly/2023-04","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:10+00:00"},{"name":"weekly/2023-14","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:09+00:00"}]
|
||||||
```
|
```
|
||||||
1. Run `vmbackupmanager restore create` to create restore mark:
|
1. Run `vmbackupmanager restore create` to create restore mark:
|
||||||
- Use relative path to backup to restore from currently used remote storage:
|
- Use relative path to backup to restore from currently used remote storage:
|
||||||
```sh
|
```sh
|
||||||
$ /vmbackupmanager-prod restore create daily/2023-04-07
|
$ /vmbackupmanager-prod restore create daily/2023-04-07
|
||||||
```
|
```
|
||||||
- Use full path to backup to restore from any remote storage:
|
- Use full path to backup to restore from any remote storage:
|
||||||
```sh
|
```sh
|
||||||
$ /vmbackupmanager-prod restore create azblob://test1/vmbackupmanager/daily/2023-04-07
|
$ /vmbackupmanager-prod restore create azblob://test1/vmbackupmanager/daily/2023-04-07
|
||||||
```
|
```
|
||||||
1. Stop `vmstorage` or `vmsingle` node
|
1. Stop `vmstorage` or `vmsingle` node
|
||||||
1. Run `vmbackupmanager restore` to restore backup:
|
1. Run `vmbackupmanager restore` to restore backup:
|
||||||
```sh
|
```sh
|
||||||
@ -358,14 +358,14 @@ If restore mark doesn't exist at `storageDataPath`(restore wasn't requested) `vm
|
|||||||
[{"name":"daily/2023-04-07","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:07+00:00"},{"name":"hourly/2023-04-07:11","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:06+00:00"},{"name":"latest","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:04+00:00"},{"name":"monthly/2023-04","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:10+00:00"},{"name":"weekly/2023-14","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:09+00:00"}]
|
[{"name":"daily/2023-04-07","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:07+00:00"},{"name":"hourly/2023-04-07:11","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:06+00:00"},{"name":"latest","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:04+00:00"},{"name":"monthly/2023-04","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:10+00:00"},{"name":"weekly/2023-14","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:09+00:00"}]
|
||||||
```
|
```
|
||||||
1. Use `vmbackupmanager restore create` to create restore mark:
|
1. Use `vmbackupmanager restore create` to create restore mark:
|
||||||
- Use relative path to backup to restore from currently used remote storage:
|
- Use relative path to backup to restore from currently used remote storage:
|
||||||
```sh
|
```sh
|
||||||
$ /vmbackupmanager-prod restore create daily/2023-04-07
|
$ /vmbackupmanager-prod restore create daily/2023-04-07
|
||||||
```
|
```
|
||||||
- Use full path to backup to restore from any remote storage:
|
- Use full path to backup to restore from any remote storage:
|
||||||
```sh
|
```sh
|
||||||
$ /vmbackupmanager-prod restore create azblob://test1/vmbackupmanager/daily/2023-04-07
|
$ /vmbackupmanager-prod restore create azblob://test1/vmbackupmanager/daily/2023-04-07
|
||||||
```
|
```
|
||||||
1. Restart pod
|
1. Restart pod
|
||||||
|
|
||||||
#### Restore cluster into another cluster
|
#### Restore cluster into another cluster
|
||||||
@ -416,7 +416,7 @@ command-line flags with their descriptions.
|
|||||||
|
|
||||||
The shortlist of configuration flags is the following:
|
The shortlist of configuration flags is the following:
|
||||||
|
|
||||||
```
|
```text
|
||||||
vmbackupmanager performs regular backups according to the provided configs.
|
vmbackupmanager performs regular backups according to the provided configs.
|
||||||
|
|
||||||
subcommands:
|
subcommands:
|
||||||
@ -466,7 +466,7 @@ command-line flags:
|
|||||||
-fs.disableMmap
|
-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()
|
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()
|
||||||
-http.connTimeout duration
|
-http.connTimeout duration
|
||||||
Incoming http connections are closed after the configured timeout. This may help to spread the incoming load among a cluster of services behind a load balancer. Please note that the real timeout may be bigger by up to 10% as a protection against the thundering herd problem
|
Incoming http connections are closed after the configured timeout. This may help to spread the incoming load among a cluster of services behind a load balancer. Please note that the real timeout may be bigger by up to 10% as a protection against the thundering herd problem (default 2m0s)
|
||||||
-http.disableResponseCompression
|
-http.disableResponseCompression
|
||||||
Disable compression of HTTP responses to save CPU resources. By default, compression is enabled to save network bandwidth
|
Disable compression of HTTP responses to save CPU resources. By default, compression is enabled to save network bandwidth
|
||||||
-http.header.csp default-src 'self'
|
-http.header.csp default-src 'self'
|
||||||
@ -488,10 +488,8 @@ command-line flags:
|
|||||||
Flag value can be read from the given file when using -httpAuth.password=file:///abs/path/to/file or -httpAuth.password=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -httpAuth.password=http://host/path or -httpAuth.password=https://host/path
|
Flag value can be read from the given file when using -httpAuth.password=file:///abs/path/to/file or -httpAuth.password=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -httpAuth.password=http://host/path or -httpAuth.password=https://host/path
|
||||||
-httpAuth.username string
|
-httpAuth.username string
|
||||||
Username for HTTP server's Basic Auth. The authentication is disabled if empty. See also -httpAuth.password
|
Username for HTTP server's Basic Auth. The authentication is disabled if empty. See also -httpAuth.password
|
||||||
-httpListenAddr array
|
-httpListenAddr string
|
||||||
Address to listen for incoming http requests
|
Address to listen for http connections (default ":8300")
|
||||||
Supports an array of values separated by comma or specified via multiple flags.
|
|
||||||
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
|
|
||||||
-internStringCacheExpireDuration duration
|
-internStringCacheExpireDuration duration
|
||||||
The expiry duration for caches for interned strings. See https://en.wikipedia.org/wiki/String_interning . See also -internStringMaxLen and -internStringDisableCache (default 6m0s)
|
The expiry duration for caches for interned strings. See https://en.wikipedia.org/wiki/String_interning . See also -internStringMaxLen and -internStringDisableCache (default 6m0s)
|
||||||
-internStringDisableCache
|
-internStringDisableCache
|
||||||
@ -542,14 +540,10 @@ command-line flags:
|
|||||||
-metricsAuthKey value
|
-metricsAuthKey value
|
||||||
Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings
|
Auth key for /metrics endpoint. It must be passed via authKey query arg. It overrides httpAuth.* settings
|
||||||
Flag value can be read from the given file when using -metricsAuthKey=file:///abs/path/to/file or -metricsAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -metricsAuthKey=http://host/path or -metricsAuthKey=https://host/path
|
Flag value can be read from the given file when using -metricsAuthKey=file:///abs/path/to/file or -metricsAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -metricsAuthKey=http://host/path or -metricsAuthKey=https://host/path
|
||||||
-mtls array
|
-mtls
|
||||||
Whether to require valid client certificate for https requests to the corresponding -httpListenAddr . This flag works only if -tls flag is set. See also -mtlsCAFile . This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise.html
|
Whether to require valid client certificate for https requests to -httpListenAddr . This flag works only if -tls flag is set. See also -mtlsCAFile . This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise.html
|
||||||
Supports array of values separated by comma or specified via multiple flags.
|
-mtlsCAFile string
|
||||||
Empty values are set to false.
|
Optional path to TLS Root CA for verifying client certificates when -mtls is enabled. By default the host system TLS Root CA is used for client certificate verification. This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise.html
|
||||||
-mtlsCAFile array
|
|
||||||
Optional path to TLS Root CA for verifying client certificates at the corresponding -httpListenAddr when -mtls is enabled. By default the host system TLS Root CA is used for client certificate verification. This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/enterprise.html
|
|
||||||
Supports an array of values separated by comma or specified via multiple flags.
|
|
||||||
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
|
|
||||||
-pprofAuthKey value
|
-pprofAuthKey value
|
||||||
Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides httpAuth.* settings
|
Auth key for /debug/pprof/* endpoints. It must be passed via authKey query arg. It overrides httpAuth.* settings
|
||||||
Flag value can be read from the given file when using -pprofAuthKey=file:///abs/path/to/file or -pprofAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -pprofAuthKey=http://host/path or -pprofAuthKey=https://host/path
|
Flag value can be read from the given file when using -pprofAuthKey=file:///abs/path/to/file or -pprofAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -pprofAuthKey=http://host/path or -pprofAuthKey=https://host/path
|
||||||
@ -580,28 +574,30 @@ command-line flags:
|
|||||||
VictoriaMetrics create snapshot url. When this is given a snapshot will automatically be created during backup.Example: http://victoriametrics:8428/snapshot/create
|
VictoriaMetrics create snapshot url. When this is given a snapshot will automatically be created during backup.Example: http://victoriametrics:8428/snapshot/create
|
||||||
-snapshot.deleteURL string
|
-snapshot.deleteURL string
|
||||||
VictoriaMetrics delete snapshot url. Optional. Will be generated from snapshot.createURL if not provided. All created snaphosts will be automatically deleted.Example: http://victoriametrics:8428/snapshot/delete
|
VictoriaMetrics delete snapshot url. Optional. Will be generated from snapshot.createURL if not provided. All created snaphosts will be automatically deleted.Example: http://victoriametrics:8428/snapshot/delete
|
||||||
|
-snapshot.tlsCAFile string
|
||||||
|
Optional path to TLS CA file to use for verifying connections to -snapshotCreateURL. By default, system CA is used
|
||||||
|
-snapshot.tlsCertFile string
|
||||||
|
Optional path to client-side TLS certificate file to use when connecting to -snapshotCreateURL
|
||||||
|
-snapshot.tlsInsecureSkipVerify
|
||||||
|
Whether to skip tls verification when connecting to -snapshotCreateURL
|
||||||
|
-snapshot.tlsKeyFile string
|
||||||
|
Optional path to client-side TLS certificate key to use when connecting to -snapshotCreateURL
|
||||||
|
-snapshot.tlsServerName string
|
||||||
|
Optional TLS server name to use for connections to -snapshotCreateURL. By default, the server name from -snapshotCreateURL is used
|
||||||
-storageDataPath string
|
-storageDataPath string
|
||||||
Path to VictoriaMetrics data. Must match -storageDataPath from VictoriaMetrics or vmstorage (default "victoria-metrics-data")
|
Path to VictoriaMetrics data. Must match -storageDataPath from VictoriaMetrics or vmstorage (default "victoria-metrics-data")
|
||||||
-tls array
|
-tls
|
||||||
Whether to enable TLS for incoming HTTP requests at the given -httpListenAddr (aka https). -tlsCertFile and -tlsKeyFile must be set if -tls is set. See also -mtls
|
Whether to enable TLS for incoming HTTP requests at -httpListenAddr (aka https). -tlsCertFile and -tlsKeyFile must be set if -tls is set. See also -mtls
|
||||||
Supports array of values separated by comma or specified via multiple flags.
|
-tlsCertFile string
|
||||||
Empty values are set to false.
|
Path to file with TLS certificate if -tls is set. Prefer ECDSA certs instead of RSA certs as RSA certs are slower. The provided certificate file is automatically re-read every second, so it can be dynamically updated
|
||||||
-tlsCertFile array
|
|
||||||
Path to file with TLS certificate for the corresponding -httpListenAddr if -tls is set. Prefer ECDSA certs instead of RSA certs as RSA certs are slower. The provided certificate file is automatically re-read every second, so it can be dynamically updated
|
|
||||||
Supports an array of values separated by comma or specified via multiple flags.
|
|
||||||
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
|
|
||||||
-tlsCipherSuites array
|
-tlsCipherSuites array
|
||||||
Optional list of TLS cipher suites for incoming requests over HTTPS if -tls is set. See the list of supported cipher suites at https://pkg.go.dev/crypto/tls#pkg-constants
|
Optional list of TLS cipher suites for incoming requests over HTTPS if -tls is set. See the list of supported cipher suites at https://pkg.go.dev/crypto/tls#pkg-constants
|
||||||
Supports an array of values separated by comma or specified via multiple flags.
|
Supports an array of values separated by comma or specified via multiple flags.
|
||||||
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
|
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
|
||||||
-tlsKeyFile array
|
-tlsKeyFile string
|
||||||
Path to file with TLS key for the corresponding -httpListenAddr if -tls is set. The provided key file is automatically re-read every second, so it can be dynamically updated
|
Path to file with TLS key if -tls is set. The provided key file is automatically re-read every second, so it can be dynamically updated
|
||||||
Supports an array of values separated by comma or specified via multiple flags.
|
-tlsMinVersion string
|
||||||
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
|
Optional minimum TLS version to use for incoming requests over HTTPS if -tls is set. Supported values: TLS10, TLS11, TLS12, TLS13
|
||||||
-tlsMinVersion array
|
|
||||||
Optional minimum TLS version to use for the corresponding -httpListenAddr if -tls is set. Supported values: TLS10, TLS11, TLS12, TLS13
|
|
||||||
Supports an array of values separated by comma or specified via multiple flags.
|
|
||||||
Value can contain comma inside single-quoted or double-quoted string, {}, [] and () braces.
|
|
||||||
-version
|
-version
|
||||||
Show VictoriaMetrics version
|
Show VictoriaMetrics version
|
||||||
```
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user