From 5736c676b8a0bd75f168e62e6c319c26e7527e4c Mon Sep 17 00:00:00 2001 From: Peter Matulis Date: Fri, 9 Jul 2021 13:52:04 -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: I1e53e2d47e81cbcfc80e8f5200f65481e6004769 --- src/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/src/README.md b/src/README.md index fa9827b..2029369 100644 --- a/src/README.md +++ b/src/README.md @@ -57,6 +57,21 @@ to talk to port 6641. Anyone will be allowed to connect to port 6642. +## 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-central]. @@ -76,3 +91,4 @@ For general questions please refer to the [OpenStack Charm Guide][cg]. [vault-charm]: https://jaas.ai/vault [ovn-chassis-charm]: https://jaas.ai/ovn-chassis [ovn-dedicated-chassis-charm]: https://jaas.ai/ovn-dedicated-chassis +[cdg-deferred-service-events]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/deferred-events.html