From 6e1f5b5e7433f9deee0bde339a9b4c659976983e Mon Sep 17 00:00:00 2001 From: ykadowak Date: Thu, 30 Nov 2023 07:38:29 +0000 Subject: [PATCH] Revert "Add index correction document (#2217)" This reverts commit d26b317fc31b66c86e7ca4581c28889b59c31058. --- docs/user-guides/index-correction.md | 39 ---------------------------- 1 file changed, 39 deletions(-) delete mode 100644 docs/user-guides/index-correction.md diff --git a/docs/user-guides/index-correction.md b/docs/user-guides/index-correction.md deleted file mode 100644 index f6759ab57f..0000000000 --- a/docs/user-guides/index-correction.md +++ /dev/null @@ -1,39 +0,0 @@ -# Index Correction - -In the Vald cluster, the same Index is replicated to multiple agents due to the `index_replica` setting. However, inconsistencies between replicas may occur due to pod eviction or the occurrence of OOM killer during vector insertions. For example, - -1. The timestamp of the index differs between agents (some agents have an old index saved and it has not been updated). -2. The number of replicas does not meet the value set in `index_replica`. - -To resolve these inconsistencies, you can use the `Index Correction` feature. - -`Index Correction` is implemented as a [`CronJob`](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/), checking the consistency between replicas regularly and resolving any inconsistencies. - -## Settings - -- enabled - Turns the index correction feature on/off. -- schedule - Sets the interval for the job start in cron notation (the default value is `3 6 * * *`, which means 3:06 AM every day). -- suspend - [Temporary suspension setting](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#schedule-suspension) for CronJob. - -```yaml -manager: - index: - corrector: - enabled: true - schedule: "3 6 * * *" - suspend: false -``` - -## Important Notes - -- Processing time - Under conditions of 10 million identical vectors(not including `index_replica`) and 10 agent replicas, the processing takes about 30~40 minutes (this is only a reference, and the actual execution time may vary depending on the infrastructure). Time complexity of the process is `O(MN)` where M is the number of identical vector items and N is the number of agent replicas. `index_replica` does not matter for the processing time. - -- concurrencyPolicy - `Forbid` is set internally, so a new job will not be created while an existing job is running. In other words, if the process does not finish within the interval specified by the schedule, the next job will not be scheduled. - -- Index operations during correction - Vector operations performed after the start of the index correction job are not considered in that job.