Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/en/docs/16.0/reference/programs/vtbackup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/16.0/reference/programs/vtctl/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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") |
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/16.0/reference/programs/vtctld.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,28 +76,21 @@ All three programs can be made aware of Backup Engine and Backup Storage using t
</ul>
</td>
</tr>
<tr>
<td><code>backup_storage_hook</code></td>
<td>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.<br>
Hooks should be located in the <code>vthook</code> subdirectory of the
<code>VTROOT</code> directory.<br>
The hook receives a <code>-operation write</code> or a
<code>-operation read</code> parameter depending on the direction
of the data processing. For instance, <code>write</code> would be for
encryption, and <code>read</code> would be for decryption.</br>
</td>
</tr>
<tr>
<td><code>backup_storage_compress</code></td>
<td>This flag controls if the backups are compressed by the Vitess code.
By default it is set to true. Use
<code>--backup_storage_compress=false</code> to disable.</br>
This is meant to be used with a <code>--backup_storage_hook</code>
hook that already compresses the data, to avoid compressing the data
twice.
</td>
</tr>
<tr>
<td><code>backup_storage_block_size</code></td>
<td>If <code>--backup_storage_compress</code> is true, <code>backup_storage_block_size</code> sets the block size in bytes to use while compressing (default is 250000).
</td>
</tr>
<tr>
<td><code>backup_storage_number_blocks</code></td>
<td>If <code>--backup_storage_compress</code> is true, <code>backup_storage_number_blocks</code> 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)
</td>
</tr>
<td><code>compression-level</code></td>
Expand Down