diff --git a/clusterless-main-common/src/main/java/clusterless/cls/command/report/ArcStatusCommandOption.java b/clusterless-main-common/src/main/java/clusterless/cls/command/report/ArcStatusCommandOption.java index d56086e8..093635d8 100644 --- a/clusterless-main-common/src/main/java/clusterless/cls/command/report/ArcStatusCommandOption.java +++ b/clusterless-main-common/src/main/java/clusterless/cls/command/report/ArcStatusCommandOption.java @@ -15,24 +15,24 @@ import java.util.LinkedList; import java.util.List; -@CommandLine.Command( - name = "status", - description = "Show the status of the current target." -) public class ArcStatusCommandOption extends CommonCommandOptions { @CommandLine.Mixin ArcReportOptions arcReportOptions = new ArcReportOptions(); - @CommandLine.Mixin + @CommandLine.ArgGroup( + exclusive = false, + multiplicity = "1", + heading = "Time Range Options:%n" + ) RangeOptions rangeOptions = new RangeOptions(); @CommandLine.Option( names = {"--name"}, - description = "Filter results by the name of the target to show." + description = "Filter results by the name of the arc." ) List names = new LinkedList<>(); - @CommandLine.Option(names = {"--list"}, description = {"List all arc instances"}) + @CommandLine.Option(names = {"--list"}, description = {"List all arc instances instead of summarizing."}) boolean list = false; public ArcStatusCommandOption setNames(List names) { diff --git a/clusterless-main-common/src/main/java/clusterless/cls/command/report/DatasetStatusCommandOption.java b/clusterless-main-common/src/main/java/clusterless/cls/command/report/DatasetStatusCommandOption.java index c297f67d..f808ace8 100644 --- a/clusterless-main-common/src/main/java/clusterless/cls/command/report/DatasetStatusCommandOption.java +++ b/clusterless-main-common/src/main/java/clusterless/cls/command/report/DatasetStatusCommandOption.java @@ -15,20 +15,20 @@ import java.util.LinkedList; import java.util.List; -@CommandLine.Command( - name = "status", - description = "Show the status of the current target." -) public class DatasetStatusCommandOption extends CommonCommandOptions { @CommandLine.Mixin DatasetReportOptions datasetReportOptions = new DatasetReportOptions(); - @CommandLine.Mixin + @CommandLine.ArgGroup( + exclusive = false, + multiplicity = "1", + heading = "Time Range Options:%n" + ) RangeOptions rangeOptions = new RangeOptions(); @CommandLine.Option( names = {"--name"}, - description = "Filter results by the name of the target to show." + description = "Filter results by the name of the dataset." ) List names = new LinkedList<>(); diff --git a/clusterless-main-common/src/main/java/clusterless/cls/command/report/RangeOptions.java b/clusterless-main-common/src/main/java/clusterless/cls/command/report/RangeOptions.java index f337ac07..c16e03f2 100644 --- a/clusterless-main-common/src/main/java/clusterless/cls/command/report/RangeOptions.java +++ b/clusterless-main-common/src/main/java/clusterless/cls/command/report/RangeOptions.java @@ -16,7 +16,9 @@ public class RangeOptions { @CommandLine.Option( names = {"--earliest"}, description = { - "Earliest time to include in report.", + "Earliest time to include in report, inclusive.", + "Where the time can be most any date/time format, or", + "an adjuster such as '1h' or '1d'.", "(default: ${DEFAULT-VALUE})" }, converter = MomentTypeConverter.class, @@ -26,7 +28,9 @@ public class RangeOptions { @CommandLine.Option( names = {"--latest"}, description = { - "Latest time to include in report.", + "Latest time to include in report, exclusive.", + "Where the time can be most any date/time format, or", + "an adjuster such as '1h' or '1d'.", "(default: ${DEFAULT-VALUE})" }, converter = MomentTypeConverter.class diff --git a/clusterless-main/src/main/java/clusterless/cls/command/report/ArcsCommand.java b/clusterless-main/src/main/java/clusterless/cls/command/report/ArcsCommand.java index 4bab18db..0f95c70c 100644 --- a/clusterless-main/src/main/java/clusterless/cls/command/report/ArcsCommand.java +++ b/clusterless-main/src/main/java/clusterless/cls/command/report/ArcsCommand.java @@ -25,7 +25,15 @@ public ArcsCommand() { @CommandLine.Command( name = "status", - description = "Show the status of the current target." + description = { + "Show a summary of deployed arcs status (within the time range).", + "Where status is one of:", + " - running: workload is in process", + " - complete: workload finished successfully", + " - partial: workload finished but some data is missing", + " - missing: no data, possibly due to error, or missing upstream data", + "The --list option will output all arc instances instead of summarizing." + } ) public static class ArcStatusCommand implements Callable { @CommandLine.ParentCommand diff --git a/clusterless-main/src/main/java/clusterless/cls/command/report/DatasetsCommand.java b/clusterless-main/src/main/java/clusterless/cls/command/report/DatasetsCommand.java index 21107c3e..57f2341a 100644 --- a/clusterless-main/src/main/java/clusterless/cls/command/report/DatasetsCommand.java +++ b/clusterless-main/src/main/java/clusterless/cls/command/report/DatasetsCommand.java @@ -25,7 +25,15 @@ public DatasetsCommand() { @CommandLine.Command( name = "status", - description = "Show the status of the current target." + description = { + "Show a summary of deployed dataset manifest status (within the time range).", + "Where status is one of:", + " - complete: manifest is complete", + " - partial: manifest exists, but some data is missing", + " - empty: manifest has no data, possibly due to error, or missing upstream data", + " - removed: the manifest and its data has been removed", + "The --list option will output all manifest instances instead of summarizing." + } ) public static class DatasetStatusCommand implements Callable { @CommandLine.ParentCommand diff --git a/clusterless-main/src/main/java/clusterless/cls/command/report/PlacementsCommand.java b/clusterless-main/src/main/java/clusterless/cls/command/report/PlacementsCommand.java index 081e0512..bf1cadf2 100644 --- a/clusterless-main/src/main/java/clusterless/cls/command/report/PlacementsCommand.java +++ b/clusterless-main/src/main/java/clusterless/cls/command/report/PlacementsCommand.java @@ -13,7 +13,7 @@ @CommandLine.Command( name = "placements", - description = "List all visible placements with deployments." + description = "List all placements with deployments." ) public class PlacementsCommand extends CommandWrapper { public PlacementsCommand() { diff --git a/clusterless-substrate-aws-kernel/src/main/java/clusterless/cls/substrate/aws/report/ArcStatus.java b/clusterless-substrate-aws-kernel/src/main/java/clusterless/cls/substrate/aws/report/ArcStatus.java index e3583172..3a92094b 100644 --- a/clusterless-substrate-aws-kernel/src/main/java/clusterless/cls/substrate/aws/report/ArcStatus.java +++ b/clusterless-substrate-aws-kernel/src/main/java/clusterless/cls/substrate/aws/report/ArcStatus.java @@ -19,8 +19,7 @@ import java.util.stream.Stream; @CommandLine.Command( - name = "status", - description = "List the status of all arcs in the range." + name = "status" ) public class ArcStatus implements Callable { @CommandLine.ParentCommand