[openstack-dev] [docs] When should we say 'run as root' in the docs?

William M Edmonds edmondsw at us.ibm.com
Thu Apr 19 22:32:36 UTC 2018



Matt Riedemann <mriedemos at gmail.com> wrote on 04/19/2018 06:11:58 PM:
> How loose are we with saying things like, "you should run this as root"
> in the docs?
>
> I was triaging this nova bug [1] which is saying that the docs should
> tell you to run nova-status (which implies also nova-manage) as root,
> but isn't running admin-level CLIs implied that you need root, or
> something with access to those commands (sudo)?
>
> I'm not sure how prescriptive we should be with stuff like this in the
> docs because if we did start saying this, I feel like we'd have to say
> it everywhere.
>
> [1] https://bugs.launchpad.net/nova/+bug/1764530

Maybe instead of treating this as a docs bug, we should fix the command to
return a nicer error when run as non-root. Presumably the caller has root
access, but forgot they were logged in as something else or forgot sudo.
Dumping that stack trace on them is more likely to confuse than anything.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20180419/fabb4277/attachment.html>


More information about the OpenStack-dev mailing list