From 80d390961de2e7139f0b571fa9bd2b87ffedd918 Mon Sep 17 00:00:00 2001 From: Peter Matulis Date: Mon, 14 Jun 2021 12:36:25 -0400 Subject: [PATCH] Mention deferred service events in README This is a boilerplate section that will eventually be added to the README for every charm that supports the deferred restart feature. Change-Id: I1226ee0039cca11dd8c341e0f511de125ae8c633 --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index eba2c678..591a372a 100644 --- a/README.md +++ b/README.md @@ -123,3 +123,24 @@ charm's instance-mtu option can be used to reduce instance MTU via DHCP. juju set neutron-gateway instance-mtu=1400 Note that this option was added in Havana and will be ignored in older releases. + +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