From ee4280d13287e4e23cc5f95c66dcf1a4ceff6e12 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Thu, 6 Jul 2023 22:57:18 -0700 Subject: [PATCH] docs/vmbackupmanager.md: update `-help` output --- app/vmbackupmanager/README.md | 17 +++++++++++++++-- docs/vmbackupmanager.md | 17 +++++++++++++++-- 2 files changed, 30 insertions(+), 4 deletions(-) diff --git a/app/vmbackupmanager/README.md b/app/vmbackupmanager/README.md index 894b143a3..2ce104e1c 100644 --- a/app/vmbackupmanager/README.md +++ b/app/vmbackupmanager/README.md @@ -452,6 +452,12 @@ command-line flags: Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password -httpListenAddr string Address to listen for http connections (default ":8300") + -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) + -internStringDisableCache + Whether to disable caches for interned strings. This may reduce memory usage at the cost of higher CPU usage. See https://en.wikipedia.org/wiki/String_interning . See also -internStringCacheExpireDuration and -internStringMaxLen + -internStringMaxLen int + The maximum length for strings to intern. Lower limit may save memory at the cost of higher CPU usage. See https://en.wikipedia.org/wiki/String_interning . See also -internStringDisableCache and -internStringCacheExpireDuration (default 500) -keepLastDaily int Keep last N daily backups. If 0 is specified next retention cycle removes all backups for given time period. (default -1) -keepLastHourly int @@ -496,13 +502,20 @@ command-line flags: Optional URL to push metrics exposed at /metrics page. See https://docs.victoriametrics.com/#push-metrics . By default, metrics exposed at /metrics page aren't pushed to any remote storage Supports an array of values separated by comma or specified via multiple flags. -runOnStart - Upload backups immediately after start of the service. Otherwise, the backup starts on new hour + Upload backups immediately after start of the service. Otherwise the backup starts on new hour + -s2a_enable_appengine_dialer + If true, opportunistically use AppEngine-specific dialer to call S2A. + -s2a_timeout duration + Timeout enforced on the connection to the S2A service for handshake. (default 3s) -s3ForcePathStyle Prefixing endpoint with bucket name when set false, true by default. (default true) + -s3StorageClass string + The Storage Class applied to objects uploaded to AWS S3. Supported values are: GLACIER, DEEP_ARCHIVE, GLACIER_IR, INTELLIGENT_TIERING, ONEZONE_IA, OUTPOSTS, REDUCED_REDUNDANCY, STANDARD, STANDARD_IA. + See https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html/ -snapshot.createURL string 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 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 snaphosts will be automatically deleted.Example: http://victoriametrics:8428/snapshot/delete -storageDataPath string Path to VictoriaMetrics data. Must match -storageDataPath from VictoriaMetrics or vmstorage (default "victoria-metrics-data") -tls diff --git a/docs/vmbackupmanager.md b/docs/vmbackupmanager.md index 937b7e34f..818f0f2c0 100644 --- a/docs/vmbackupmanager.md +++ b/docs/vmbackupmanager.md @@ -463,6 +463,12 @@ command-line flags: Username for HTTP Basic Auth. The authentication is disabled if empty. See also -httpAuth.password -httpListenAddr string Address to listen for http connections (default ":8300") + -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) + -internStringDisableCache + Whether to disable caches for interned strings. This may reduce memory usage at the cost of higher CPU usage. See https://en.wikipedia.org/wiki/String_interning . See also -internStringCacheExpireDuration and -internStringMaxLen + -internStringMaxLen int + The maximum length for strings to intern. Lower limit may save memory at the cost of higher CPU usage. See https://en.wikipedia.org/wiki/String_interning . See also -internStringDisableCache and -internStringCacheExpireDuration (default 500) -keepLastDaily int Keep last N daily backups. If 0 is specified next retention cycle removes all backups for given time period. (default -1) -keepLastHourly int @@ -507,13 +513,20 @@ command-line flags: Optional URL to push metrics exposed at /metrics page. See https://docs.victoriametrics.com/#push-metrics . By default, metrics exposed at /metrics page aren't pushed to any remote storage Supports an array of values separated by comma or specified via multiple flags. -runOnStart - Upload backups immediately after start of the service. Otherwise, the backup starts on new hour + Upload backups immediately after start of the service. Otherwise the backup starts on new hour + -s2a_enable_appengine_dialer + If true, opportunistically use AppEngine-specific dialer to call S2A. + -s2a_timeout duration + Timeout enforced on the connection to the S2A service for handshake. (default 3s) -s3ForcePathStyle Prefixing endpoint with bucket name when set false, true by default. (default true) + -s3StorageClass string + The Storage Class applied to objects uploaded to AWS S3. Supported values are: GLACIER, DEEP_ARCHIVE, GLACIER_IR, INTELLIGENT_TIERING, ONEZONE_IA, OUTPOSTS, REDUCED_REDUNDANCY, STANDARD, STANDARD_IA. + See https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html/ -snapshot.createURL string 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 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 snaphosts will be automatically deleted.Example: http://victoriametrics:8428/snapshot/delete -storageDataPath string Path to VictoriaMetrics data. Must match -storageDataPath from VictoriaMetrics or vmstorage (default "victoria-metrics-data") -tls