stack es ccr follow cli command

elastic stack es ccr follow \
  --leader-index <leader-index> \
  --remote-cluster <remote-cluster> \
  --index <index> \
  [options]
		

Create a follower.

Behaviour flags:

--dry-run — validate all inputs and exit without performing any action

--leader-index string required

The name of the index in the leader cluster to follow.

--remote-cluster string required

The remote cluster containing the leader index.

--index string required

The name of the follower index.

--master-timeout string

Period to wait for a connection to the master node.

--wait-for-active-shards string

Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be active. A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the remote Lucene segment files to the follower index.

--data-stream-name string

If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed.

--max-outstanding-read-requests number

The maximum number of outstanding reads requests from the remote cluster.

--max-outstanding-write-requests number

The maximum number of outstanding write requests on the follower.

--max-read-request-operation-count number

The maximum number of operations to pull per read from the remote cluster.

--max-read-request-size string

The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.

--max-retry-delay string

The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.

--max-write-buffer-count number

The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit.

--max-write-buffer-size string

The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit.

--max-write-request-operation-count number

The maximum number of operations per bulk write request executed on the follower.

--max-write-request-size string

The maximum total bytes of operations per bulk write request executed on the follower.

--read-poll-timeout string

The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again.

--settings string

Settings to override from the leader index.

--error-trace

When set to true Elasticsearch will include the full stack trace of errors when they occur.

--filter-path string

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.

Repeatable: pass --filter-path multiple times to supply more than one value

--human

When set to true will return statistics in a format suitable for humans. For example "exists_time": "1h" for humans and "exists_time_in_millis": 3600000 for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.

--pretty

If set to true the returned JSON will be "pretty-formatted". Only use this option for debugging only.

--input-file string

path to a JSON file to use as command input

--dry-run

validate all inputs and exit without performing any action (preview changes without applying them)

--json

output as JSON