[HDDS-3274] Improve documentation for specifying serviceId

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Duplicate
• Affects Version/s: 0.5.0
• Component/s: documentation
• Labels: Triaged
• Target Version/s: 1.0.0
• Assignee: Unassigned
• Reporter: Dinesh Chitlangia
• Created: 25/Mar/20 04:38
• Updated: 04/Jun/20 20:57
• Resolved: 04/Jun/20 20:48

Description

Discovered by xyao when testing 0.5.0-beta rc2

 

The document on specifying service/ID can be improved. More
specifically, the URI should give examples for the Service ID in HA.
Currently, it only mentions host/port.

ozone sh vol create /vol1
Service ID or host name must not be omitted when ozone.om.service.ids is
defined.
bash-4.2$ ozone sh vol create --help
Usage: ozone sh volume create [-hV] [--root] [-q=<quota>] [-u=<userName>]
<uri>
Creates a volume for the specified user
      <uri>               URI of the volume.
                          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.

Issue Links

• is superceded by: HDDS-3413 Ozone documentation to be revised for OM HA Support