openstack/swift
Code Issues Proposed changes

sharidng: update doc to only mention auto_shard experimental

Browse Source 
There are been members of the community running sharding in production
and it's awesome. It's just the auto-sharding swift of that remains
experimental.

This patch removes the big sharding warning from the top of the
sharding overview page and better emphasises that it's the audo_shard
option that isn't ready for production use.

Change-Id: Id2c842cffad58fb6fd5e1d12619c46ffcb38f8a5
This commit is contained in:
Matthew Oliver 2021-10-19 12:53:04 +11:00
parent dbd0960aee
commit 7f5e34a405
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/overview_container_sharding.rst
View File

@ -9,9 +9,8 @@ very large container databases into a number of smaller shard containers
.. note:: .. note::
Container sharding is currently an experimental feature. It is strongly It is strongly recommended that operators gain experience of sharding
recommended that operators gain experience of sharding containers in a containers in a non-production cluster before using in production.
non-production cluster before using in production.
The sharding process involves moving all sharding container database The sharding process involves moving all sharding container database
records via the container replication engine; the time taken to complete records via the container replication engine; the time taken to complete
@ -128,13 +127,14 @@ section is shown in the `container-server.conf-sample` file.
.. note:: .. note::
The ``auto_shard`` option is currently **NOT** recommended for production
systems and should be set to ``false`` (the default value).
Several of the ``[container-sharder]`` config options are only significant Several of the ``[container-sharder]`` config options are only significant
when the ``auto_shard`` option is enabled. This option enables the when the ``auto_shard`` option is enabled. This option enables the
``container-sharder`` daemon to automatically identify containers that are ``container-sharder`` daemon to automatically identify containers that are
candidates for sharding and initiate the sharding process, instead of using candidates for sharding and initiate the sharding process, instead of using
the ``swift-manage-shard-ranges`` tool. The ``auto_shard`` option is the ``swift-manage-shard-ranges`` tool.
currently NOT recommended for production systems and shoud be set to
``false`` (the default value).
The container sharder uses an internal client and therefore requires an The container sharder uses an internal client and therefore requires an
internal client configuration file to exist. By default the internal-client internal client configuration file to exist. By default the internal-client