Uploaded image for project: 'Apache Ozone'
  1. Apache Ozone
  2. HDDS-3057

Improve Ozone Shell ACL operations' help text readability

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • None
    • 0.5.0
    • None

    Description

      Currently:

      ozone sh volume addacl -h
      $ ozone sh volume addacl -h
      Usage: ozone sh volume addacl [-hV] -a=<acl> [-s=<storeType>] <uri>
      Add a new Acl.
            <uri>                 URI of the volume/bucket.
                                  Ozone URI could start with o3:// or without prefix. URI
                                    may contain the host and port of the OM server. Both
                                    are optional. If they are not specified it will be
                                    identified from the config files.
        -a, --acl=<acl>           Add acl.r = READ,w = WRITE,c = CREATE,d = DELETE,l =
                                    LIST,a = ALL,n = NONE,x = READ_AC,y = WRITE_ACEx user:
                                    user1:rw or group:hadoop:rw
        -h, --help                Show this help message and exit.
        -s, --store=<storeType>   store type. i.e OZONE or S3
        -V, --version             Print version information and exit.
      
      ozone sh bucket addacl -h
      $ ozone sh bucket addacl -h
      Usage: ozone sh bucket addacl [-hV] -a=<acl> [-s=<storeType>] <uri>
      Add a new Acl.
            <uri>                 URI of the volume/bucket.
                                  Ozone URI could start with o3:// or without prefix. URI
                                    may contain the host and port of the OM server. Both
                                    are optional. If they are not specified it will be
                                    identified from the config files.
        -a, --acl=<acl>           new acl.r = READ,w = WRITE,c = CREATE,d = DELETE,l =
                                    LIST,a = ALL,n = NONE,x = READ_AC,y = WRITE_ACEx user:
                                    user1:rw or group:hadoop:rw
        -h, --help                Show this help message and exit.
        -s, --store=<storeType>   store type. i.e OZONE or S3
        -V, --version             Print version information and exit.
      

      Same for ozone sh (volume|bucket|key) (addacl|removeacl|setacl|getacl)

      It would look much nicer to have a line separator or space between acl. and .r = READ,....

      And improves the prompt on error and overall readability, and correct typo: READ_AC -> READ_ACL, WRITE_AC -> WRITE_ACL.

      Attachments

        Issue Links

          Activity

            People

              smeng Siyao Meng
              smeng Siyao Meng
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 20m
                  20m