Document changes in vitessio/vitess#13770 (#1560)

* Document changes in vitessio/vitess#13770 Signed-off-by: Matt Lord <[email protected]> * Add 17.0 updates Signed-off-by: Matt Lord <[email protected]> * Add v16 updates Signed-off-by: Matt Lord <[email protected]> --------- Signed-off-by: Matt Lord <[email protected]>
vitessio · Aug 14, 2023 · 415e9be · 415e9be
1 parent f6d4f32
commit 415e9be
Show file tree

Hide file tree

Showing 12 changed files with 22 additions and 10 deletions.
diff --git a/content/en/docs/16.0/reference/programs/vtbackup.md b/content/en/docs/16.0/reference/programs/vtbackup.md
@@ -53,6 +53,7 @@ While it is running, `vtbackup` serves debugging info and metrics on port `15500
 | --alsologtostderr | boolean | log to standard error as well as files |
 | --azblob_backup_account_key_file | string | Path to a file containing the Azure Storage account key; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_KEY will be used as the key itself (NOT a file path). |
 | --azblob_backup_account_name | string | Azure Storage Account name for backups; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_NAME will be used. |
+| --azblob_backup_buffer_size | int | The memory buffer size to use in bytes, per file or stripe, when streaming to Azure Blob Service. (default 104857600) |
 | --azblob_backup_container_name | string | Azure Blob Container Name. |
 | --azblob_backup_parallelism | int | Azure Blob operation parallelism (requires extra memory when increased). (default 1) |
 | --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/'). |

diff --git a/content/en/docs/16.0/reference/programs/vtctl/_index.md b/content/en/docs/16.0/reference/programs/vtctl/_index.md
@@ -169,6 +169,7 @@ The following global options apply to `vtctl`:
 | --alsologtostderr | | log to standard error as well as files |
 | --azblob_backup_account_key_file | string | Path to a file containing the Azure Storage account key; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_KEY will be used as the key itself (NOT a file path) |
 | --azblob_backup_account_name | string | Azure Storage Account name for backups; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_NAME will be used |
+| --azblob_backup_buffer_size | int | The memory buffer size to use in bytes, per file or stripe, when streaming to Azure Blob Service. (default 104857600) |
 | --azblob_backup_container_name | string | Azure Blob Container Name |
 | --azblob_backup_parallelism | int | Azure Blob operation parallelism (requires extra memory when increased) (default 1) |
 | --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/') |

diff --git a/content/en/docs/16.0/reference/programs/vtctld.md b/content/en/docs/16.0/reference/programs/vtctld.md
@@ -41,6 +41,7 @@ vtctld \
 | --alsologtostderr |  | log to standard error as well as files |
 | --azblob_backup_account_key_file | string | Path to a file containing the Azure Storage account key; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_KEY will be used as the key itself (NOT a file path) |
 | --azblob_backup_account_name | string | Azure Storage Account name for backups; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_NAME will be used |
+| --azblob_backup_buffer_size | int | The memory buffer size to use in bytes, per file or stripe, when streaming to Azure Blob Service. (default 104857600) |
 | --azblob_backup_container_name | string | Azure Blob Container Name |
 | --azblob_backup_parallelism | int | Azure Blob operation parallelism (requires extra memory when increased) (default 1) |
 | --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/') |

diff --git a/content/en/docs/16.0/reference/programs/vttablet.md b/content/en/docs/16.0/reference/programs/vttablet.md
@@ -57,6 +57,7 @@ The following global options apply to `vttablet`:
 | --app_pool_size                                                  | int           | Size of the connection pool for app connections (default 40)                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 | --azblob_backup_account_key_file                                 | string        | Path to a file containing the Azure Storage account key; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_KEY will be used as the key itself (NOT a file path).                                                                                                                                                                                                                                                                                                                           |
 | --azblob_backup_account_name                                     | string        | Azure Storage Account name for backups; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_NAME will be used.                                                                                                                                                                                                                                                                                                                                                                               |
+| --azblob_backup_buffer_size                                      | int           | The memory buffer size to use in bytes, per file or stripe, when streaming to Azure Blob Service. (default 104857600) |
 | --azblob_backup_container_name                                   | string        | Azure Blob Container Name.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 | --azblob_backup_parallelism                                      | int           | Azure Blob operation parallelism (requires extra memory when increased). (default 1)                                                                                                                                                                                                                                                                                                                                                                                                                       |
 | --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/').                                                                                                                                                                                                                                                                                                                                                                           |

diff --git a/content/en/docs/17.0/reference/programs/vtbackup.md b/content/en/docs/17.0/reference/programs/vtbackup.md
@@ -53,8 +53,9 @@ While it is running, `vtbackup` serves debugging info and metrics on port `15500
 | --alsologtostderr | boolean | log to standard error as well as files |
 | --azblob_backup_account_key_file | string | Path to a file containing the Azure Storage account key; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_KEY will be used as the key itself (NOT a file path). |
 | --azblob_backup_account_name | string | Azure Storage Account name for backups; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_NAME will be used. |
+| --azblob_backup_buffer_size | int | The memory buffer size to use in bytes, per file or stripe, when streaming to Azure Blob Service. (default 104857600) |
 | --azblob_backup_container_name | string | Azure Blob Container Name. |
-| --azblob_backup_parallelism | int | Azure Blob operation parallelism (requires extra memory when increased). (default 1) |
+| --azblob_backup_parallelism | int | Azure Blob operation parallelism (requires extra memory when increased -- a multiple of azblob_backup_buffer_size). (default 1) |
 | --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) |

diff --git a/content/en/docs/17.0/reference/programs/vtctl/_index.md b/content/en/docs/17.0/reference/programs/vtctl/_index.md
@@ -169,8 +169,9 @@ The following global options apply to `vtctl`:
 | --alsologtostderr | | log to standard error as well as files |
 | --azblob_backup_account_key_file | string | Path to a file containing the Azure Storage account key; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_KEY will be used as the key itself (NOT a file path) |
 | --azblob_backup_account_name | string | Azure Storage Account name for backups; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_NAME will be used |
-| --azblob_backup_container_name | string | Azure Blob Container Name |
-| --azblob_backup_parallelism | int | Azure Blob operation parallelism (requires extra memory when increased) (default 1) |
+| --azblob_backup_buffer_size | int | The memory buffer size to use in bytes, per file or stripe, when streaming to Azure Blob Service. (default 104857600) |
+| --azblob_backup_container_name | string | Azure Blob Container Name. |
+| --azblob_backup_parallelism | int | Azure Blob operation parallelism (requires extra memory when increased -- a multiple of azblob_backup_buffer_size). (default 1) |
 | --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) |

diff --git a/content/en/docs/17.0/reference/programs/vtctld.md b/content/en/docs/17.0/reference/programs/vtctld.md
@@ -41,8 +41,9 @@ vtctld \
 | --alsologtostderr |  | log to standard error as well as files |
 | --azblob_backup_account_key_file | string | Path to a file containing the Azure Storage account key; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_KEY will be used as the key itself (NOT a file path) |
 | --azblob_backup_account_name | string | Azure Storage Account name for backups; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_NAME will be used |
-| --azblob_backup_container_name | string | Azure Blob Container Name |
-| --azblob_backup_parallelism | int | Azure Blob operation parallelism (requires extra memory when increased) (default 1) |
+| --azblob_backup_buffer_size | int | The memory buffer size to use in bytes, per file or stripe, when streaming to Azure Blob Service. (default 104857600) |
+| --azblob_backup_container_name | string | Azure Blob Container Name. |
+| --azblob_backup_parallelism | int | Azure Blob operation parallelism (requires extra memory when increased -- a multiple of azblob_backup_buffer_size). (default 1) |
 | --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) |

diff --git a/content/en/docs/17.0/reference/programs/vttablet.md b/content/en/docs/17.0/reference/programs/vttablet.md
@@ -57,8 +57,9 @@ The following global options apply to `vttablet`:
 | --app_pool_size                                                  | int           | Size of the connection pool for app connections (default 40)                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 | --azblob_backup_account_key_file                                 | string        | Path to a file containing the Azure Storage account key; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_KEY will be used as the key itself (NOT a file path).                                                                                                                                                                                                                                                                                                                           |
 | --azblob_backup_account_name                                     | string        | Azure Storage Account name for backups; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_NAME will be used.                                                                                                                                                                                                                                                                                                                                                                               |
+| --azblob_backup_buffer_size                                      | int           | The memory buffer size to use in bytes, per file or stripe, when streaming to Azure Blob Service. (default 104857600) |
 | --azblob_backup_container_name                                   | string        | Azure Blob Container Name.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
-| --azblob_backup_parallelism                                      | int           | Azure Blob operation parallelism (requires extra memory when increased). (default 1)                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| --azblob_backup_parallelism                                      | int           | Azure Blob operation parallelism (requires extra memory when increased -- a multiple of azblob_backup_buffer_size). (default 1) |
 | --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)                                                                                                                                                                                                                                                                                                                                                    |

diff --git a/content/en/docs/18.0/reference/programs/vtbackup.md b/content/en/docs/18.0/reference/programs/vtbackup.md
@@ -53,8 +53,9 @@ While it is running, `vtbackup` serves debugging info and metrics on port `15500
 | --alsologtostderr | boolean | log to standard error as well as files |
 | --azblob_backup_account_key_file | string | Path to a file containing the Azure Storage account key; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_KEY will be used as the key itself (NOT a file path). |
 | --azblob_backup_account_name | string | Azure Storage Account name for backups; if this flag is unset, the environment variable VT_AZBLOB_ACCOUNT_NAME will be used. |
+| --azblob_backup_buffer_size | int | The memory buffer size to use in bytes, per file or stripe, when streaming to Azure Blob Service. (default 104857600) |
 | --azblob_backup_container_name | string | Azure Blob Container Name. |
-| --azblob_backup_parallelism | int | Azure Blob operation parallelism (requires extra memory when increased). (default 1) |
+| --azblob_backup_parallelism | int | Azure Blob operation parallelism (requires extra memory when increased -- a multiple of azblob_backup_buffer_size). (default 1) |
 | --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) |