From 2aa86313bcaf7ad0ba42e78dee8c535fa93ad669 Mon Sep 17 00:00:00 2001 From: hagen1778 Date: Thu, 8 Feb 2024 16:04:13 +0100 Subject: [PATCH] docs: sync flags description for vmbackup and vmbackupmanager Sync description after changes in 83e55456e212267e8c55151a541790bd4f820187 Remove extra text in flags description for vmbackupmanager as it breaks layout when rendered at docs.victoriametrics.com Signed-off-by: hagen1778 --- docs/vmbackup.md | 21 ++++++++++----------- docs/vmbackupmanager.md | 17 ++++++++++------- 2 files changed, 20 insertions(+), 18 deletions(-) diff --git a/docs/vmbackup.md b/docs/vmbackup.md index 0608034a85..efc71f7320 100644 --- a/docs/vmbackup.md +++ b/docs/vmbackup.md @@ -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 -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 + -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 Path to VictoriaMetrics data. Must match -storageDataPath from VictoriaMetrics or vmstorage (default "victoria-metrics-data") -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 -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 diff --git a/docs/vmbackupmanager.md b/docs/vmbackupmanager.md index 5800125b31..2e3fa9ce79 100644 --- a/docs/vmbackupmanager.md +++ b/docs/vmbackupmanager.md @@ -417,13 +417,6 @@ command-line flags with their descriptions. 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 vmbackupmanager address to perform API requests (default "http://127.0.0.1:8300") -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 -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 + -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 Path to VictoriaMetrics data. Must match -storageDataPath from VictoriaMetrics or vmstorage (default "victoria-metrics-data") -tls