openstack/cloudkitty
Code Issues Proposed changes

Fix description of orchestrator parameters

Browse Source 
- coordination_url is not driver URL but backend URL. Driver is
  determined according to the backend.

- The parameter description should not use abbreviations, as these
  can confuse users.

Change-Id: I16eb47e161ae826393d113082091c292d097fc03
This commit is contained in:
Takashi Kajinami 2022-02-13 11:36:42 +09:00 committed by Pierre Riteau
parent 839fdf7b0a
commit 9d917cc1cf
2 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
cloudkitty/orchestrator.py
View File

@ -51,14 +51,15 @@ orchestrator_opts = [
cfg.StrOpt( cfg.StrOpt(
'coordination_url', 'coordination_url',
secret=True, secret=True,
help='Coordination driver URL', help='Coordination backend URL',
default='file:///var/lib/cloudkitty/locks'), default='file:///var/lib/cloudkitty/locks'),
cfg.IntOpt( cfg.IntOpt(
'max_workers', 'max_workers',
default=multiprocessing.cpu_count(), default=multiprocessing.cpu_count(),
sample_default=4, sample_default=4,
min=1, min=1,
help='Max nb of workers to run. Defaults to the nb of available CPUs'), help='Maximal number of workers to run. Defaults to the number of '
'available CPUs'),
cfg.IntOpt('max_threads', cfg.IntOpt('max_threads',
# NOTE(peschk_l): This is the futurist default # NOTE(peschk_l): This is the futurist default
default=multiprocessing.cpu_count() * 5, default=multiprocessing.cpu_count() * 5,
@ -67,7 +68,7 @@ orchestrator_opts = [
deprecated_name='max_greenthreads', deprecated_name='max_greenthreads',
advanced=True, advanced=True,
help='Maximal number of threads to use per worker. Defaults to ' help='Maximal number of threads to use per worker. Defaults to '
'5 times the nb of available CPUs'), '5 times the number of available CPUs'),
] ]
CONF.register_opts(orchestrator_opts, group='orchestrator') CONF.register_opts(orchestrator_opts, group='orchestrator')

8
doc/source/_static/cloudkitty.conf.sample
View File

@ -750,11 +750,11 @@
# From cloudkitty.common.config # From cloudkitty.common.config
# #
# Coordination driver URL (string value) # Coordination backend URL (string value)
#coordination_url = file:///var/lib/cloudkitty/locks #coordination_url = file:///var/lib/cloudkitty/locks
# Max nb of workers to run. Defaults to the nb of available CPUs # Maximal number of workers to run. Defaults to the number of
# (integer value) # available CPUs (integer value)
# Minimum value: 1 # Minimum value: 1
# #
# This option has a sample default set, which means that # This option has a sample default set, which means that
@ -763,7 +763,7 @@
#max_workers = 4 #max_workers = 4
# Maximal number of threads to use per worker. Defaults to 5 times the # Maximal number of threads to use per worker. Defaults to 5 times the
# nb of available CPUs (integer value) # number of available CPUs (integer value)
# Minimum value: 1 # Minimum value: 1
# Deprecated group/name - [orchestrator]/max_greenthreads # Deprecated group/name - [orchestrator]/max_greenthreads
# Advanced Option: intended for advanced users and not used # Advanced Option: intended for advanced users and not used