summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMatthew Oliver <matt@oliver.net.au>2021-10-19 12:53:04 +1100
committerMatthew Oliver <matt@oliver.net.au>2021-10-19 12:53:04 +1100
commit7f5e34a405822773b8c1422aad4ff64b5f645d14 (patch)
treebfe9bf9e98181403cde220c60c5c14a2c01a1e2e /doc
parentdbd0960aeebedc0487699d3ca2a4d6f21e7ed524 (diff)
downloadswift-7f5e34a405822773b8c1422aad4ff64b5f645d14.tar.gz
sharidng: update doc to only mention auto_shard experimental
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
Diffstat (limited to 'doc')
-rw-r--r--doc/source/overview_container_sharding.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/source/overview_container_sharding.rst b/doc/source/overview_container_sharding.rst
index cadf99f57..b0f9ccb94 100644
--- a/doc/source/overview_container_sharding.rst
+++ b/doc/source/overview_container_sharding.rst
@@ -9,9 +9,8 @@ very large container databases into a number of smaller shard containers
.. note::
- Container sharding is currently an experimental feature. It is strongly
- recommended that operators gain experience of sharding containers in a
- non-production cluster before using in production.
+ It is strongly recommended that operators gain experience of sharding
+ containers in a non-production cluster before using in production.
The sharding process involves moving all sharding container database
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::
+ 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
when the ``auto_shard`` option is enabled. This option enables the
``container-sharder`` daemon to automatically identify containers that are
candidates for sharding and initiate the sharding process, instead of using
- the ``swift-manage-shard-ranges`` tool. The ``auto_shard`` option is
- currently NOT recommended for production systems and shoud be set to
- ``false`` (the default value).
+ the ``swift-manage-shard-ranges`` tool.
The container sharder uses an internal client and therefore requires an
internal client configuration file to exist. By default the internal-client