Charm Interface - Service Control

Go to file

Camille Rodriguez d3d612c7da Avoid pollution and false positives with tox.ini - removing sitepackages in tox.ini to avoid test env pollution - skip_missing_interpreters in tox.ini set to False to avoid false positives by skipping missing interpreters. Change-Id: Ia9fe2170634183f10a70016d809742a36d1f15ff		2019-08-27 09:19:02 -04: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	Add Python 3 Train unit tests	2019-07-30 10:16:52 -04: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	Avoid pollution and false positives with tox.ini	2019-08-27 09:19:02 -04:00

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')

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

Please report bugs on Launchpad.

For development questions please refer to the OpenStack Charm Guide.