x
/
charm-ovn-chassis
Code Issues Proposed changes

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
This commit is contained in:
Peter Matulis 2021-07-09 13:55:25 -04:00
parent 857fa87024
commit b9093ab021
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/README.md
View File

@ -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