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

cli, api: usability improvements #518

Open
3 tasks
epuertat opened this issue Mar 22, 2024 · 1 comment
Open
3 tasks

cli, api: usability improvements #518

epuertat opened this issue Mar 22, 2024 · 1 comment

Comments

@epuertat
Copy link
Member

Few suggestions on usability:

  • API (gRPC proto) should improve internal consistency:
    • Arguments, field names:
      • Subsystem NQN is named in 3 different was on different methods: subsystem_nqn, subsystem and nqn.
      • We have anagrpid, load_balancing_group (are they the same thing?).
    • Methods should follow a consistent naming:
      • currently we have namespace_add (which is consistent with CLI), but list_namespaces. All methods should adopt the same convention, preferably <object>_<verb>.
    • Remove unneeded params:
      • Is namespace uuid really required? Compared to having nsid (indexes, like 1, 2, 3...), it looks like a unfriendly param. That's ok for metadata, but most namespace calls accept optionally uuid and nsid.

Tasks

@gbregman
Copy link
Contributor

@epuertat uuid is not a required parameter in any namespace command. If the user doesn't supply it one will be generated for him. We still allow to use in namespace commands as the namespace identifier. If the user find it unfriendly he can totally ignore it. There is no need to remove it from gRPC. People using API and not the CLI might find it usefull

gbregman added a commit to gbregman/ceph-nvmeof that referenced this issue Mar 31, 2024
gbregman added a commit to gbregman/ceph-nvmeof that referenced this issue Mar 31, 2024
gbregman added a commit to gbregman/ceph-nvmeof that referenced this issue Mar 31, 2024
gbregman added a commit to gbregman/ceph-nvmeof that referenced this issue Mar 31, 2024
gbregman added a commit to gbregman/ceph-nvmeof that referenced this issue Mar 31, 2024
gbregman added a commit to gbregman/ceph-nvmeof that referenced this issue Mar 31, 2024
gbregman added a commit to gbregman/ceph-nvmeof that referenced this issue Mar 31, 2024
gbregman added a commit to gbregman/ceph-nvmeof that referenced this issue Mar 31, 2024
gbregman added a commit to gbregman/ceph-nvmeof that referenced this issue Apr 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🆕 New
Development

Successfully merging a pull request may close this issue.

2 participants