Skip to content

Latest commit

 

History

History
71 lines (58 loc) · 2.34 KB

README.md

File metadata and controls

71 lines (58 loc) · 2.34 KB
Raw

Chorctl

CLI for chorus management api.

chorctl.png

Install

cd ./tools/chorctl && go build .

Or download binary from the latest release.

Or with homebrew (MacOS and Linux only):

brew install clyso/tap/chorctl

Usage

chorctl sends requests to GRPC api hosted by Chorus worker. Deploy worker and provide GRPC api address to chorctl with --address flag or CHORUS_ADDRESS envar, for example:

export CHORUS_ADDRESS=127.0.0.1:9670
 ./chorctl help
 
Chorctl is a CLI tool to monitor and manage chorus application
performing live migrations and replication of s3 storages.

Usage:
  chorctl [command]

Available Commands:
  agent       Prints information about registered notification agents
  check       Checks the files in the source and destination match.
  completion  Generate the autocompletion script for the specified shell
  dash        Open migration interactive dashboard
  help        Help about any command
  repl        list replications
  storage     Prints information about underlying chorus s3 storages

Flags:
  -a, --address string   address to chorus management grpc api (default: http://localhost:9670) (default "localhost:9670")
      --config string    config file (default is $HOME/.chorctl.yaml)
  -h, --help             help for chorctl
  -u, --user string      storage user
  -v, --verbose          prints additional log information

Use "chorctl [command] --help" for more information about a command.

Useful commands:

Show live dashboard with bucket replication statuses:

chorctl dash

Manage replicatoins (run chorclt repl -h to see all commands).

List buckets avaiable for replication for given S3 user:

chorctl repl buckets -u <s3 user name from chorus config> -f <souce s3 storage from chorus config> -t <destination s3 storage from chorus config>

Start replication for given S3 user/bucket:

chorctl repl add -b <bucket name> -u <s3 user name from chorus config> -f <souce s3 storage from chorus config> -t <destination s3 storage from chorus config>

Enable replication for all user buckets:

chorctl repl add-user -u <s3 user name from chorus config> -f <souce s3 storage from chorus config> -t <destination s3 storage from chorus config>