Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Console] Tiny PR to update the CLI help strings for the command groups #774

Merged
merged 1 commit into from
Jun 26, 2024
Merged

[Console] Tiny PR to update the CLI help strings for the command groups #774

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 7 additions & 20 deletions ...ture/dockerSolution/src/main/docker/migrationConsole/lib/console_link/console_link/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def cli(ctx, config_file, json, verbose):
# ##################### CLUSTERS ###################


@cli.group(name="clusters")
@cli.group(name="clusters", help="Commands to interact with source and target clusters")
@click.pass_obj
def cluster_group(ctx):
if ctx.env.source_cluster is None:
Expand Down Expand Up @@ -119,25 +119,12 @@ def clear_indices_cmd(ctx, acknowledge_risk, cluster):
else:
click.echo("Aborting command.")

# ##################### REPLAYER ###################


@cli.group(name="replayer")
@click.pass_obj
def replayer_group(ctx):
if ctx.env.replayer is None:
raise click.UsageError("Replayer is not set")


@replayer_group.command(name="start")
@click.pass_obj
def start_replayer_cmd(ctx):
ctx.env.replayer.start()

# ##################### SNAPSHOT ###################


@cli.group(name="snapshot")
@cli.group(name="snapshot",
help="Commands to create and check status of snapshots of the source cluster.")
@click.pass_obj
def snapshot_group(ctx):
"""All actions related to snapshot creation"""
Expand Down Expand Up @@ -172,7 +159,7 @@ def status_snapshot_cmd(ctx, deep_check):
# arguments depending on the type of backfill migration


@cli.group(name="backfill")
@cli.group(name="backfill", help="Commands related to controlling the configured backfill mechanism.")
@click.pass_obj
def backfill_group(ctx):
"""All actions related to historical/backfill data migrations"""
Expand Down Expand Up @@ -243,7 +230,7 @@ def status_backfill_cmd(ctx, deep_check):

# ##################### REPLAY ###################

@cli.group(name="replay")
@cli.group(name="replay", help="Commands related to controlling the replayer.")
@click.pass_obj
def replay_group(ctx):
"""All actions related to replaying data"""
Expand Down Expand Up @@ -297,7 +284,7 @@ def status_replay_cmd(ctx):
# ##################### METADATA ###################


@cli.group(name="metadata")
@cli.group(name="metadata", help="Commands related to migrating metadata to the target cluster.")
@click.pass_obj
def metadata_group(ctx):
"""All actions related to metadata migration"""
Expand All @@ -317,7 +304,7 @@ def migrate_metadata_cmd(ctx, detach):
# ##################### METRICS ###################


@cli.group(name="metrics")
@cli.group(name="metrics", help="Commands related to checking metrics emitted by the capture proxy and replayer.")
@click.pass_obj
def metrics_group(ctx):
if ctx.env.metrics_source is None:
Expand Down
Loading