doc: deprecate EC plugins and techniques

We want to reduce the number of EC plugins and techniques we support
in order to focus dev and test effort on the ones that are most
useful.

We are deprecating the following plugins and techniques in Umbrella,
and dropping support for them in the V release:
* shec
* clay
* all non-reed_sol_van jerasure techniques

This commit updates the documentation to reflect these changes.

Signed-off-by: Jamie Pryde <jamiepry@uk.ibm.com>

diff --git a/doc/rados/operations/erasure-code-clay.rst b/doc/rados/operations/erasure-code-clay.rst
index 41fb746d12467706aeb8fb92a06dc3edf0d0702d..ad079dd5c79cc3ec2c0fbccf9021bb35f8bcd74b 100644 (file)
--- a/doc/rados/operations/erasure-code-clay.rst
+++ b/doc/rados/operations/erasure-code-clay.rst
@@ -2,6 +2,11 @@
 CLAY code plugin
 ================
 
+.. deprecated:: Umbrella
+   
+The CLAY plugin is deprecated. Support for this plugin will be removed in
+the Vampire release.
+
 CLAY (short for coupled-layer) codes are erasure codes designed to bring about significant savings 
 in terms of network bandwidth and disk IO when a failed node/OSD/rack is being repaired. Let:
 

diff --git a/doc/rados/operations/erasure-code-jerasure.rst b/doc/rados/operations/erasure-code-jerasure.rst
index 882bdb37bd110e623823f1e13ff06f49f87a6657..f1175582123c41982370c9bc96cc478dc3355afc 100644 (file)
--- a/doc/rados/operations/erasure-code-jerasure.rst
+++ b/doc/rados/operations/erasure-code-jerasure.rst
@@ -2,6 +2,9 @@
 Jerasure erasure code plugin
 ============================
 
+Note: Techniques other than ``reed_sol_van`` are deprecated. Support for deprecated techniques will be removed in
+the Vampire release.
+
 The *jerasure* plugin is a generic and flexible plugin. However,
 the *jerasure* library is no longer maintained and has not been
 updated to support modern CPU instructions that can improve

diff --git a/doc/rados/operations/erasure-code-profile.rst b/doc/rados/operations/erasure-code-profile.rst
index 51407b633cc14210008b663e033e15faf68a2036..aad76c0a81a339befd03e4d3b8b5067ea1bad315 100644 (file)
--- a/doc/rados/operations/erasure-code-profile.rst
+++ b/doc/rados/operations/erasure-code-profile.rst
@@ -25,6 +25,11 @@ same size as the data chunk, i.e. 1MB). The raw space overhead is only
 40% and the object will not be lost even if four OSDs break at the
 same time.
 
+.. warning:: In the Umbrella release, the SHEC and CLAY plugins are deprecated.
+   All Jerasure techniques, other than the default ``reed_sol_van`` technique,
+   are also deprecated. Support for these deprecated plugins and techniques
+   will be removed in the Vampire release.
+
 .. _list of available plugins:
 
 .. toctree::

diff --git a/doc/rados/operations/erasure-code-shec.rst b/doc/rados/operations/erasure-code-shec.rst
index cab4e567560dc38c7238f1da28e521bb9a147165..c4a5f96649ad9bab0a753858bf893cf3ba213953 100644 (file)
--- a/doc/rados/operations/erasure-code-shec.rst
+++ b/doc/rados/operations/erasure-code-shec.rst
@@ -2,6 +2,11 @@
 SHEC erasure code plugin
 ========================
 
+.. deprecated:: Umbrella
+   
+The SHEC plugin is deprecated. Support for this plugin will be removed in
+the Vampire release.
+
 The *shec* plugin encapsulates the `multiple SHEC
 <http://tracker.ceph.com/projects/ceph/wiki/Shingled_Erasure_Code_(SHEC)>`_
 library. It allows Ceph to recover data more efficiently than Reed-Solomon codes.

diff --git a/doc/rados/operations/health-checks.rst b/doc/rados/operations/health-checks.rst
index 78e913a613344e6c9780b9d05fbc600bc9fd1637..25f8a82bbc1b66d2c168637b9d7377c8797b3f44 100644 (file)
--- a/doc/rados/operations/health-checks.rst
+++ b/doc/rados/operations/health-checks.rst
@@ -2042,4 +2042,17 @@ Then, to check the ``w`` value for a particular profile, run a command of the fo
    ceph osd erasure-code-profile get <name of profile>
 
 The intended solution is to create a new pool with a correct ``w`` value and copy all the objects.
-Then delete the old pool before the data corruption can happen.
\ No newline at end of file
+Then delete the old pool before the data corruption can happen.
+
+DEPRECATED_EC_PLUGIN
+____________________
+
+One or more erasure code profiles are using deprecated plugins or techniques.
+The SHEC and CLAY plugins, as well as Jerasure techniques other than
+``reed_sol_van``, are deprecated as of the Umbrella release and will be
+removed in the Vampire release.
+
+To resolve this warning, migrate data from pools using deprecated erasure code
+configurations to new pools that use supported configurations. See
+:ref:`erasure-code-profiles` for details on supported erasure code plugins
+and techniques.
\ No newline at end of file