OpenSearch/docs/reference/modules/gateway.asciidoc

[[modules-gateway]]
== Local Gateway

The local gateway module stores the cluster state and shard data across full
cluster restarts.

The following _static_ settings, which must be set on every data node in the
cluster, controls how long nodes should wait before they try to recover any
shards which are stored locally:

`gateway.expected_nodes`::

    The number of (data or master) nodes that are expected to be in the cluster.
    Recovery of local shards will start as soon as the expected number of
    nodes have joined the cluster. Defaults to `0`

`gateway.expected_master_nodes`::

    The number of master nodes that are expected to be in the cluster.
    Recovery of local shards will start as soon as the expected number of
    master nodes have joined the cluster. Defaults to `0`

`gateway.expected_data_nodes`::

    The number of data nodes that are expected to be in the cluster.
    Recovery of local shards will start as soon as the expected number of
    data nodes have joined the cluster. Defaults to `0`

`gateway.recover_after_time`::

    If the expected number of nodes is not achieved, the recovery process waits
    for the configured amount of time before trying to recover regardless.
    Defaults to `5m` if one of the `expected_nodes` settings is configured.

Once the `recover_after_time` duration has timed out, recovery will start
as long as the following conditions are met:

`gateway.recover_after_nodes`::

    Recover as long as this many data or master nodes have joined the cluster.

`gateway.recover_after_master_nodes`::

    Recover as long as this many master nodes have joined the cluster.

`gateway.recover_after_data_nodes`::

    Recover as long as this many data nodes have joined the cluster.

NOTE: These settings only take effect on a full cluster restart.