diff --git a/ironic/conf/conductor.py b/ironic/conf/conductor.py index 3a974a35cd..bffaa201d2 100644 --- a/ironic/conf/conductor.py +++ b/ironic/conf/conductor.py @@ -276,7 +276,7 @@ opts = [ default=True, mutable=True, help=_('Allow deleting nodes which are in state ' - '\'available\'. Defaults to True.')), + '\'available\'.')), cfg.BoolOpt('enable_mdns', default=False, help=_('Whether to enable publishing the baremetal API ' 'endpoint via multicast DNS.')), @@ -370,8 +370,8 @@ opts = [ min=0, mutable=True, help=_('Maximum number of history entries which will be stored ' - 'in the database per node. Default is 300. This setting ' - 'excludes the minimum number of days retained using the ' + 'in the database per node. This setting excludes ' + 'the minimum number of days retained using the ' '[conductor]node_history_minimum_days setting.')), cfg.IntOpt('node_history_cleanup_interval', min=0, @@ -379,8 +379,7 @@ opts = [ mutable=False, help=_('Interval in seconds at which node history entries ' 'can be cleaned up in the database. Setting to 0 ' - 'disables the periodic task. Defaults to once a day, ' - 'or 86400 seconds.')), + 'disables the periodic task.')), cfg.IntOpt('node_history_cleanup_batch_count', min=0, default=1000, @@ -389,9 +388,8 @@ opts = [ 'from the database when performing clean-up. ' 'Deletes are performed by node, and a node with excess ' 'records for a node will still be deleted. ' - 'Defaults to 1000. Operators who find node history ' - 'building up may wish to ' - 'lower this threshold and decrease the time between ' + 'Operators who find node history building up may wish ' + 'to lower this threshold and decrease the time between ' 'cleanup operations using the ' '``node_history_cleanup_interval`` setting.')), cfg.IntOpt('node_history_minimum_days', @@ -410,26 +408,23 @@ opts = [ mutable=False, help=_('Interval in seconds at which stale conductor entries ' 'can be cleaned up from the database. Setting to 0 ' - 'disables the periodic task. Defaults to 86400 (1 day).' - )), + 'disables the periodic task.')), cfg.IntOpt('conductor_cleanup_timeout', min=60, default=1209600, mutable=True, help=_('Timeout in seconds after which offline conductors ' 'are considered stale and can be cleaned up from the ' - 'database. It defaults to two weeks (1209600 seconds) ' - 'and is always required to be at least 3x larger than ' - '[conductor]heartbeat_timeout since if otherwise, ' - 'active conductors might be mistakenly removed from ' - 'the database.')), + 'database. THis is always required to be at least 3x ' + 'larger than [conductor]heartbeat_timeout since if ' + 'otherwise, active conductors might be mistakenly ' + 'removed from the database.')), cfg.IntOpt('conductor_cleanup_batch_size', min=1, default=50, mutable=True, help=_('The maximum number of stale conductor records to clean ' - 'up from the database in a single cleanup operation. ' - 'Defaults to 50.')), + 'up from the database in a single cleanup operation.')), cfg.MultiOpt('verify_step_priority_override', item_type=types.Dict(), default={}, diff --git a/ironic/conf/default.py b/ironic/conf/default.py index bfd505e4a8..358b8990cd 100644 --- a/ironic/conf/default.py +++ b/ironic/conf/default.py @@ -453,8 +453,7 @@ webserver_opts = [ 'certificate for SSL verification. If the path does ' 'not exist, the behavior is same as when this value ' 'is set to True i.e the certificates present in the ' - 'standard path are used for SSL verification.' - 'Defaults to True.')), + 'standard path are used for SSL verification.')), cfg.IntOpt('webserver_connection_timeout', default=60, help=_('Connection timeout when accessing/interacting with ' diff --git a/ironic/conf/deploy.py b/ironic/conf/deploy.py index 3811ff6f56..2cfda7b262 100644 --- a/ironic/conf/deploy.py +++ b/ironic/conf/deploy.py @@ -69,15 +69,14 @@ opts = [ default=True, mutable=True, help=_('Whether to support the use of ATA Secure Erase ' - 'during the cleaning process. Defaults to True.')), + 'during the cleaning process.')), cfg.BoolOpt('enable_nvme_secure_erase', default=True, mutable=True, help=_('Whether to support the use of NVMe Secure Erase ' 'during the cleaning process. Currently nvme-cli ' 'format command is supported with user-data and ' - 'crypto modes, depending on device capabilities.' - 'Defaults to True.')), + 'crypto modes, depending on device capabilities.')), cfg.IntOpt('erase_devices_priority', mutable=True, help=_('Priority to run in-band erase devices via the Ironic ' @@ -115,7 +114,7 @@ opts = [ mutable=True, help=_('During shred, overwrite all block devices N times with ' 'random data. This is only used if a device could not ' - 'be ATA Secure Erased. Defaults to 1.')), + 'be ATA Secure Erased.')), cfg.BoolOpt('shred_final_overwrite_with_zeros', default=True, mutable=True, @@ -124,7 +123,7 @@ opts = [ "the device even when " "deploy.shred_random_overwrite_iterations is 0. This " "option is only used if a device could not be ATA " - "Secure Erased. Defaults to True.")), + "Secure Erased.")), cfg.BoolOpt('continue_if_disk_secure_erase_fails', default=False, mutable=True, @@ -145,8 +144,7 @@ opts = [ cfg.BoolOpt('power_off_after_deploy_failure', default=True, mutable=True, - help=_('Whether to power off a node after deploy failure. ' - 'Defaults to True.')), + help=_('Whether to power off a node after deploy failure.')), cfg.StrOpt('default_boot_mode', choices=[(boot_modes.UEFI, _('UEFI boot mode')), (boot_modes.LEGACY_BIOS, _('Legacy BIOS boot mode'))], diff --git a/ironic/conf/glance.py b/ironic/conf/glance.py index 54b5ada431..efd8571474 100644 --- a/ironic/conf/glance.py +++ b/ironic/conf/glance.py @@ -40,17 +40,16 @@ opts = [ cfg.IntOpt('swift_temp_url_duration', default=1200, help=_('The length of time in seconds that the temporary URL ' - 'will be valid for. Defaults to 20 minutes. If some ' - 'deploys get a 401 response code when trying to ' - 'download from the temporary URL, try raising this ' - 'duration. This value must be greater than or equal to ' - 'the value for ' + 'will be valid for. If some deploys get a 401 response ' + 'code when trying to download from the temporary URL, ' + 'try raising this duration. This value must be greater ' + 'than or equal to the value for ' 'swift_temp_url_expected_download_start_delay')), cfg.BoolOpt('swift_temp_url_cache_enabled', default=False, help=_('Whether to cache generated Swift temporary URLs. ' 'Setting it to true is only useful when an image ' - 'caching proxy is used. Defaults to False.')), + 'caching proxy is used.')), cfg.IntOpt('swift_temp_url_expected_download_start_delay', default=0, min=0, help=_('This is the delay (in seconds) from the time of the ' @@ -62,8 +61,7 @@ opts = [ 'temporary URL caching is enabled this will determine ' 'if a cached entry will still be valid when the ' 'download starts. swift_temp_url_duration value must be ' - 'greater than or equal to this option\'s value. ' - 'Defaults to 0.')), + 'greater than or equal to this option\'s value.')), cfg.URIOpt( 'swift_endpoint_url', schemes=['http', 'https'], @@ -79,7 +77,7 @@ opts = [ 'swift_api_version', default='v1', help=_('The Swift API version to create a temporary URL for. ' - 'Defaults to "v1". Swift temporary URL format: ' + 'Swift temporary URL format: ' '"endpoint_url/api_version/account/container/object_id"')), cfg.StrOpt( 'swift_account', diff --git a/ironic/conf/ilo.py b/ironic/conf/ilo.py index 6d1c52dd20..551111ace0 100644 --- a/ironic/conf/ilo.py +++ b/ironic/conf/ilo.py @@ -90,7 +90,7 @@ opts = [ 'if False the driver will ignore verifying the SSL ' 'certificate. If it\'s a path the driver will use the ' 'specified certificate or one of the certificates in ' - 'the directory. Defaults to True.')), + 'the directory.')), cfg.StrOpt('default_boot_mode', default='auto', choices=[('auto', _('based on boot mode settings on the ' diff --git a/ironic/conf/ipmi.py b/ironic/conf/ipmi.py index 9b1501afc7..5e86894571 100644 --- a/ironic/conf/ipmi.py +++ b/ironic/conf/ipmi.py @@ -78,8 +78,9 @@ opts = [ cfg.BoolOpt('store_cred_in_env', default=False, help=_('Boolean flag to determine IPMI password persistence ' - 'method. Defaults to False (file-based persistence). ' - )), + 'method. When True, credentials are stored in ' + 'environemnt variables, Otherwise, credentials are ' + 'stored in a file')), cfg.ListOpt('cipher_suite_versions', default=[], help=_('List of possible cipher suites versions that can ' diff --git a/ironic/conf/pxe.py b/ironic/conf/pxe.py index e4c912192d..bf4937319e 100644 --- a/ironic/conf/pxe.py +++ b/ironic/conf/pxe.py @@ -152,7 +152,7 @@ opts = [ cfg.IntOpt('ipxe_timeout', default=0, help=_('Timeout value (in seconds) for downloading an image ' - 'via iPXE. Defaults to 0 (no timeout)')), + 'via iPXE. Timeout is disabled when this value is 0')), cfg.IntOpt('boot_retry_timeout', min=60, help=_('Timeout (in seconds) after which PXE boot should be ' diff --git a/ironic/conf/vnc.py b/ironic/conf/vnc.py index 6a7c279005..24d570b5fe 100644 --- a/ironic/conf/vnc.py +++ b/ironic/conf/vnc.py @@ -42,8 +42,7 @@ opts = [ 'browser page ' '(for example, "http://127.0.0.1:6090/vnc_auto.html"). ' 'If the API is operating behind a proxy, you ' - 'will want to change this to represent the proxy\'s URL. ' - 'Defaults to None. '), + 'will want to change this to represent the proxy\'s URL.'), cfg.BoolOpt( 'enable_ssl', default=False,