From 3ec9a5bd3888c06f868440d752685179ed26b36d Mon Sep 17 00:00:00 2001 From: Kirjaamo Information Date: Thu, 14 Nov 2024 15:22:04 +0200 Subject: [PATCH 1/4] Issue #507 Default value for sst_special_dirs still missing. Also, should it be marked as deprecated. --- .../documentation/xtrabackup-options.rst | 80 +++++++++---------- 1 file changed, 39 insertions(+), 41 deletions(-) diff --git a/galeracluster/source/documentation/xtrabackup-options.rst b/galeracluster/source/documentation/xtrabackup-options.rst index b0e3f3bd..245e711c 100644 --- a/galeracluster/source/documentation/xtrabackup-options.rst +++ b/galeracluster/source/documentation/xtrabackup-options.rst @@ -2,7 +2,7 @@ :title: XtraBackup-v2 Parameters :description: :language: en-US - :keywords: galera cluster, xtradb, xtrabackup, parameters + :keywords: galera cluster, xtradb, xtrabackup-v2, parameters :copyright: Codership Oy, 2014 - 2024. All Rights Reserved. @@ -54,7 +54,7 @@ XtraBackup-v2 Parameters ====================== -When using ``xtrabackup-v2`` as your :term:`State Snapshot Transfer` method, you can fine tune how the script operates using the ``[sst]`` unit in the ``my.cnf`` configuration file. +When using ``xtrabackup-v2`` as your :term:`State Snapshot Transfer` method, you can fine-tune how the script operates using the ``[sst]`` unit in the ``my.cnf`` configuration file. .. code-block:: ini @@ -71,7 +71,7 @@ When using ``xtrabackup-v2`` as your :term:`State Snapshot Transfer` method, you tcert="/path/to/cert.pem" tca="/path/to/ca.pem" -Bear in mind, some XtraBackup parameters require that you match the configuration on donor and joiner nodes, (as designated in the table below). +Bear in mind, some ``XtraBackup-v2`` parameters require that you match the configuration on donor and joiner nodes, as designated in the table below. .. csv-table:: @@ -79,23 +79,24 @@ Bear in mind, some XtraBackup parameters require that you match the configuratio :header: "Option", "Default", "Match" :widths: 30, 20, 20 - ":ref:`compressor `", "", "" - ":ref:`cpat `", "``0``", "" - ":ref:`decompressor `", "", "" + ":ref:`compressor `", "", "No" + ":ref:`compact `", "OFF", "No" + ":ref:`cpat `", "``0``", "No" + ":ref:`decompressor `", "", "No" ":ref:`encrypt `", "``0``", "Yes" - ":ref:`encrypt-algo `", "", "" - ":ref:`progress `", "", "" - ":ref:`rebuild `", "``0``", "" - ":ref:`rlimit `", "", "" - ":ref:`sst_special_dirs `", "``1``", "" - ":ref:`sockopt `", "", "" + ":ref:`encrypt-algo `", "0", "No" + ":ref:`progress `", "", "No" + ":ref:`rebuild `", "``OFF``", "No" + ":ref:`rlimit `", "", "No" + ":ref:`sockopt `", "", "No" + ":ref:`sst_special_dirs `", "``1``", "No" ":ref:`streamfmt `", "``xbstream``", "Yes" - ":ref:`tca `", "", "" - ":ref:`tcert `", "", "" - ":ref:`time `", "``0``", "" + ":ref:`tca `", "", "No" + ":ref:`tcert `", "", "No" + ":ref:`time `", "``OFF``", "No" ":ref:`transferfmt `", "``socat``", "Yes" - ":ref:`joiner_timeout `", "``60``", "" - ":ref:`donor_timeout `", "``10``", "" + ":ref:`joiner_timeout `", "``60``", "No" + ":ref:`donor_timeout `", "``10``", "No" .. _`xtra-compressor`: @@ -318,6 +319,22 @@ This parameter allows you to definite the rate-limit the donor node. This allows rlimit=300M +.. _`xtra-sockopt`: +.. rst-class:: section-heading +.. rubric:: ``sockopt`` + +Defines socket options. + +.. csv-table:: + :class: doc-options + :stub-columns: 1 + + "**System Variable**", "Name:", "``sockopt``" + "", "Match:", "No" + "**Permitted Values**", "Type:", "String" + "", "Default Value:", "" + +This parameter allows you to define one or more socket options for XtraBackup using the Socat transfer format. .. _`xtra-sst_special_dirs`: .. rst-class:: section-heading @@ -346,25 +363,6 @@ This parameter enables support for ``innodb_data_home_dir`` and ``innodb_log_hom [sst] sst_special_dirs=TRUE - -.. _`xtra-sockopt`: -.. rst-class:: section-heading -.. rubric:: ``sockopt`` - -Defines socket options. - -.. csv-table:: - :class: doc-options - :stub-columns: 1 - - "**System Variable**", "Name:", "``sockopt``" - "", "Match:", "No" - "**Permitted Values**", "Type:", "String" - "", "Default Value:", "" - -This parameter allows you to define one or more socket options for XtraBackup using the Socat transfer format. - - .. _`xtra-streamfmt`: .. rst-class:: section-heading .. rubric:: ``streamfmt`` @@ -473,7 +471,7 @@ Defines the transfer stream utility. :stub-columns: 1 "**System Variable**", "Name:", "``transferfmt``" - "", "Match:", YesNo" + "", "Match:", "Yes" "**Permitted Values**", "Type:", "String" "", "Default Value:", "``socat`` " "", "Valid Values:", "``socat``; ``nc``" @@ -491,7 +489,7 @@ The default and recommended utility is Socat, given that it allows for socket op .. rst-class:: section-heading .. rubric:: ``joiner_timeout`` -How soon joiner should timeout waiting for SST (seconds). +How soon the joiner should timeout when waiting for SST (seconds). .. csv-table:: :class: doc-options @@ -502,7 +500,7 @@ How soon joiner should timeout waiting for SST (seconds). "**Permitted Values**", "Type:", "Integer" "", "Default Value:", "``60``" -This parameter determines the initial timeout in seconds for the joiner to receive the first packet in a :term:`State Snapshot Transfer`. This keeps the joiner node from hanging in the event that the donor node crashes while starting the operation. +This parameter determines the initial timeout in seconds for the joiner to receive the first packet in a :term:`State Snapshot Transfer`. This keeps the joiner node from hanging, in the event that the donor node crashes while starting the operation. .. code-block:: ini @@ -513,7 +511,7 @@ This parameter determines the initial timeout in seconds for the joiner to recei .. rst-class:: section-heading .. rubric:: ``donor_timeout`` -How soon donor should timeout on connection to joiner (seconds). +How soon the donor should timeout on connection to joiner (seconds). .. csv-table:: :class: doc-options @@ -524,7 +522,7 @@ How soon donor should timeout on connection to joiner (seconds). "**Permitted Values**", "Type:", "Integer" "", "Default Value:", "``10``" -This parameter determines how soon the donor should timeout on connection to joiner and return to normal operation in case the joiner turns to be unresponsive. +This parameter determines how soon the donor should timeout on connection to joiner, and return to normal operation in the event that the joiner turns unresponsive. .. code-block:: ini From b9e8a0d56c60b772f0546751b3111541d333541d Mon Sep 17 00:00:00 2001 From: Kirjaamo Information Date: Thu, 14 Nov 2024 15:43:16 +0200 Subject: [PATCH 2/4] Language improvements. --- galeracluster/source/documentation/xtrabackup-options.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/galeracluster/source/documentation/xtrabackup-options.rst b/galeracluster/source/documentation/xtrabackup-options.rst index 245e711c..96e2af5c 100644 --- a/galeracluster/source/documentation/xtrabackup-options.rst +++ b/galeracluster/source/documentation/xtrabackup-options.rst @@ -239,7 +239,7 @@ Defines the SSL encryption type the node uses for XtraBackup state transfers. "**Permitted Values**", "Type:", "Integer" "", "Default Value:", "``0``" -When using the :ref:`encrypt ` parameter in both the ``[xtrabackup]`` and ``[sst]`` units, there is a potential issue in it having different meanings according to the unit under which it occurs. That is, in ``[xtrabackup]``, it turns encryption on while in ``[sst]`` it both turns it on as specifies the algorithm. +When using the :ref:`encrypt ` parameter in both the ``[xtrabackup]`` and ``[sst]`` units, there is a potential issue in it having different meanings according to the unit under which it occurs. That is, in ``[xtrabackup]``, it turns encryption on while in ``[sst]`` it both turns it on and specifies the algorithm. In the event that you need to clarify the meaning, this parameter allows you to define the encryption algorithm separately from turning encryption on. It is only read in the event that :ref:`encrypt ` is set to ``1`` @@ -313,7 +313,7 @@ Defines the rate limit for the donor node. "**Permitted Values**", "Type:", "Integer" "", "Default Value:", "" -This parameter allows you to definite the rate-limit the donor node. This allows you to keep state transfers from blocking regular cluster operations. +This parameter allows you to define the rate-limit for the donor node. This allows you to keep state transfers from blocking regular cluster operations. .. code-block:: ini @@ -379,7 +379,7 @@ Defines the stream formatting utility. "", "Default Value:", "``xbstream``" "", "Valid Values:", "``tar``; ``xbstream``" -This parameter defines the utility the node uses to archive the node state before the transfer is sent and how to unarchive the state transfers that is receives. There are two methods available: ``tar`` and ``xbstream``. Given that the receiving node needs to know how to read the stream, it is necessary that both nodes use the same values for this parameter. +This parameter defines the utility the node uses to archive the node state before the transfer is sent and how to unarchive the state transfers that it receives. There are two methods available: ``tar`` and ``xbstream``. Given that the receiving node needs to know how to read the stream, it is necessary that both nodes use the same values for this parameter. The default and recommended utility is ``xbstream`` given that it supports encryption, compression, parallel streaming, incremental backups and compaction. ``tar`` does not support these features. @@ -476,7 +476,7 @@ Defines the transfer stream utility. "", "Default Value:", "``socat`` " "", "Valid Values:", "``socat``; ``nc``" -This parameter defines the utility that the node uses to format transfers sent from donor to joiner nodes. There are two methods supported: Socat and ``nc``. Given that the receiving node needs to know how to interpret the transfer, it is necessary that both nodes use the same values for this parameter. +This parameter defines the utility that the node uses to format transfers sent from donor to joiner nodes. There are two methods supported: ``socat`` and ``nc``. Given that the receiving node needs to know how to interpret the transfer, it is necessary that both nodes use the same values for this parameter. The default and recommended utility is Socat, given that it allows for socket options, such as transfer buffer size. For more information, see the `socat Documentation `_. From 1c2e3bde7ab617660223c11f2f8d59f6cc286ae9 Mon Sep 17 00:00:00 2001 From: Kirjaamo Information Date: Fri, 15 Nov 2024 12:21:52 +0200 Subject: [PATCH 3/4] sst_special_dirs marked as deprecated. --- galeracluster/source/documentation/xtrabackup-options.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/galeracluster/source/documentation/xtrabackup-options.rst b/galeracluster/source/documentation/xtrabackup-options.rst index 96e2af5c..d8058fdc 100644 --- a/galeracluster/source/documentation/xtrabackup-options.rst +++ b/galeracluster/source/documentation/xtrabackup-options.rst @@ -349,7 +349,9 @@ Defines whether the node uses special InnoDB home and log directories. "**System Variable**", "Name:", "``sst_special_dirs``" "", "Match:", "No" "**Permitted Values**", "Type:", "Boolean" - "", "Default Value:", "``OFF``" + "", "Default Value:", "``1``" + +This parameter was deprecated in Percona XtraDB Cluster 5.7.12-5rc1-26.16. This parameter enables support for ``innodb_data_home_dir`` and ``innodb_log_home_dir`` parameters for XtraBackup. It requires that you define ``innodb_data_home_dir`` and ``innodb_log_group_home_dir`` in the ``[mysqld]`` unit. From 50e84edc91f1b0003a9ef68803e22710696e6620 Mon Sep 17 00:00:00 2001 From: Kirjaamo Information Date: Fri, 15 Nov 2024 12:23:13 +0200 Subject: [PATCH 4/4] Language improved --- galeracluster/source/documentation/xtrabackup-options.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/galeracluster/source/documentation/xtrabackup-options.rst b/galeracluster/source/documentation/xtrabackup-options.rst index d8058fdc..44487526 100644 --- a/galeracluster/source/documentation/xtrabackup-options.rst +++ b/galeracluster/source/documentation/xtrabackup-options.rst @@ -351,7 +351,7 @@ Defines whether the node uses special InnoDB home and log directories. "**Permitted Values**", "Type:", "Boolean" "", "Default Value:", "``1``" -This parameter was deprecated in Percona XtraDB Cluster 5.7.12-5rc1-26.16. +This parameter is deprecated as of Percona XtraDB Cluster 5.7.12-5rc1-26.16. This parameter enables support for ``innodb_data_home_dir`` and ``innodb_log_home_dir`` parameters for XtraBackup. It requires that you define ``innodb_data_home_dir`` and ``innodb_log_group_home_dir`` in the ``[mysqld]`` unit.