Loading

stack es ccr follow cli command

Auth required Idempotent Scope: global
elastic stack es ccr follow \
  --index <index> \
  --leader-index <leader-index> \
  --remote-cluster <remote-cluster> \
  [options]
		

Create a follower.

--index string required
The name of the follower index.
--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.
--master-timeout string
Period to wait for a connection to the master node.
--wait-for-active-shards number
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 number
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 number
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 number
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.
--input-file string
path to a JSON file to use as command input
-V --[no-]version
Print the Elastic CLI version
--config-file string
path to a config file (default: ~/.elasticrc.yml)
--use-context string
override the active context from the config file
--command-profile string
restrict available commands to a deployment profile (serverless, stack, default)
--[no-]json
output as JSON
--output-fields string
comma-separated list of fields to include in output (dot-notation supported)
--output-template string
Mustache-like template for custom text output (e.g. "{{id}}: {{name}}")
--[no-]dry-run

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