diff --git a/content/en/docs/16.0/reference/programs/vtbackup.md b/content/en/docs/16.0/reference/programs/vtbackup.md index 51dc7931b..5565be13b 100644 --- a/content/en/docs/16.0/reference/programs/vtbackup.md +++ b/content/en/docs/16.0/reference/programs/vtbackup.md @@ -22,7 +22,7 @@ Whatever system launches `vtbackup` is responsible for the following: ## Example Usage -The following example launches the `vtbackup`. +On a running Vitess cluster, the following command will create a backup using `vtbackup` for keyspace `commerce` and shard `0`. ```bash export TOPOLOGY_FLAGS="--topo_implementation etcd2 --topo_global_server_address localhost:2379 --topo_global_root /vitess/global" diff --git a/content/en/docs/16.0/reference/programs/vtctl/_index.md b/content/en/docs/16.0/reference/programs/vtctl/_index.md index 1c08ab429..55cf64775 100644 --- a/content/en/docs/16.0/reference/programs/vtctl/_index.md +++ b/content/en/docs/16.0/reference/programs/vtctl/_index.md @@ -174,8 +174,7 @@ The following global options apply to `vtctl`: | --azblob_backup_storage_root | string | Root prefix for all backup-related Azure Blobs; this should exclude both initial and trailing '/' (e.g. just 'a/b' not '/a/b/') | | --backup_engine_implementation | string | Specifies which implementation to use for creating new backups (builtin or xtrabackup). Restores will always be done with whichever engine created a given backup. (default "builtin") | | --backup_storage_block_size | int | if backup_storage_compress is true, backup_storage_block_size sets the byte size for each block while compressing (default is 250000). (default 250000) | -| --backup_storage_compress | | if set, the backup files will be compressed (default is true). Set to false for instance if a backup_storage_hook is specified and it compresses the data. (default true)| -| --backup_storage_hook | string | if set, we send the contents of the backup files through this hook. | +| --backup_storage_compress | | if set, the backup files will be compressed (default is true). | | --backup_storage_implementation | string | which implementation to use for the backup storage feature | | --backup_storage_number_blocks | int | if backup_storage_compress is true, backup_storage_number_blocks sets the number of blocks that can be processed, at once, before the writer blocks, during compression (default is 2). It should be equal to the number of CPUs available for compression (default 2) | | --ceph_backup_storage_config | string | Path to JSON config file for ceph backup storage (default "ceph_backup_config.json") | diff --git a/content/en/docs/16.0/reference/programs/vtctld.md b/content/en/docs/16.0/reference/programs/vtctld.md index ffba122fc..c82626d21 100644 --- a/content/en/docs/16.0/reference/programs/vtctld.md +++ b/content/en/docs/16.0/reference/programs/vtctld.md @@ -46,7 +46,7 @@ vtctld \ | --azblob_backup_storage_root | string | Root prefix for all backup-related Azure Blobs; this should exclude both initial and trailing '/' (e.g. just 'a/b' not '/a/b/') | | --backup_engine_implementation | string | Specifies which implementation to use for creating new backups (builtin or xtrabackup). Restores will always be done with whichever engine created a given backup. (default "builtin") | | --backup_storage_block_size | int | if backup_storage_compress is true, backup_storage_block_size sets the byte size for each block while compressing (default is 250000). (default 250000) | -| --backup_storage_compress | boolean | if set, the backup files will be compressed (default is true). Set to false for instance if a backup_storage_hook is specified and it compresses the data. (default true) | +| --backup_storage_compress | boolean | if set, the backup files will be compressed (default is true). | | --backup_storage_implementation | string | which implementation to use for the backup storage feature | | --backup_storage_number_blocks | int | if backup_storage_compress is true, backup_storage_number_blocks sets the number of blocks that can be processed, at once, before the writer blocks, during compression (default is 2). It should be equal to the number of CPUs available for compression (default 2) | | --builtinbackup_mysqld_timeout | duration | how long to wait for mysqld to shutdown at the start of the backup. (default 10m0s) | diff --git a/content/en/docs/16.0/user-guides/operating-vitess/backup-and-restore/overview.md b/content/en/docs/16.0/user-guides/operating-vitess/backup-and-restore/overview.md index eb0aee684..1f7e98996 100644 --- a/content/en/docs/16.0/user-guides/operating-vitess/backup-and-restore/overview.md +++ b/content/en/docs/16.0/user-guides/operating-vitess/backup-and-restore/overview.md @@ -76,28 +76,21 @@ All three programs can be made aware of Backup Engine and Backup Storage using t - - backup_storage_hook - If set, the content of every file to backup is sent to a hook. The - hook receives the data for each file on stdin. It should echo the - transformed data to stdout. Anything the hook prints to stderr will - be printed in the vttablet logs.
- Hooks should be located in the vthook subdirectory of the - VTROOT directory.
- The hook receives a -operation write or a - -operation read parameter depending on the direction - of the data processing. For instance, write would be for - encryption, and read would be for decryption.
- - backup_storage_compress This flag controls if the backups are compressed by the Vitess code. By default it is set to true. Use --backup_storage_compress=false to disable.
- This is meant to be used with a --backup_storage_hook - hook that already compresses the data, to avoid compressing the data - twice. + + + + backup_storage_block_size + If --backup_storage_compress is true, backup_storage_block_size sets the block size in bytes to use while compressing (default is 250000). + + + + backup_storage_number_blocks + If --backup_storage_compress is true, backup_storage_number_blocks sets the number of blocks that can be processed, in parallel, before the writer blocks, during compression. It should be equal to the number of CPUs available for compression. (default 2) compression-level