From 260ad022c92422c3dc4726496e413095d874a0d2 Mon Sep 17 00:00:00 2001 From: dparalen Date: Tue, 12 Dec 2017 20:42:24 +0100 Subject: [PATCH] Follow up conf.py help text This patch follows up on the review from the change I2f7b8d3172f375cf65e759c9b881fcf41649c2f0 updating help text of the purge_dhcp_hostsdir dnsmasq_pxe_filter configuration option. Change-Id: Ice55d954b470ceda92f27a4a81d78eba46adffa7 --- example.conf | 57 +++++++++++++++++++++++++++++++++++----- ironic_inspector/conf.py | 7 ++--- 2 files changed, 55 insertions(+), 9 deletions(-) diff --git a/example.conf b/example.conf index 111b134ae..92bfef706 100644 --- a/example.conf +++ b/example.conf @@ -121,6 +121,10 @@ # log_config_append is set. (string value) #syslog_log_facility = LOG_USER +# Use JSON formatting for logging. This option is ignored if +# log_config_append is set. (boolean value) +#use_json = false + # Log output to standard error. This option is ignored if # log_config_append is set. (boolean value) #use_stderr = false @@ -256,11 +260,15 @@ # (NDB). (boolean value) #mysql_enable_ndb = false -# Timeout before idle SQL connections are reaped. (integer value) +# Connections which have been present in the connection pool longer +# than this number of seconds will be replaced with a new one the next +# time they are checked out from the pool. (integer value) +# Deprecated group/name - [DATABASE]/idle_timeout +# Deprecated group/name - [database]/idle_timeout # Deprecated group/name - [DEFAULT]/sql_idle_timeout # Deprecated group/name - [DATABASE]/sql_idle_timeout # Deprecated group/name - [sql]/idle_timeout -#idle_timeout = 3600 +#connection_recycle_time = 3600 # Minimum number of SQL connections to keep open in a pool. (integer # value) @@ -351,10 +359,10 @@ #dhcp_hostsdir = /var/lib/ironic-inspector/dhcp-hostsdir # Purge the hostsdir upon driver initialization. Setting to false -# makes sense only for deployment of multiple (uncontainerized) -# inspector instances on a single node. In this case, the Operator is -# responsible for setting up a custom cleaning facility. (boolean -# value) +# should only be performed when the deployment of inspector is such +# that there are multiple processes executing inside of the same host +# and namespace. In this case, the Operator is responsible for setting +# up a custom cleaning facility. (boolean value) #purge_dhcp_hostsdir = true # A (shell) command line to start the dnsmasq service upon filter @@ -522,6 +530,23 @@ # endpoint here, then this should *not* be the same endpoint the # service user utilizes for validating tokens, because normal end # users may not be able to reach that endpoint. (string value) +# Deprecated group/name - [keystone_authtoken]/auth_uri +#www_authenticate_uri = + +# DEPRECATED: Complete "public" Identity API endpoint. This endpoint +# should not be an "admin" endpoint, as it should be accessible by all +# end users. Unauthenticated clients are redirected to this endpoint +# to authenticate. Although this endpoint should ideally be +# unversioned, client support in the wild varies. If you're using a +# versioned v2 endpoint here, then this should *not* be the same +# endpoint the service user utilizes for validating tokens, because +# normal end users may not be able to reach that endpoint. This option +# is deprecated in favor of www_authenticate_uri and will be removed +# in the S release. (string value) +# This option is deprecated for removal since Queens. +# Its value may be silently ignored in the future. +# Reason: The auth_uri option is deprecated in favor of +# www_authenticate_uri and will be removed in the S release. #auth_uri = # API version of the admin Identity API endpoint. (string value) @@ -714,6 +739,26 @@ # Missing or empty directories are ignored. (multi valued) #policy_dirs = policy.d +# Content Type to send and receive data for REST based policy check +# (string value) +# Allowed values: application/x-www-form-urlencoded, application/json +#remote_content_type = application/x-www-form-urlencoded + +# server identity verification for REST based policy check (boolean +# value) +#remote_ssl_verify_server_crt = false + +# Absolute path to ca cert file for REST based policy check (string +# value) +#remote_ssl_ca_crt_file = + +# Absolute path to client cert for REST based policy check (string +# value) +#remote_ssl_client_crt_file = + +# Absolute path client key file REST based policy check (string value) +#remote_ssl_client_key_file = + [pci_devices] diff --git a/ironic_inspector/conf.py b/ironic_inspector/conf.py index a262d6981..b8c724578 100644 --- a/ironic_inspector/conf.py +++ b/ironic_inspector/conf.py @@ -217,9 +217,10 @@ DNSMASQ_PXE_FILTER_OPTS = [ 'of the driver.')), cfg.BoolOpt('purge_dhcp_hostsdir', default=True, help=_('Purge the hostsdir upon driver initialization. ' - 'Setting to false makes sense only for deployment of ' - 'multiple (uncontainerized) inspector instances on a ' - 'single node. In this case, the Operator is ' + 'Setting to false should only be performed when the ' + 'deployment of inspector is such that there are ' + 'multiple processes executing inside of the same host ' + 'and namespace. In this case, the Operator is ' 'responsible for setting up a custom cleaning ' 'facility.')), cfg.StrOpt('dnsmasq_start_command', default='',