openstack
/
charm-interface-service-control
Code Issues Proposed changes
Charm Interface - Service Control
8 Commits 1 Branch 0 Tags 116 KiB
Python 100%
Go to file
OpenDev Sysadmins 1655a2c9ee OpenDev Migration Patch 
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
 		2019-04-19 19:42:00 +00:00
unit_tests Fixup repo config 2019-01-09 07:53:26 +01:00
.gitignore Fixup repo config 2019-01-09 07:53:26 +01:00
.gitreview OpenDev Migration Patch 2019-04-19 19:42:00 +00:00
.stestr.conf Fixup repo config 2019-01-09 07:53:26 +01:00
.zuul.yaml Added tox environment for gathering coverage 2019-03-01 14:40:53 +01:00
README.md More RWADME updates 2016-08-31 11:05:30 +00:00
__init__.py Initial commit 2016-08-31 07:25:48 +00:00
copyright Switch to service-control 2016-08-31 10:42:05 +00:00
interface.yaml Change openstack-dev to openstack-discuss 2019-01-10 10:39:39 +08:00
requires.py Switch to service-control 2016-08-31 10:42:05 +00:00
test-requirements.txt Fixup repo config 2019-01-09 07:53:26 +01:00
tox.ini Added tox environment for gathering coverage 2019-03-01 14:40:53 +01:00

README.md

Overview

This interface is used for a charm to request a restart of a service managed by another charm.

Usage

The interface provides the {relation-name}.connected state.

Requesting a restart of all remote services:

@reactive.when('service-control.connected')
def configure(service_control):
    ...
    service_control.request_restart()

Requesting a restart of a specific type of remote services:

@reactive.when('service-control.connected')
def configure(service_control):
    ...
    service_control.request_restart(service_type='neutron')

Metadata

To consume this interface in your charm or layer, add the following to layer.yaml:

includes: ['interface:service-control']

and add a requires interface of type service-control to your charm or layers metadata.yaml eg:

requires:
  neutron-control:
    interface: service-control

Bugs

Please report bugs on Launchpad.

For development questions please refer to the OpenStack Charm Guide.