This is an automated email from the ASF dual-hosted git repository.
dmagda pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ignite.git
The following commit(s) were added to refs/heads/master by this push:
new b6c2af1 IGNITE-13385 Added documentation on cache warm-up strategy
(#8689)
b6c2af1 is described below
commit b6c2af192147d7db9a41251efd230c95c5dafe5a
Author: Nikita Safonov <73828260+nikita-tech-wri...@users.noreply.github.com>
AuthorDate: Sat Jan 23 00:21:42 2021 +0300
IGNITE-13385 Added documentation on cache warm-up strategy (#8689)
---
docs/_docs/memory-configuration/data-regions.adoc | 69 +++++++++++++++++++++++
1 file changed, 69 insertions(+)
diff --git a/docs/_docs/memory-configuration/data-regions.adoc
b/docs/_docs/memory-configuration/data-regions.adoc
index f2646ad..4517ada 100644
--- a/docs/_docs/memory-configuration/data-regions.adoc
+++ b/docs/_docs/memory-configuration/data-regions.adoc
@@ -82,3 +82,72 @@
include::code-snippets/dotnet/MemoryArchitecture.cs[tag=mem,indent=0]
tab:C++[unsupported]
--
+== Cache Warm-Up Strategy
+
+The cache warm-up strategy provides an ability to load data from the disk to
the node before it is joined to the cluster.
+This prevents performance loss when the node is restarted.
+
+[NOTE]
+====
+The cache warm-up strategy is applicable only to the data regions. It can be
configured both for all regions (by default) or for each region separately.
+====
+
+Presently, Ignite warm-up strategy implies loading data into the region,
starting with indexes, until it runs out of free space.
+
+To warm up all data regions, pass the configuration parameter
`LoadAllWarmUpStrategy` to the
`DataStorageConfiguration#setDefaultWarmUpConfiguration` as follows:
+
+[source, java]
+----
+setDefaultWarmUpConfiguration(loadAllWarmUpStrategy)
+----
+
+To warm up a specific data region, pass the configuration parameter
`LoadAllWarmUpStrategy` to the
`DataStorageConfiguration#setWarmUpConfiguration` as follows:
+
+[source, java]
+----
+setWarmUpConfiguration(loadAllWarmUpStrategy)
+----
+
+To stop warming up all data regions, pass the configuration parameter
`NoOpWarmUpStrategy` to the
`DataStorageConfiguration#setDefaultWarmUpConfiguration` as follows:
+
+[source, java]
+----
+setDefaultWarmUpConfiguration(noOpWarmUpStrategy)
+----
+
+To stop warming up a specific data region, pass the configuration parameter
`NoOpWarmUpStrategy` to the `DataStorageConfiguration#setWarmUpConfiguration`
as follows:
+
+[source, java]
+----
+setWarmUpConfiguration(noOpWarmUpStrategy)
+----
+
+You can also stop the cache warming up process by using `control.sh` and JMX.
+
+To stop the warming up using control.sh:
+
+[tabs]
+--
+tab:Linux[]
+[source,shell,subs="verbatim,quotes"]
+----
+control.sh --warm-up --stop --yes
+----
+tab:Windows[]
+[source,shell,subs="verbatim,quotes"]
+----
+control.bat --warm-up --stop --yes
+----
+--
+
+To stop the warming up using JMX, use the method below:
+
+[source, java]
+----
+org.apache.ignite.mxbean.WarmUpMXBean#stopWarmUp
+----
+
+
+
+
+
