summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBen Nemec <bnemec@redhat.com>2019-03-26 16:08:44 +0000
committerBen Nemec <bnemec@redhat.com>2019-03-26 20:00:00 +0000
commitc30d9c0a08f064b36a6ebb5fba1f2d6d2d9aa8fb (patch)
tree28e44f790145467338df1b4273fdd095f8acf238 /doc
parentc6631d3825127f59a47e4986c735b1c4820eb750 (diff)
downloadoslo-config-c30d9c0a08f064b36a6ebb5fba1f2d6d2d9aa8fb.tar.gz
Add exclude-groups option to config validator
When dynamic groups are used, the sample config data may not know about those group names. As a result, validation of such files will always fail. This makes it hard to automate config checks since the output would need to be inspected manually to verify that the missing options are all from the dynamic group. Ideally, we would provide some way to map sample config groups to the dynamic group name used in the actual config, but that would be more complicated and still might not work in every case if a project doesn't include sample sections for a dynamic group (although they _should_ be doing so). Allowing certain group names to be excluded from validation lets us to solve this problem in a simple way and maintain validation of 99%[0] of the config options and enables the validation to be scripted since it won't need manual verification of the error output. Change-Id: I352fd48f86ecb876fe26a5e50e9a2633af1fff3d 0: citation needed ;-)
Diffstat (limited to 'doc')
-rw-r--r--doc/source/cli/validator.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/source/cli/validator.rst b/doc/source/cli/validator.rst
index 637aeeb..b508b71 100644
--- a/doc/source/cli/validator.rst
+++ b/doc/source/cli/validator.rst
@@ -61,3 +61,12 @@ a sample config file ``config-data.yaml`` created by the config generator::
ERROR:root:keystone_authtoken/project_name not found
ERROR:root:keystone_authtoken/password not found
ERROR:root:keystone_authtoken/auth_url not found
+
+Handling Dynamic Groups
+-----------------------
+
+Some services register group names dynamically at runtime based on other
+configuration. This is problematic for the validator because these groups won't
+be present in the sample config data. The ``--exclude-group`` option for the
+validator can be used to ignore such groups and allow the other options in a
+config file to be validated normally.