From: Jamie Pryde Date: Wed, 20 May 2026 14:53:42 +0000 (+0100) Subject: doc: deprecate EC plugins and techniques X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=ce1cbb13057367aa552e7715ceee5b495069962f;p=ceph.git 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 --- diff --git a/doc/rados/operations/erasure-code-clay.rst b/doc/rados/operations/erasure-code-clay.rst index 41fb746d124..ad079dd5c79 100644 --- 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 882bdb37bd1..f1175582123 100644 --- 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 51407b633cc..aad76c0a81a 100644 --- 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 cab4e567560..c4a5f96649a 100644 --- 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 `_ 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 78e913a6133..25f8a82bbc1 100644 --- 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 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