x/charm-ovn-dedicated-chassis
Code Issues Proposed changes

Mention deferred service events in README

Browse Source 
This is a boilerplate section that will eventually
be added to the README for every charm that supports
the deferred restart feature.

Change-Id: Ic5728b7254a2a48e672026345620780ac65bf8a9
This commit is contained in:
Peter Matulis 2021-07-09 13:57:37 -04:00
parent 257bb43029
commit 4b9d205e00
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

@ -84,6 +84,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-dedicated-chassis].
@ -100,3 +115,4 @@ For general questions please refer to the [OpenStack Charm Guide][cg].
[ovn-central-charm]: https://jaas.ai/ovn-central
[ovn-chassis-charm]: https://jaas.ai/ovn-chassis
[openstack-base-bundle]: https://github.com/openstack-charmers/openstack-bundles/blob/master/development/openstack-base-bionic-ussuri-ovn/bundle.yaml
[cdg-deferred-service-events]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/deferred-events.html