Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ceph.in: clarify the usage of --format in the ceph command #45802

Merged
merged 2 commits into from
Apr 12, 2022

Conversation

ljflores
Copy link
Contributor

@ljflores ljflores commented Apr 6, 2022

It is not clear to users in the output of ceph --help that the yaml formatter option is only valid for orch commands.

Before:

-f {json,json-pretty,xml,xml-pretty,plain,yaml}, --format {json,json-pretty,xml,xml-pretty,plain,yaml}

After:

-f {json,json-pretty,xml,xml-pretty,plain,yaml}, --format {json,json-pretty,xml,xml-pretty,plain,yaml}
                        Note: yaml is only valid for orch commands

Fixes: https://tracker.ceph.com/issues/53895
Signed-off-by: Laura Flores lflores@redhat.com

Checklist

  • Tracker (select at least one)
    • References tracker ticket
    • Very recent bug; references commit where it was introduced
    • New feature (ticket optional)
    • Doc update (no ticket needed)
    • Code cleanup (no ticket needed)
  • Component impact
    • Affects Dashboard, opened tracker ticket
    • Affects Orchestrator, opened tracker ticket
    • No impact that needs to be tracked
  • Documentation (select at least one)
    • Updates relevant documentation
    • No doc update is appropriate
  • Tests (select at least one)
Show available Jenkins commands
  • jenkins retest this please
  • jenkins test classic perf
  • jenkins test crimson perf
  • jenkins test signed
  • jenkins test make check
  • jenkins test make check arm64
  • jenkins test submodules
  • jenkins test dashboard
  • jenkins test dashboard cephadm
  • jenkins test api
  • jenkins test docs
  • jenkins render docs
  • jenkins test ceph-volume all
  • jenkins test ceph-volume tox
  • jenkins test windows

It is not clear to users in the output of `ceph --help` that
the yaml formatter option is only valid for orch commands.

Before:
-f {json,json-pretty,xml,xml-pretty,plain,yaml}, --format {json,json-pretty,xml,xml-pretty,plain,yaml}

After:
-f {json,json-pretty,xml,xml-pretty,plain,yaml}, --format {json,json-pretty,xml,xml-pretty,plain,yaml}
                        Note: yaml is only valid for orch commands

Fixes: https://tracker.ceph.com/issues/53895
Signed-off-by: Laura Flores <lflores@redhat.com>
The `ceph --format` option includes yaml, which
is only valid for orch commands.

Signed-off-by: Laura Flores <lflores@redhat.com>
@ljflores ljflores requested a review from a team as a code owner April 6, 2022 16:58
@ljflores ljflores requested a review from vumrao April 6, 2022 17:02
@ljflores
Copy link
Contributor Author

http://pulpito.front.sepia.ceph.com/yuriw-2022-04-11_23:40:29-rados-wip-yuri7-testing-2022-04-11-1139-distro-default-smithi/
http://pulpito.front.sepia.ceph.com/yuriw-2022-04-12_15:25:49-rados-wip-yuri7-testing-2022-04-11-1139-distro-default-smithi/

Failures, unrelated:
https://tracker.ceph.com/issues/55295
https://tracker.ceph.com/issues/54372

Details:
1. Dead job caused by "AttributeError: 'NoneType' object has no attribute '_fields'" on smithi055 - Intrastructure - Sepia
2. No module named 'tasks' - Infrastructure

@ljflores
Copy link
Contributor Author

jenkins test windows

@yuriw yuriw merged commit 61b975a into ceph:master Apr 12, 2022
@ljflores ljflores deleted the wip-config-dump-yaml branch April 12, 2022 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants