migrations: document idempotence requirement

vbotbuildovich · Apr 11, 2024 · 33d857f · 33d857f
1 parent 7da848e
commit 33d857f
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/v/migrations/feature_migrator.h b/src/v/migrations/feature_migrator.h
@@ -43,6 +43,9 @@ class feature_migrator {
      * If not overriding `start` and `do_migrate`, then implement
      * `do_mutate` to express the change that should be made to
      * the system during upgrade.
+     *
+     * `do_mutate` should be idempotent as it may be executed multiple times if
+     * there is a leader reelection while do_mutate is being executed.
      */
     virtual ss::future<> do_mutate() { return ss::now(); }
     ss::future<> do_migrate();