diff --git a/README.md b/README.md index 11a77da1..892b24ce 100644 --- a/README.md +++ b/README.md @@ -175,3 +175,23 @@ Note: If data-port is specified, the value of ext-port is ignored. This prevents misconfiguration of the charm. Aditionaly, in this scenario an error message is logged and the unit is marked as blocked in order to notify about the misconfiguration. + +# Deferred service events + +Operational or maintenance procedures applied to a cloud often lead to the +restarting of various OpenStack services and/or the calling of certain charm +hooks. Although normal, such events can be undesirable due to the service +interruptions they can cause. + +The deferred service events feature provides the operator the choice of +preventing these service restarts and hook calls from occurring, which can then +be resolved at a more opportune time. + +See the [Deferred service events][cdg-deferred-service-events] page in the +[OpenStack Charms Deployment Guide][cdg] for an in-depth treatment of this +feature. + + + +[cdg]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide +[cdg-deferred-service-events]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/deferred-events.html