Skip to content

Official documentation: restore wait_for_completion disambiguation #70854

Closed
@simonecaf

Description

@simonecaf

Hello!

By exploring the documentation related to Elasticsearch, I could not get the info related to the expected index status after executing a restore call with wait_for_completion parameter set to true.

From the documentation, for different version I can read:

Monitor snapshot/restore process 6.8
There are several ways to monitor the progress of the snapshot and restores processes while they are running. Both operations support wait_for_completion parameter that would block client until the operation is completed. This is the simplest method that can be used to get notified about operation completion.

Monitoring restore operations 7.x
The restore process piggybacks on the standard recovery mechanism of Elasticsearch. As a result, standard recovery monitoring services can be used to monitor the state of restore. When the restore operation starts, the cluster typically goes into yellow state because the restore operation works by recovering primary shards of the restored indices. After the recovery of the primary shards is completed, Elasticsearch switches to the standard replication process that creates the required number of replicas. When all required replicas are created, the cluster switches to the green states.

My question is the following: when wait_for_completion is set to true, is it guaranteed that when the operation is completed the status of the index is green? If not what does "operation is completed" mean? (e.g. just primary are copied, etc)

Metadata

Metadata

Assignees

No one assigned

    Labels

    :Distributed Coordination/Snapshot/RestoreAnything directly related to the `_snapshot/*` APIs>bug>docsGeneral docs changesTeam:Distributed (Obsolete)Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination.Team:DocsMeta label for docs team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions