[
https://issues.apache.org/jira/browse/HDDS-13692?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Siyao Meng updated HDDS-13692:
------------------------------
Description:
In HDDS-8802, `all` option has been renamed to `all-status`, that
(unintentionally?) revealed the underlying `--all` option in `ListLimitOptions`
under `ListPaginationOptions`.
That breaks some scripts unfortunately because it caused the behavior before
and after the patch to differ. The least we can do is to document the behavior
correctly from now on.
That also caused confusion around what both options do. Currently:
{code}
bash-5.1$ ozone sh snapshot lsDiff -h
Usage: ozone sh snapshot listDiff [-hV] [--all-status] [--verbose]
[--job-status=<jobStatus>] [-s=<startItem>]
[[-l=<limit>] | [-a]] <value>
List snapshotDiff jobs for a bucket.
<value> URI of the bucket (format: volume/bucket).
Ozone URI could either be a full URI or short URI.
Full URI should start with o3://, in case of non-HA
clusters it should be followed by the host name and
optionally the port number. In case of HA clusters
the service id should be used. Service id provides a
logical name for multiple hosts and it is defined
in the property ozone.om.service.ids.
Example of a full URI with host name and port number
for a key:
o3://omhostname:9862/vol1/bucket1/key1
With a service id for a volume:
o3://omserviceid/vol1/
Short URI should start from the volume.
Example of a short URI for a bucket:
vol1/bucket1
Any unspecified information will be identified from
the config files.
-a, --all List all results
--all-status List all jobs regardless of status.
-h, --help Show this help message and exit.
--job-status=<jobStatus>
List jobs based on status.
Accepted values are: queued, in_progress, done,
failed, rejected
-l, --length=<limit> Maximum number of items to list
Default: 100
-s, --start=<startItem> The item to start the listing from.
This will be excluded from the result.
-V, --version Print version information and exit.
--verbose More verbose output. Show the stack trace of the
errors.
{code}
was:In HDDS-8802, `all` option has been renamed to `all-status`, that
(unintentionally?) revealed the underlying `--all` option in `ListLimitOptions`
under `ListPaginationOptions`. That breaks some scripts unfortunately because
it caused the behavior before and after the patch to differ. The least we can
do is to document the behavior correctly from now on.
> Clarify --all option usage in ozone sh snapshot lsDiff
> ------------------------------------------------------
>
> Key: HDDS-13692
> URL: https://issues.apache.org/jira/browse/HDDS-13692
> Project: Apache Ozone
> Issue Type: Improvement
> Components: documentation
> Reporter: Siyao Meng
> Assignee: Siyao Meng
> Priority: Critical
>
> In HDDS-8802, `all` option has been renamed to `all-status`, that
> (unintentionally?) revealed the underlying `--all` option in
> `ListLimitOptions` under `ListPaginationOptions`.
> That breaks some scripts unfortunately because it caused the behavior before
> and after the patch to differ. The least we can do is to document the
> behavior correctly from now on.
> That also caused confusion around what both options do. Currently:
> {code}
> bash-5.1$ ozone sh snapshot lsDiff -h
> Usage: ozone sh snapshot listDiff [-hV] [--all-status] [--verbose]
> [--job-status=<jobStatus>] [-s=<startItem>]
> [[-l=<limit>] | [-a]] <value>
> List snapshotDiff jobs for a bucket.
> <value> URI of the bucket (format: volume/bucket).
> Ozone URI could either be a full URI or short URI.
> Full URI should start with o3://, in case of
> non-HA
> clusters it should be followed by the host name
> and
> optionally the port number. In case of HA clusters
> the service id should be used. Service id
> provides a
> logical name for multiple hosts and it is defined
> in the property ozone.om.service.ids.
> Example of a full URI with host name and port
> number
> for a key:
> o3://omhostname:9862/vol1/bucket1/key1
> With a service id for a volume:
> o3://omserviceid/vol1/
> Short URI should start from the volume.
> Example of a short URI for a bucket:
> vol1/bucket1
> Any unspecified information will be identified
> from
> the config files.
> -a, --all List all results
> --all-status List all jobs regardless of status.
> -h, --help Show this help message and exit.
> --job-status=<jobStatus>
> List jobs based on status.
> Accepted values are: queued, in_progress, done,
> failed, rejected
> -l, --length=<limit> Maximum number of items to list
> Default: 100
> -s, --start=<startItem> The item to start the listing from.
> This will be excluded from the result.
> -V, --version Print version information and exit.
> --verbose More verbose output. Show the stack trace of the
> errors.
> {code}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
