Kiu/VictoriaMetrics
Kiu/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-23 12:31:07 +01:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

docs: sync flags description for vmbackup and vmbackupmanager

Browse Source 
Sync description after changes in 83e55456e2

Remove extra text in flags description for vmbackupmanager as it breaks layout
when rendered at docs.victoriametrics.com

Signed-off-by: hagen1778 <roman@victoriametrics.com>
This commit is contained in:
hagen1778 2024-02-08 16:04:13 +01:00
parent e1926f286b
commit 2a89a9e67b
No known key found for this signature in database
GPG Key ID: 3BF75F3741CA9640
2 changed files with 20 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/vmbackup.md
View File

@ -436,6 +436,16 @@ Run `vmbackup -help` in order to see all the available options:
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 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
-snapshotName string -snapshotName string
Name for the snapshot to backup. See https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-work-with-snapshots. There is no need in setting -snapshotName if -snapshot.createURL is set Name for the snapshot to backup. See https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-work-with-snapshots. There is no need in setting -snapshotName if -snapshot.createURL is set
-snapshot.tlsInsecureSkipVerify
Optional Whether to skip tls verification when connecting to -snapshotCreateURL
-snapshot.tlsCertFile
Optional path to client-side TLS certificate file to use when connecting to -snapshotCreateURL
-snapshot.tlsKeyFile
Optional path to client-side TLS certificate key to use when connecting to -snapshotCreateURL
-snapshot.tlsCAFile
Optional path to client-side TLS CA file to use when connecting to -snapshotCreateURL
-snapshot.tlsServerName
Optional path to client-side TLS tlsServerName to use when connecting to -snapshotCreateURL
-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 -tls
@ -452,17 +462,6 @@ Run `vmbackup -help` in order to see all the available options:
Optional minimum TLS version to use for incoming requests over HTTPS if -tls is set. Supported values: TLS10, TLS11, TLS12, TLS13 Optional minimum TLS version to use for incoming requests over HTTPS if -tls is set. Supported values: TLS10, TLS11, TLS12, TLS13
-version -version
Show VictoriaMetrics version Show VictoriaMetrics version
-snapshot.tlsInsecureSkipVerify
Optional Whether to skip tls verification when connecting to -snapshotCreateURL
-snapshot.tlsCertFile
Optional path to client-side TLS certificate file to use when connecting to -snapshotCreateURL
-snapshot.tlsKeyFile
Optional path to client-side TLS certificate key to use when connecting to -snapshotCreateURL
-snapshot.tlsCAFile
Optional path to client-side TLS CA file to use when connecting to -snapshotCreateURL
-snapshot.tlsServerName
Optional path to client-side TLS tlsServerName to use when connecting to -snapshotCreateURL
``` ```
## How to build from sources ## How to build from sources

17
docs/vmbackupmanager.md
View File

@ -417,13 +417,6 @@ command-line flags with their descriptions.
The shortlist of configuration flags is the following: The shortlist of configuration flags is the following:
``` ```
vmbackupmanager performs regular backups according to the provided configs.
subcommands:
backup: provides auxiliary backup-related commands
restore: restores backup specified by restore mark if it exists
command-line flags:
-apiURL string -apiURL string
vmbackupmanager address to perform API requests (default "http://127.0.0.1:8300") vmbackupmanager address to perform API requests (default "http://127.0.0.1:8300")
-concurrency int -concurrency int
@ -570,6 +563,16 @@ 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.tlsInsecureSkipVerify
Optional Whether to skip tls verification when connecting to -snapshotCreateURL
-snapshot.tlsCertFile
Optional path to client-side TLS certificate file to use when connecting to -snapshotCreateURL
-snapshot.tlsKeyFile
Optional path to client-side TLS certificate key to use when connecting to -snapshotCreateURL
-snapshot.tlsCAFile
Optional path to client-side TLS CA file to use when connecting to -snapshotCreateURL
-snapshot.tlsServerName
Optional path to client-side TLS tlsServerName to use when connecting to -snapshotCreateURL
-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 -tls