From b9093ab021d5bd4aeaf2b9ad7f3ed1eb7d3f31c0 Mon Sep 17 00:00:00 2001 From: Peter Matulis Date: Fri, 9 Jul 2021 13:55: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: I50c92dc0862cf1824e226ac5773ea3eda87a8bd3 --- src/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/src/README.md b/src/README.md index bc0c93c..a53baaf 100644 --- a/src/README.md +++ b/src/README.md @@ -89,6 +89,21 @@ that network. Networks for use with external Layer2 connectivity should have mappings present on all chassis with potential to host the consuming payload. +## 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. + # Bugs Please report bugs on [Launchpad][lp-ovn-chassis]. @@ -107,3 +122,4 @@ For general questions please refer to the [OpenStack Charm Guide][cg]. [lp-ovn-chassis]: https://bugs.launchpad.net/charm-ovn-chassis/+filebug [openstack-base-bundle]: https://github.com/openstack-charmers/openstack-bundles/blob/master/development/openstack-base-focal-ussuri-ovn/bundle.yaml [nova-metadata]: https://docs.openstack.org/nova/latest/user/metadata.html +[cdg-deferred-service-events]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/deferred-events.html