Add note about prior descriptors

davidkyle · Sep 20, 2024 · 2bfaa59 · 2bfaa59
1 parent b977a33
commit 2bfaa59
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/server/src/main/java/org/elasticsearch/indices/SystemIndexDescriptor.java b/server/src/main/java/org/elasticsearch/indices/SystemIndexDescriptor.java
@@ -93,6 +93,9 @@
  *
  * <p>The mappings for managed system indices are automatically upgraded when all nodes in the cluster are compatible with the
  * descriptor's mappings. See {@link SystemIndexMappingUpdateService} for details.
+ * When the mappings change add the previous index descriptors with
+ * {@link SystemIndexDescriptor.Builder#setPriorSystemIndexDescriptors(List)}. In a mixed cluster setting this enables auto creation
+ * of the index with compatible mappings.
  *
  * <p>We hope to remove the currently deprecated forms of access to system indices in a future release. A newly added system index with
  * no backwards-compatibility requirements may opt into our desired behavior by setting isNetNew to true. A "net new system index"