diff --git a/docs/reference/upgrade/close-ml.asciidoc b/docs/reference/upgrade/close-ml.asciidoc new file mode 100644 index 0000000000000..c4efddca759c9 --- /dev/null +++ b/docs/reference/upgrade/close-ml.asciidoc @@ -0,0 +1,32 @@ +[testenv="platinum"] + +If your {ml} indices were created earlier than the previous major version, they +must be reindexed. In those circumstances, there must be no machine learning +jobs running during the upgrade. + +In all other circumstances, there is no requirement to close your {ml} jobs. +There are, however, advantages to doing so. If you choose to leave your jobs +running during the upgrade, they are affected when you stop the {ml} nodes. The +jobs move to another {ml} node and restore the model states. This scenario has +the least disruption to the active {ml} jobs but incurs the highest load on the +cluster. + +To close all {ml} jobs before you upgrade, see +{stack-ov}/stopping-ml.html[Stopping {ml}]. This method persists the model +state at the moment of closure, which means that when you open your jobs after +the upgrade, they use the exact same model. This scenario takes the most time, +however, especially if you have many jobs or jobs with large model states. + +To temporarily halt the tasks associated with your {ml} jobs and {dfeeds} and +prevent new jobs from opening, use the <>: + +[source,js] +-------------------------------------------------- +POST _ml/set_upgrade_mode?enabled=true +-------------------------------------------------- +// CONSOLE + +This method does not persist the absolute latest model state, rather it uses the +last model state that was automatically saved. By halting the tasks, you avoid +incurring the cost of managing active jobs during the upgrade and it's quicker +than stopping {dfeeds} and closing jobs. \ No newline at end of file diff --git a/docs/reference/upgrade/cluster_restart.asciidoc b/docs/reference/upgrade/cluster_restart.asciidoc index 32c3e448f6c61..c05d674e46133 100644 --- a/docs/reference/upgrade/cluster_restart.asciidoc +++ b/docs/reference/upgrade/cluster_restart.asciidoc @@ -26,8 +26,11 @@ recovery. include::synced-flush.asciidoc[] -- -. *Stop any machine learning jobs that are running.* See -{xpack-ref}/stopping-ml.html[Stopping Machine Learning]. +. *Stop any machine learning jobs that are running.* ++ +-- +include::close-ml.asciidoc[] +-- . *Shutdown all nodes.* + @@ -139,3 +142,7 @@ you restore a pre-5.6 snapshot to a fresh 6.0 install. -- . *Restart machine learning jobs.* ++ +-- +include::open-ml.asciidoc[] +-- diff --git a/docs/reference/upgrade/open-ml.asciidoc b/docs/reference/upgrade/open-ml.asciidoc new file mode 100644 index 0000000000000..b9b6b772bbe8d --- /dev/null +++ b/docs/reference/upgrade/open-ml.asciidoc @@ -0,0 +1,13 @@ +[testenv="platinum"] +If you closed all {ml} jobs before the upgrade, you must open them. Use {kib} or +the <>. + +Alternatively, if you temporarily halted the tasks associated with your {ml} jobs, +use the <> to return them to active +states: + +[source,js] +-------------------------------------------------- +POST _ml/set_upgrade_mode?enabled=false +-------------------------------------------------- +// CONSOLE diff --git a/docs/reference/upgrade/rolling_upgrade.asciidoc b/docs/reference/upgrade/rolling_upgrade.asciidoc index dff3895ac4c1d..e62bd9348f1ab 100644 --- a/docs/reference/upgrade/rolling_upgrade.asciidoc +++ b/docs/reference/upgrade/rolling_upgrade.asciidoc @@ -43,8 +43,11 @@ include::synced-flush.asciidoc[] -- -. *Stop any machine learning jobs that are running.* See -{xpack-ref}/stopping-ml.html[Stopping Machine Learning]. +. *Stop any machine learning jobs that are running.* ++ +-- +include::close-ml.asciidoc[] +-- . [[upgrade-node]] *Shut down a single node*. + @@ -160,6 +163,11 @@ for each node that needs to be updated. -- . *Restart machine learning jobs.* ++ +-- +include::open-ml.asciidoc[] +-- + [IMPORTANT] ====================================================