From b2c0198cb7d2afb9dd3e48207095d29b842289b9 Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Wed, 10 Aug 2016 13:26:49 +0900 Subject: [PATCH] [config-ref] update Object Storage rsyncd configurations * Split rsyncd configuration into a separate file * Add description for no help options * Delete improper configuration option tables backport: mitaka Change-Id: Idd530b1df730eca197faadb9dd61753b130be919 Partial-Bug: #1605040 --- .../source/object-storage.rst | 1 + .../source/object-storage/configure.rst | 19 ----- .../source/object-storage/rsyncd.rst | 74 +++++++++++++++++++ .../source/tables/swift-rsyncd-container.rst | 19 ----- .../source/tables/swift-rsyncd-object.rst | 21 ------ .../source/tables/swift-rsyncd-object6010.rst | 19 ----- .../source/tables/swift-rsyncd-object6020.rst | 19 ----- .../source/tables/swift-rsyncd-object6030.rst | 19 ----- .../source/tables/swift-rsyncd-object6040.rst | 19 ----- .../source/tables/swift-rsyncd-object_sda.rst | 19 ----- .../source/tables/swift-rsyncd-object_sdb.rst | 19 ----- .../source/tables/swift-rsyncd-object_sdc.rst | 21 ------ .../source/tables/swift-rsyncd.rst | 24 ++++++ 13 files changed, 99 insertions(+), 194 deletions(-) create mode 100644 doc/config-reference/source/object-storage/rsyncd.rst delete mode 100644 doc/config-reference/source/tables/swift-rsyncd-container.rst delete mode 100644 doc/config-reference/source/tables/swift-rsyncd-object.rst delete mode 100644 doc/config-reference/source/tables/swift-rsyncd-object6010.rst delete mode 100644 doc/config-reference/source/tables/swift-rsyncd-object6020.rst delete mode 100644 doc/config-reference/source/tables/swift-rsyncd-object6030.rst delete mode 100644 doc/config-reference/source/tables/swift-rsyncd-object6040.rst delete mode 100644 doc/config-reference/source/tables/swift-rsyncd-object_sda.rst delete mode 100644 doc/config-reference/source/tables/swift-rsyncd-object_sdb.rst delete mode 100644 doc/config-reference/source/tables/swift-rsyncd-object_sdc.rst create mode 100644 doc/config-reference/source/tables/swift-rsyncd.rst diff --git a/doc/config-reference/source/object-storage.rst b/doc/config-reference/source/object-storage.rst index 7ffb3f9d27..2ba7d32288 100644 --- a/doc/config-reference/source/object-storage.rst +++ b/doc/config-reference/source/object-storage.rst @@ -14,6 +14,7 @@ Object Storage service object-storage/container-reconciler.rst object-storage/account-server.rst object-storage/configure.rst + object-storage/rsyncd.rst object-storage/features.rst object-storage/configure-s3.rst object-storage/listendpoints.rst diff --git a/doc/config-reference/source/object-storage/configure.rst b/doc/config-reference/source/object-storage/configure.rst index 547571db8c..d7007cf153 100644 --- a/doc/config-reference/source/object-storage/configure.rst +++ b/doc/config-reference/source/object-storage/configure.rst @@ -49,22 +49,3 @@ Find an example memcache configuration for the proxy server at The available configuration options are: .. include:: ../tables/swift-memcache-memcache.rst - -Rsyncd configuration -~~~~~~~~~~~~~~~~~~~~ - -Find an example rsyncd configuration at ``etc/rsyncd.conf-sample`` in -the source code repository. - -The available configuration options are: - -.. include:: ../tables/swift-rsyncd-account.rst -.. include:: ../tables/swift-rsyncd-container.rst -.. include:: ../tables/swift-rsyncd-object.rst -.. include:: ../tables/swift-rsyncd-object6010.rst -.. include:: ../tables/swift-rsyncd-object6020.rst -.. include:: ../tables/swift-rsyncd-object6030.rst -.. include:: ../tables/swift-rsyncd-object6040.rst -.. include:: ../tables/swift-rsyncd-object_sda.rst -.. include:: ../tables/swift-rsyncd-object_sdb.rst -.. include:: ../tables/swift-rsyncd-object_sdc.rst diff --git a/doc/config-reference/source/object-storage/rsyncd.rst b/doc/config-reference/source/object-storage/rsyncd.rst new file mode 100644 index 0000000000..cafbe49676 --- /dev/null +++ b/doc/config-reference/source/object-storage/rsyncd.rst @@ -0,0 +1,74 @@ +==================== +Rsyncd configuration +==================== + +Find an example rsyncd configuration at ``etc/rsyncd.conf-sample`` in +the source code repository. + +The available configuration options are: + +.. include:: ../tables/swift-rsyncd.rst + +If ``rsync_module`` includes the device, you can tune rsyncd to permit 4 +connections per device instead of simply allowing 8 connections for all +devices: + +.. code-block:: ini + + rsync_module = {replication_ip}::object_{device} + +If devices in your object ring are named sda, sdb, and sdc: + +.. code-block:: ini + + [object_sda] + max connections = 4 + path = /srv/node + read only = false + lock file = /var/lock/object_sda.lock + + [object_sdb] + max connections = 4 + path = /srv/node + read only = false + lock file = /var/lock/object_sdb.lock + + [object_sdc] + max connections = 4 + path = /srv/node + read only = false + lock file = /var/lock/object_sdc.lock + +To emulate the deprecated ``vm_test_mode = yes`` option, set: + +.. code-block:: ini + + rsync_module = {replication_ip}::object{replication_port} + +Therefore, on your SAIO, you have to set the following rsyncd configuration: + +.. code-block:: ini + + [object6010] + max connections = 25 + path = /srv/1/node/ + read only = false + lock file = /var/lock/object6010.lock + + [object6020] + max connections = 25 + path = /srv/2/node/ + read only = false + lock file = /var/lock/object6020.lock + + [object6030] + max connections = 25 + path = /srv/3/node/ + read only = false + lock file = /var/lock/object6030.lock + + [object6040] + max connections = 25 + path = /srv/4/node/ + read only = false + lock file = /var/lock/object6040.lock diff --git a/doc/config-reference/source/tables/swift-rsyncd-container.rst b/doc/config-reference/source/tables/swift-rsyncd-container.rst deleted file mode 100644 index 2b70b62949..0000000000 --- a/doc/config-reference/source/tables/swift-rsyncd-container.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated and your - changes will be overwritten. The tool to do so lives in the - openstack-doc-tools repository. - -.. list-table:: Description of configuration options for ``[container]`` in ``rsyncd.conf`` - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - ``lock file`` = ``/var/lock/container.lock`` - - No help text available for this option. - * - ``max connections`` = ``4`` - - No help text available for this option. - * - ``path`` = ``/srv/node`` - - No help text available for this option. - * - ``read only`` = ``false`` - - No help text available for this option. diff --git a/doc/config-reference/source/tables/swift-rsyncd-object.rst b/doc/config-reference/source/tables/swift-rsyncd-object.rst deleted file mode 100644 index 933eb21bf2..0000000000 --- a/doc/config-reference/source/tables/swift-rsyncd-object.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated and your - changes will be overwritten. The tool to do so lives in the - openstack-doc-tools repository. - -.. list-table:: Description of configuration options for ``[object]`` in ``rsyncd.conf`` - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - ``lock file`` = ``/var/lock/object.lock`` - - No help text available for this option. - * - ``max connections`` = ``8`` - - No help text available for this option. - * - ``path`` = ``/srv/node`` - - No help text available for this option. - * - ``read only`` = ``false`` - - No help text available for this option. - * - ``rsync_module`` = ``{replication_ip}::object_{device}`` - - Format of the rsync module where the replicator will send data. The configuration value can include some variables that will be extracted from the ring. Variables must follow the format {NAME} where NAME is one of: ip, port, replication_ip, replication_port, region, zone, device, meta. See etc/rsyncd.conf-sample for some examples. uses what's set here, or what's set in the DEFAULT section, or 10 (though other sections use 3 as the final default). diff --git a/doc/config-reference/source/tables/swift-rsyncd-object6010.rst b/doc/config-reference/source/tables/swift-rsyncd-object6010.rst deleted file mode 100644 index 862dc0a83a..0000000000 --- a/doc/config-reference/source/tables/swift-rsyncd-object6010.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated and your - changes will be overwritten. The tool to do so lives in the - openstack-doc-tools repository. - -.. list-table:: Description of configuration options for ``[object6010]`` in ``rsyncd.conf`` - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - ``lock file`` = ``/var/lock/object6010.lock`` - - No help text available for this option. - * - ``max connections`` = ``25`` - - No help text available for this option. - * - ``path`` = ``/srv/1/node/`` - - No help text available for this option. - * - ``read only`` = ``false`` - - No help text available for this option. diff --git a/doc/config-reference/source/tables/swift-rsyncd-object6020.rst b/doc/config-reference/source/tables/swift-rsyncd-object6020.rst deleted file mode 100644 index 52ebbb0653..0000000000 --- a/doc/config-reference/source/tables/swift-rsyncd-object6020.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated and your - changes will be overwritten. The tool to do so lives in the - openstack-doc-tools repository. - -.. list-table:: Description of configuration options for ``[object6020]`` in ``rsyncd.conf`` - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - ``lock file`` = ``/var/lock/object6020.lock`` - - No help text available for this option. - * - ``max connections`` = ``25`` - - No help text available for this option. - * - ``path`` = ``/srv/2/node/`` - - No help text available for this option. - * - ``read only`` = ``false`` - - No help text available for this option. diff --git a/doc/config-reference/source/tables/swift-rsyncd-object6030.rst b/doc/config-reference/source/tables/swift-rsyncd-object6030.rst deleted file mode 100644 index ea29a6fd86..0000000000 --- a/doc/config-reference/source/tables/swift-rsyncd-object6030.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated and your - changes will be overwritten. The tool to do so lives in the - openstack-doc-tools repository. - -.. list-table:: Description of configuration options for ``[object6030]`` in ``rsyncd.conf`` - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - ``lock file`` = ``/var/lock/object6030.lock`` - - No help text available for this option. - * - ``max connections`` = ``25`` - - No help text available for this option. - * - ``path`` = ``/srv/3/node/`` - - No help text available for this option. - * - ``read only`` = ``false`` - - No help text available for this option. diff --git a/doc/config-reference/source/tables/swift-rsyncd-object6040.rst b/doc/config-reference/source/tables/swift-rsyncd-object6040.rst deleted file mode 100644 index 05d04610dc..0000000000 --- a/doc/config-reference/source/tables/swift-rsyncd-object6040.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated and your - changes will be overwritten. The tool to do so lives in the - openstack-doc-tools repository. - -.. list-table:: Description of configuration options for ``[object6040]`` in ``rsyncd.conf`` - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - ``lock file`` = ``/var/lock/object6040.lock`` - - No help text available for this option. - * - ``max connections`` = ``25`` - - No help text available for this option. - * - ``path`` = ``/srv/4/node/`` - - No help text available for this option. - * - ``read only`` = ``false`` - - No help text available for this option. diff --git a/doc/config-reference/source/tables/swift-rsyncd-object_sda.rst b/doc/config-reference/source/tables/swift-rsyncd-object_sda.rst deleted file mode 100644 index 76424a5c47..0000000000 --- a/doc/config-reference/source/tables/swift-rsyncd-object_sda.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated and your - changes will be overwritten. The tool to do so lives in the - openstack-doc-tools repository. - -.. list-table:: Description of configuration options for ``[object_sda]`` in ``rsyncd.conf`` - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - ``lock file`` = ``/var/lock/object_sda.lock`` - - No help text available for this option. - * - ``max connections`` = ``4`` - - No help text available for this option. - * - ``path`` = ``/srv/node`` - - No help text available for this option. - * - ``read only`` = ``false`` - - No help text available for this option. diff --git a/doc/config-reference/source/tables/swift-rsyncd-object_sdb.rst b/doc/config-reference/source/tables/swift-rsyncd-object_sdb.rst deleted file mode 100644 index 55b87749eb..0000000000 --- a/doc/config-reference/source/tables/swift-rsyncd-object_sdb.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated and your - changes will be overwritten. The tool to do so lives in the - openstack-doc-tools repository. - -.. list-table:: Description of configuration options for ``[object_sdb]`` in ``rsyncd.conf`` - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - ``lock file`` = ``/var/lock/object_sdb.lock`` - - No help text available for this option. - * - ``max connections`` = ``4`` - - No help text available for this option. - * - ``path`` = ``/srv/node`` - - No help text available for this option. - * - ``read only`` = ``false`` - - No help text available for this option. diff --git a/doc/config-reference/source/tables/swift-rsyncd-object_sdc.rst b/doc/config-reference/source/tables/swift-rsyncd-object_sdc.rst deleted file mode 100644 index af7a044de5..0000000000 --- a/doc/config-reference/source/tables/swift-rsyncd-object_sdc.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. - Warning: Do not edit this file. It is automatically generated and your - changes will be overwritten. The tool to do so lives in the - openstack-doc-tools repository. - -.. list-table:: Description of configuration options for ``[object_sdc]`` in ``rsyncd.conf`` - :header-rows: 1 - :class: config-ref-table - - * - Configuration option = Default value - - Description - * - ``lock file`` = ``/var/lock/object_sdc.lock`` - - No help text available for this option. - * - ``max connections`` = ``4`` - - No help text available for this option. - * - ``path`` = ``/srv/node`` - - No help text available for this option. - * - ``read only`` = ``false`` - - No help text available for this option. - * - ``rsync_module`` = ``{replication_ip}::object{replication_port}`` - - Format of the rsync module where the replicator will send data. The configuration value can include some variables that will be extracted from the ring. Variables must follow the format {NAME} where NAME is one of: ip, port, replication_ip, replication_port, region, zone, device, meta. See etc/rsyncd.conf-sample for some examples. uses what's set here, or what's set in the DEFAULT section, or 10 (though other sections use 3 as the final default). diff --git a/doc/config-reference/source/tables/swift-rsyncd.rst b/doc/config-reference/source/tables/swift-rsyncd.rst new file mode 100644 index 0000000000..2d8ecc95e4 --- /dev/null +++ b/doc/config-reference/source/tables/swift-rsyncd.rst @@ -0,0 +1,24 @@ +.. This table is manually created. + +.. list-table:: Description of configuration options in ``rsyncd.conf`` + :header-rows: 1 + :class: config-ref-table + + * - Configuration option = Default value + - Description + * - ``gid`` = ``swift`` + - Group ID for rsyncd. + * - ``log file`` = ``/var/log/rsyncd.log`` + - Log file for rsyncd. + * - ``pid file`` = ``/var/run/rsyncd.pid`` + - PID file for rsyncd. + * - ``uid`` = ``swift`` + - User ID for rsyncd. + * - ``max connections`` = + - Maximum number of connections for rsyncd. This option should be set for each account, container, or object. + * - ``path`` = ``/srv/node`` + - Working directory for rsyncd to use. This option should be set for each account, container, or object. + * - ``read only`` = ``false`` + - Set read only. This option should be set for each account, container, or object. + * - ``lock file`` = + - Lock file for rsyncd. This option should be set for each account, container, or object.