Create a follower index to replicate a specific index
editCreate a follower index to replicate a specific index
editWhen you create a follower index, you reference the remote cluster and the leader index in your remote cluster.
To create a follower index from Stack Management in Kibana:
- Select Cross-Cluster Replication in the side navigation and choose the Follower Indices tab.
- Choose the cluster (ClusterA) containing the leader index you want to replicate.
-
Enter the name of the leader index, which is
kibana_sample_data_ecommerceif you are following the tutorial. -
Enter a name for your follower index, such as
follower-kibana-sample-data.
Elasticsearch initializes the follower using the remote recovery process, which transfers the existing Lucene segment files from the leader index to the follower index. The index status changes to Paused. When the remote recovery process is complete, the index following begins and the status changes to Active.
When you index documents into your leader index, Elasticsearch replicates the documents in the follower index.
API example
You can also use the create follower API to create follower indices. When you create a follower index, you must reference the remote cluster and the leader index that you created in the remote cluster.
When initiating the follower request, the response returns before the
remote recovery process completes. To wait for the process
to complete, add the wait_for_active_shards parameter to your request.
resp = client.ccr.follow(
index="server-metrics-follower",
wait_for_active_shards="1",
remote_cluster="leader",
leader_index="server-metrics",
)
print(resp)
const response = await client.ccr.follow({
index: "server-metrics-follower",
wait_for_active_shards: 1,
remote_cluster: "leader",
leader_index: "server-metrics",
});
console.log(response);
PUT /server-metrics-follower/_ccr/follow?wait_for_active_shards=1
{
"remote_cluster" : "leader",
"leader_index" : "server-metrics"
}
Use the get follower stats API to inspect the status of replication.