<div dir="ltr"><div>networking-sfc has many overlapping areas with tacker and the command names can conflict, so I believe it is worth shared in this thread.</div><div><br></div><div>networking-sfc team is now implementing OSC commands (as neutronclient OSC plugin).<br></div><div>Their command name proposal can be found at <a href="https://review.openstack.org/#/c/409759/">https://review.openstack.org/#/c/409759/</a></div><div>and command names are like <a href="https://review.openstack.org/#/c/409759/30/doc/source/usage/osc/v2/networking-sfc.rst">https://review.openstack.org/#/c/409759/30/doc/source/usage/osc/v2/networking-sfc.rst</a></div><div><br></div><div>As of now, networking-sfc commands are like:</div><div> openstack sfc port chain create<br></div><div> openstack sfc port pair group create</div><div> openstack sfc port pair create</div><div> openstack sfc flow classifier create</div><div><br></div><div>We would like to use 'sfc' (or 'network sfc') and </div><div>hope the tacker team avoid conflicts and confusions between tacker and networking-sfc commands.</div><div><br></div><div>Personally, 'sfc' is not a well-known abbreviation, but the full spelling 'service function chaining' looks too long.</div><div>I don't think users want to type 'openstack service function chaining port chain group create'.... :-( It loses usability significantly.</div><div><br></div><div>Thanks,</div><div>Akihiro</div><div><div><div class="gmail_extra"><br><div class="gmail_quote">2017-04-13 8:23 GMT+09:00 Trinath Somanchi <span dir="ltr"><<a href="mailto:trinath.somanchi@nxp.com" target="_blank">trinath.somanchi@nxp.com</a>></span>:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<div lang="EN-US">
<div class="gmail-m_-1149353619714227132WordSection1">
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif">But if we don’t prefix, then we are afraid we might confuse users with command names and conflict with other projects.<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif">Example, ‘network-service’ if we follow the existing way, then
<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif"> <u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif"> $> openstack network service create
<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif">might confuse the user in context that it’s a neutron/networking command. Is that not True?<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif">Also, for some other commands, like sfc, we might end up conflict with networking-sfc.<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif">Like, $> openstack sfc show (or) openstack service function chain show
<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif">With some of the other commands, there are abbreviations like
<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif">$> openstack vnffgd create
<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif">If the above command must be split to words, it spells like,<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif">$> openstack virtual network function forwarding graph descriptor create <other_args ><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif">If we elaborate this way the command itself will be a lengthy string where user has a very lengthy command.
<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif"><u></u> <u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif">Any suggestions for these?<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif;color:rgb(47,84,150)">Thanks,<u></u><u></u></span></p>
<p class="MsoNormal"><b><span lang="EN-GB" style="font-size:11pt;font-family:"bradley hand itc";color:rgb(31,56,100)">Trinath Somanchi.<u></u><u></u></span></b></p>
<p class="MsoNormal"><span lang="EN-GB" style="font-size:10pt;color:rgb(47,84,150)"><u></u> <u></u></span></p>
<p class="MsoNormal"><span lang="EN-GB" style="font-size:10pt;color:rgb(47,84,150)">Digital Networking | NXP – Hyderabad – INDIA.<u></u><u></u></span></p><span class="gmail-">
<p class="MsoNormal"><span lang="EN-GB" style="font-size:10pt;color:rgb(50,62,79)">Email:
<u><a href="mailto:trinath.somanchi@nxp.com" target="_blank"><span style="color:rgb(50,62,79)">trinath.somanchi@nxp.com</span></a><u></u><u></u></u></span></p>
<p class="MsoNormal"><span lang="EN-GB" style="font-size:10pt;color:rgb(50,62,79)">Mobile: <a href="tel:+91%2098662%2035130" value="+919866235130" target="_blank">+91 9866235130</a> | Off: <a href="tel:+91%2040%203350%204051" value="+914033504051" target="_blank">+91 4033504051</a><u></u><u></u></span></p>
</span><p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif"><img border="0" width="340" height="4" style="width: 3.5416in; height: 0.0416in;" id="gmail-m_-1149353619714227132Picture_x0020_1" src="cid:image001.png@01D2B410.67DD79D0" alt="cid:image001.png@01D28854.B7934C80"><span style="color:rgb(31,73,125)"><u></u><u></u></span></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif"><u></u> <u></u></span></p>
<p class="MsoNormal"><b><span style="font-size:11pt;font-family:calibri,sans-serif">From:</span></b><span style="font-size:11pt;font-family:calibri,sans-serif"> Dean Troyer [mailto:<a href="mailto:dtroyer@gmail.com" target="_blank">dtroyer@gmail.com</a>]
<br>
<b>Sent:</b> Wednesday, April 12, 2017 10:17 PM<br>
<b>To:</b> OpenStack Development Mailing List (not for usage questions) <<a href="mailto:openstack-dev@lists.openstack.org" target="_blank">openstack-dev@lists.<wbr>openstack.org</a>><br>
<b>Subject:</b> Re: [openstack-dev] [Tacker][OSC] Command naming specs<u></u><u></u></span></p><div><div class="gmail-h5">
<p class="MsoNormal"><u></u> <u></u></p>
<div>
<div>
<div>
<p class="MsoNormal">On Wed, Apr 12, 2017 at 2:08 AM, Trinath Somanchi <<a href="mailto:trinath.somanchi@nxp.com" target="_blank">trinath.somanchi@nxp.com</a>> wrote:<u></u><u></u></p>
<blockquote style="border-top:none;border-right:none;border-bottom:none;border-left:1pt solid rgb(204,204,204);padding:0in 0in 0in 6pt;margin-left:4.8pt;margin-right:0in">
<div>
<div>
<p class="MsoNormal">Tacker being NFVO+VNFM - an NFV component, we have taken ‘nfv’ as the prefix.<u></u><u></u></p>
</div>
</div>
</blockquote>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">Note that OSC itself does not use 'command prefixes', it names resources with enough specificity to make them unique. Sometimes that looks like a proefix, but it is not.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:calibri,sans-serif"><u></u> <u></u></span></p>
</div>
<blockquote style="border-top:none;border-right:none;border-bottom:none;border-left:1pt solid rgb(204,204,204);padding:0in 0in 0in 6pt;margin-left:4.8pt;margin-right:0in">
<div>
<div>
<p class="MsoNormal">For the below commands, for readability, we have added ‘-‘ within the command names.<u></u><u></u></p>
<p class="MsoNormal">Like,<u></u><u></u></p>
<p class="MsoNormal"> <span style="font-family:consolas">network-service</span>, <span style="font-family:consolas">vnf-forwarding-graph, service-function-chain,</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-family:consolas"> network-flow-classifier, network-forwarding-path.</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-family:consolas"> </span><u></u><u></u></p>
<p class="MsoNormal">But the existing OSC commands don’t have a ‘-‘ in between the command names.<u></u><u></u></p>
</div>
</div>
</blockquote>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">The OSC command structure specifically does not use dashes or underscores as separators, it uses spaces. We want commands to be words. Dashes are only used in option names due to option parsing rules.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">Specifically in networking there are a large number of resources that are hard to concisely name. Plugins are of course free to do what they want but we encourage them to use the OSC guidelines, and we know that users _really_ appreciate
staying consistent.<u></u><u></u></p>
</div>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">There are places where you may feel forced to use abbreviations ('vnf' in your example above). Those are discouraged, but we also recognize that they are often the most common usage ('IP' in IP address for example) and where that usage
is common is fine. Again, networking is an area where many things are commonly known only by their abbreviation, and this usage is in fact expected by users. In the end, picking commands that are what users would expect to search for is what they appreciate
the most.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">dt<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<p class="MsoNormal">-- <u></u><u></u></p>
<div>
<p class="MsoNormal"><br>
Dean Troyer<br>
<a href="mailto:dtroyer@gmail.com" target="_blank">dtroyer@gmail.com</a><u></u><u></u></p>
</div>
</div>
</div>
</div></div></div>
</div>
<br>______________________________<wbr>______________________________<wbr>______________<br>
OpenStack Development Mailing List (not for usage questions)<br>
Unsubscribe: <a href="http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe" rel="noreferrer" target="_blank">OpenStack-dev-request@lists.<wbr>openstack.org?subject:<wbr>unsubscribe</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" rel="noreferrer" target="_blank">http://lists.openstack.org/<wbr>cgi-bin/mailman/listinfo/<wbr>openstack-dev</a><br>
<br></blockquote></div><br></div></div></div></div>