openstack/ironic-specs
Code Issues Proposed changes

Update 'SIGHUP on ironic services'

Browse Source 
This updates the spec for SIGHUP support to:
1. provide a link to the RFE/bug for the work to make most of the
   ironic configuration options mutable
2. mention that mutable option values cannot be cached forever

This is a follow up to 2298f9895f.

Change-Id: Ib78310e394ed03c63764080081e9e10cecfda036
Partial-Bug: #1585595
This commit is contained in:
Ruby Loo 2017-08-28 16:44:54 -04:00
parent 5b96f09a07
commit d335bf8051
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
specs/approved/sighup_on_ironic_services.rst
View File

@ -69,7 +69,7 @@ Mutable configuration options that will be available are:
* ``[DEFAULT]/pin_release_version`` * ``[DEFAULT]/pin_release_version``
Other ironic configuration options can be made mutable in the future; such Other ironic configuration options can be made `mutable in the future`_; such
changes should have corresponding release notes. The belief is that most, if changes should have corresponding release notes. The belief is that most, if
not all, of the configuration options should be made mutable. However, that is not all, of the configuration options should be made mutable. However, that is
outside the scope of this specification -- which is to lay the groundwork outside the scope of this specification -- which is to lay the groundwork
@ -78,6 +78,9 @@ ironic supports SIGHUP, operators might assume (incorrectly) that this applies
to all configuration options, so we should make other configuration options to all configuration options, so we should make other configuration options
available in a timely fashion. available in a timely fashion.
The value of a mutable configuration option should not be cached; or at least,
if it is cached, the value must be updated upon a SIGHUP occurrence.
Alternatives Alternatives
------------ ------------
@ -175,6 +178,8 @@ Work Items
* change our services so they are launched with ``restart_method='mutate'`` * change our services so they are launched with ``restart_method='mutate'``
* change the desired configuration options so that they are mutable * change the desired configuration options so that they are mutable
* make sure the mutable options are not cached, or if they are, make sure that
they are updated appropriately with a SIGHUP occurrence
Dependencies Dependencies
============ ============
@ -214,3 +219,4 @@ References
.. _`oslo.config library`: http://docs.openstack.org/developer/oslo.config/opts.html?highlight=mutable#option-definitions .. _`oslo.config library`: http://docs.openstack.org/developer/oslo.config/opts.html?highlight=mutable#option-definitions
.. _`mutable option note`: https://github.com/openstack/ironic/blob/ebfc4fe4c4c3910bf8b1229cb75259befa530877/etc/ironic/ironic.conf.sample#L383 .. _`mutable option note`: https://github.com/openstack/ironic/blob/ebfc4fe4c4c3910bf8b1229cb75259befa530877/etc/ironic/ironic.conf.sample#L383
.. _`launched`: https://docs.openstack.org/developer/oslo.service/api/service.html#oslo_service.service.launch .. _`launched`: https://docs.openstack.org/developer/oslo.service/api/service.html#oslo_service.service.launch
.. _`mutable in the future`: https://bugs.launchpad.net/ironic/+bug/1713571