openshift / openshift/origin

Help for oc set volume --claim-mode doesn't match documented modes.

Open
#17,255 2 comments 0 reactions 1 assignee View on GitHub

@juanvallejo is already working on this.

Since Nov 14, 2017.

component/cli kind/bug lifecycle/frozen lifecycle/stale priority/P2
Dominant language
Go
Stars
8.7k
Forks
4.8k
Avg merge
4d 10h
Merged PRs (30d)
53

Description

The help string output for --claim-mode option of oc set volume uses short names for access modes which don't match what is in documentation.

Version
oc v3.7.0-rc.0+e92d5c5
kubernetes v1.7.6+a08f5eeb62
features: Basic-Auth
Steps To Reproduce

Run:

oc set volume --help
Current Result

Help string for --claim-mode is:

      --claim-mode='ReadWriteOnce': Set the access mode of the claim to be created. Valid values are ReadWriteOnce (rwo), ReadWriteMany (rwm), or ReadOnlyMany (rom)
Expected Result

Documentation at:

uses the following:

  • ReadWriteOnce (RWO)
  • ReadOnlyMany (ROX)
  • ReadWriteMany (RWX)

Would expect short acronym for access modes to be same as documentation in name and case to be consistent.

That is, use:

      --claim-mode='ReadWriteOnce': Set the access mode of the claim to be created. Valid values are ReadWriteOnce (RWO), ReadWriteMany (RWX), or ReadOnlyMany (ROX)

as seems to be accepted convention everywhere else.

Additional Information

None.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.