Charm Interface - Barbican Secrets plugin
Go to file
Hervé Beraud 4cae88ff57 Use unittest.mock instead of mock
The mock third party library was needed for mock support in py2
runtimes. Since we now only support py36 and later, we can use the
standard lib unittest.mock module instead.

Note that https://github.com/openstack/charms.openstack is used during tests
and he need `mock`, unfortunatelly it doesn't declare `mock` in its
requirements so it retrieve mock from other charm project (cross dependency).
So we depend on charms.openstack first and when
Ib1ed5b598a52375e29e247db9ab4786df5b6d142 will be merged then CI
will pass without errors.

Depends-On: Ib1ed5b598a52375e29e247db9ab4786df5b6d142
Change-Id: I17855080c832cd94783c279449f17c58ab5e3d9c
2021-12-15 09:56:53 +00:00
unit_tests Use unittest.mock instead of mock 2021-12-15 09:56:53 +00:00
.gitignore Migrate from testr to stestr 2021-02-10 12:11:41 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:42:56 +00:00
.stestr.conf Initial commit of charm interface skeleton 2018-10-11 11:46:45 +02:00
.travis.yml Add barbican-secrets interface code and unit tests 2018-10-17 16:20:39 +02:00
.zuul.yaml Switch to Ussuri jobs 2019-10-31 17:43:22 +08:00
interface.yaml Add barbican-secrets interface code and unit tests 2018-10-17 16:20:39 +02:00
LICENSE Initial commit of charm interface skeleton 2018-10-11 11:46:45 +02:00
provides.py Add barbican-secrets interface code and unit tests 2018-10-17 16:20:39 +02:00
README.md Initial commit of charm interface skeleton 2018-10-11 11:46:45 +02:00
requires.py Add barbican-secrets interface code and unit tests 2018-10-17 16:20:39 +02:00
test-requirements.txt Use unittest.mock instead of mock 2021-12-15 09:56:53 +00:00
tox.ini Migrate from testr to stestr 2021-02-10 12:11:41 +00:00

Overview

This interface supports the integration between Barbican and secrets stores.

Usage

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

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

For an secrets subordinate charm

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

metadata

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

includes: ['interface:barbican-secrets']

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

provides:
  secrets:
    interface: barbican-secrets
    scope: container

Please see the example 'Barbican Vault' charm for an example of how to author an secrets store charm.

Bugs

Please report bugs on Launchpad.

For development questions please refer to the OpenStack Charm Guide.