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

Andreas Jaeger aj at suse.com
Fri Apr 20 07:04:12 UTC 2018


On 2018-04-20 00:11, Matt Riedemann wrote:
> 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

We use in openstack-manuals "# root-command" and "$ non-root command", see:
https://docs.openstack.org/install-guide/common/conventions.html

so, just add the "#" for thse.

But looking at
https://git.openstack.org/cgit/openstack/nova/tree/doc/source/install/verify.rst#n103,
it is there - so, closed invalid IMHO,

Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter: jaegerandi
  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Felix Imendörffer, Jane Smithard, Graham Norton,
       HRB 21284 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126




More information about the OpenStack-dev mailing list