From 3ed6f7e3c59357fe23389d1b2aa7d29d58e60377 Mon Sep 17 00:00:00 2001 From: Simon Dew <39966290+simon-dew@users.noreply.github.com> Date: Tue, 29 Jun 2021 10:29:32 +0100 Subject: [PATCH] DOC-8560: plasma requires hole punching for compaction (#2026) * Add note on hole punching * Clarify terminology --- .../pages/services-and-indexes/indexes/storage-modes.adoc | 2 ++ .../pages/manage-settings/configure-compact-settings.adoc | 8 ++++++++ 2 files changed, 10 insertions(+) diff --git a/modules/learn/pages/services-and-indexes/indexes/storage-modes.adoc b/modules/learn/pages/services-and-indexes/indexes/storage-modes.adoc index a6246b148e..6d883459b0 100644 --- a/modules/learn/pages/services-and-indexes/indexes/storage-modes.adoc +++ b/modules/learn/pages/services-and-indexes/indexes/storage-modes.adoc @@ -51,6 +51,8 @@ The performance of standard index storage depends on overall I/O performance. In Couchbase Server Enterprise Edition, standard index-storage is supported by the _Plasma_ storage engine. In this case, compaction is handled automatically. + +However, for installations of Couchbase Server Enterprise Edition running on Linux, note that hole punching is required to enable auto-compaction of Global Secondary Indexes using standard index-storage. **** **** diff --git a/modules/manage/pages/manage-settings/configure-compact-settings.adoc b/modules/manage/pages/manage-settings/configure-compact-settings.adoc index a5b3b3e786..b1d69903de 100644 --- a/modules/manage/pages/manage-settings/configure-compact-settings.adoc +++ b/modules/manage/pages/manage-settings/configure-compact-settings.adoc @@ -16,6 +16,14 @@ Auto-compaction settings affect _on-disk_ data, and therefore do not apply to Ep Full and Cluster administrators can configure compaction settings with xref:manage:manage-settings/configure-compact-settings.adoc#configure-auto-compaction-with-the-ui[Couchbase Web Console], the Couchbase xref:manage:manage-settings/configure-compact-settings.adoc#configure-auto-compaction-with-the-cli[CLI], or the xref:manage:manage-settings/configure-compact-settings.adoc#configure-auto-compaction-with-the-rest-api[REST] API. +**** +[.edition]#{enterprise}# + +In Couchbase Server Enterprise Edition, auto-compaction does not apply to memory-optimized index storage, and there are no settings necessary for configuring the auto-compaction of Global Secondary Indexes using standard index storage. + +However, for installations of Couchbase Server Enterprise Edition running on Linux, note that hole punching is required to enable auto-compaction of Global Secondary Indexes using standard index storage. +**** + [#configure-auto-compaction-with-the-ui] == Configure Auto-Compaction with the UI