[Openstack] documentation of flags, introducing of a naming convention for flags
Diego Parrilla Santamaría
diego.parrilla.santamaria at gmail.com
Tue Feb 22 15:07:55 UTC 2011
I have counted 160 configuration parameters in Nova, and only about 15
are documented. This is clearly one of the areas of improvement in the
I have been fighting with Nova Bexar in not-so-standard configurations
and deployments and believe me, I would appreciate more information
about what they do.
Something that took me a lot of time to figure out was what are
'common' flags for all the components in nova, and what are 'specific'
flags for each component. If you are setting up an environment with
(compute,network,volume,api,objectstore,scheduler...) this is a must
if you want to have more than a couple of servers running Nova.
nubeblog.com | nubeblog at nubeblog.com | twitter.com/nubeblog
+34 649 94 43 29
On Tue, Feb 22, 2011 at 3:29 PM, Jay Pipes <jaypipes at gmail.com> wrote:
> <can of worms>
> Just use optparse/argparse. paste.deploy handles configuration files
> already, which is where most "flags" should really be... gflags adds
> unneeded complexity for no real gains, IMHO. Swift and Glance do just
> fine without gflags, as do the vast majority of Python projects. As
> for documentation of program options, the most common practice in the
> open source world is to document configuration options in the example
> configuration files that ship with your project, and document command
> line options "inline" to show up in --help output.
> </can of worms>
> On Tue, Feb 22, 2011 at 1:37 AM, Christian Berendt
> <berendt at b1-systems.de> wrote:
>> At the moment we're using a lot of flags spread all over the code.
>> a) we should create a useful documentation including all flags
>> b) we should introduce a naming convention for new flags and we should
>> rename existing flags
>> all flags related to default values are starting with "default_", all
>> flags related to a path are starting with "path_".
>> Looks like most of the flags have good names at the moment, but I think
>> we should write it down in the wiki or the developer documentation to
>> reduce the possibility of bad names in the future.
>> c) if it's possible we should collect all flags in one file
>> At the moment the flags are defined in the files where they are used. I
>> think it would be nice to have on file, for example nova/flags.py,
>> including all flags used all over the code.
>> Bye, Christian.
>> Christian Berendt
>> Linux / Unix Consultant & Developer
>> Tel.: +49-171-5542175
>> Mail: berendt at b1-systems.de
>> B1 Systems GmbH
>> Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
>> GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537
>> Mailing list: https://launchpad.net/~openstack
>> Post to : openstack at lists.launchpad.net
>> Unsubscribe : https://launchpad.net/~openstack
>> More help : https://help.launchpad.net/ListHelp
> Mailing list: https://launchpad.net/~openstack
> Post to : openstack at lists.launchpad.net
> Unsubscribe : https://launchpad.net/~openstack
> More help : https://help.launchpad.net/ListHelp
More information about the Openstack