From bfdade28ed05e5346808e020e9c62efa4104f036 Mon Sep 17 00:00:00 2001 From: Peter Hamilton Date: Tue, 14 Feb 2017 17:38:47 -0500 Subject: [PATCH] Update the project README This change updates the README for the barbican_tempest_plugin, removing dead links and default boilerplate text and replacing it with basic information about the plugin. Change-Id: I7aaaad934db89e268bd54a8d28d0e77624531022 Depends-On: I3249fb879f519da63129e0ec5117377a21094974 Implements: bp tempest-plugin --- README.rst | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/README.rst b/README.rst index 5e2dc29..20b4c50 100644 --- a/README.rst +++ b/README.rst @@ -1,19 +1,25 @@ =============================== -barbican_tempest_plugin +Tempest Integration of Barbican =============================== -OpenStack barbican tempest tests. +This project defines a tempest plugin containing tests used to verify the +functionality of a barbican installation. The plugin will automatically load +these tests into tempest. -Please fill here a long description which must be at least 3 lines wrapped on -80 cols, so that distribution package maintainers can use it in their packages. -Note that this is a hard requirement. +Dependencies +------------ +The barbican_tempest_plugin tests the barbican quota API, which requires the +existence of the 'key-manager:service-admin' role in barbican. The quota API +tests will fail if this role is not defined. -* Free software: Apache license -* Documentation: http://docs.openstack.org/developer/barbican_tempest_plugin -* Source: http://git.openstack.org/cgit/openstack/barbican_tempest_plugin -* Bugs: http://bugs.launchpad.net/barbican +Developers +---------- +For more information on barbican, refer to: +http://docs.openstack.org/developer/barbican/ -Features --------- +For more information on tempest plugins, refer to: +http://docs.openstack.org/developer/tempest/plugin.html#using-plugins -* TODO +Bugs +---- +Please report bugs to: http://bugs.launchpad.net/barbican