Charm Interface - Barbican HSM plugin

Go to file

wanghui 6bbb7eb05a Add py36 tox environment Change-Id: Ib22c98991025688081e443dfc8806ece43d5250e		2018-11-07 20:20:30 +08:00
.gitreview	Update tox to remove deprecated pip option; add .gitreview	2018-10-04 12:57:07 +02:00
.zuul.yaml	import zuul job settings from project-config	2018-10-04 15:24:04 +02:00
interface.yaml	Rename the interface to barbican-hsm	2016-07-13 16:31:23 +00:00
LICENSE	Add LICENSE, copyright headers and docstrings	2016-07-01 14:49:41 +00:00
provides.py	Rename the interface to barbican-hsm	2016-07-13 16:31:23 +00:00
README.md	Rename the interface to barbican-hsm	2016-07-13 16:31:23 +00:00
requires.py	Rename the interface to barbican-hsm	2016-07-13 16:31:23 +00:00
test-requirements.txt	Initial interface files	2016-06-23 13:40:04 +00:00
tox.ini	Add py36 tox environment	2018-11-07 20:20:30 +08:00

README.md

Overview

This interface supports the integration between Barbican and HSM devices.

Usage

No explicit handler is required to consume this interface in charms that consume this interface.

The interface provides hsm.connected and hsm.available states.

For an HSM subordinate charm

The hsm.connected state indicates that the Barbican principle charms has been connected to. At this point the plugin data required for to configure the HSM from Barbican should be presented.

metadata

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

includes: ['interface:barbican-hsm']

and add a provides interface of type hsm to your charm or layers metadata.yaml:

provides:
  hsm:
    interface: barbican-hsm
    scope: container

Please see the example 'Barbican SoftHSM' charm for an example of how to author an HSM charm.

Bugs

Please report bugs on Launchpad.

For development questions please refer to the OpenStack Charm Guide.