Skip to content

replicate.md

Latest commit

 

History

History
61 lines (49 loc) · 2.42 KB

replicate.md

File metadata and controls

61 lines (49 loc) · 2.42 KB

rc replicate

Purpose

rc replicate manages bucket replication configuration and status. It is a legacy-compatible command; prefer rc bucket replication for new scripts.

Syntax

rc [GLOBAL OPTIONS] replicate <COMMAND>
rc replicate add [OPTIONS] --remote-bucket <TARGET_ALIAS/BUCKET> <SOURCE_ALIAS/BUCKET>
rc replicate update [OPTIONS] --id <ID> <SOURCE_ALIAS/BUCKET>
rc replicate list [OPTIONS] <SOURCE_ALIAS/BUCKET>
rc replicate status [OPTIONS] <SOURCE_ALIAS/BUCKET>
rc replicate remove [OPTIONS] <SOURCE_ALIAS/BUCKET>
rc replicate export [OPTIONS] <SOURCE_ALIAS/BUCKET>
rc replicate import [OPTIONS] <SOURCE_ALIAS/BUCKET> <FILE>

Parameters

Parameter Description
SOURCE_ALIAS/BUCKET Source bucket for replication.
--remote-bucket TARGET_ALIAS/BUCKET Destination bucket for a new rule.
--id Rule identifier to update or remove.
--replicate Comma-separated flags: delete, delete-marker, existing-objects.
--priority Rule priority. Defaults to 1 for new rules.
--storage-class Destination storage class override.
--bandwidth Bandwidth limit in bytes per second; 0 means unlimited.
--sync Enable synchronous replication.
--prefix Key prefix filter.
--healthcheck-seconds Health check interval. Defaults to 60 for new rules.
--disable-proxy Disable replication proxy.
--all Remove all rules.
--force Force operation even if capability detection fails.

Examples

rc bucket version enable local/reports
rc bucket version enable backup/reports
rc bucket replication add local/reports --remote-bucket backup/reports --replicate delete,existing-objects
rc replicate status local/reports
rc replicate export local/reports > replication.json

Behavior

Replication generally requires versioning on source and destination buckets. The target bucket is resolved through its own alias, so configure both source and destination aliases before adding rules.

Global options shown in command syntax use the same meaning everywhere:

Option Description
--format auto|human|json Select automatic, human-readable, or JSON output.
--json Emit JSON output where the command supports structured output.
--no-color Disable terminal colors.
--no-progress Disable progress bars.
-q, --quiet Suppress non-error output.
--debug Enable debug logging.