Hello everyone:
These days I have been doing a freeipa upgrade on a production cluster, what requires to perform multiple operations on the cluster for doing it without service interruption. One of the tasks was to ensure the topology is a complete graph, where each node have a connection with all the other nodes.
In order to get the current topology, the command is `ipa topologysegment-find ca/domain` But this is confusing since there is another command named `ipa topologysegment-show...`.
A user could expect the following behaviour: - topologysegment-show -> List all the elements, since "show" means you want to see something in general terms. - topologysegment-find -> List filtered elements by a given value, since "find" means you want to see something concrete.
This is the same with other topics of the IPA command.
I think this sould be changed in order to be more clear. My proposal is as follows:
- "topic"-list -> in order to list all the elements. - "topic"-find -> in order to get certain elements filtered by a given value. - "topic"-detail or "topic"-describe -> in order to see the details of a given element.
What do you think? Do you also find current commands confusing?
Thanks, Regards
Jesús Marín García via FreeIPA-users wrote:
Hello everyone:
These days I have been doing a freeipa upgrade on a production cluster, what requires to perform multiple operations on the cluster for doing it without service interruption. One of the tasks was to ensure the topology is a complete graph, where each node have a connection with all the other nodes.
In order to get the current topology, the command is `ipa topologysegment-find ca/domain` But this is confusing since there is another command named `ipa topologysegment-show...`.
A user could expect the following behaviour:
- topologysegment-show -> List all the elements, since "show" means you
want to see something in general terms.
- topologysegment-find -> List filtered elements by a given value, since
"find" means you want to see something concrete.
This is the same with other topics of the IPA command.
I think this sould be changed in order to be more clear. My proposal is as follows:
- "topic"-list -> in order to list all the elements.
- "topic"-find -> in order to get certain elements filtered by a given
value.
- "topic"-detail or "topic"-describe -> in order to see the details of a
given element.
What do you think? Do you also find current commands confusing?
Any given IPA plugin typically has at least 5 commands: add, delete, mod, show and find). These map pretty directly to crud (create/remove/update/delete) plus two to view entries.
In all commands show displays the requested entry. find returns a list of entries matching the requested criteria.
Find could replace show but the fact that the data is backed in LDAP and we know the DN structure in advance show allows a single entry to be retrieved given its key.
rob
freeipa-users@lists.fedorahosted.org