Clean up some initial repo creation boilerplate
Minor cleanup of things not needed for our tempest plugin.
Change-Id: Ib309cb1f87211e82eae0d27fa2464ec13a9deca6
Needed-by: I5ff95ca13f02ed6e0afb35f0d6bb5c36d4111f5a
Implements: blueprint goal-split-tempest-plugin
diff --git a/README.rst b/README.rst
index 27ca590..d7ab3a1 100644
--- a/README.rst
+++ b/README.rst
@@ -1,19 +1,61 @@
-===============================
-cinder_tempest_plugin
-===============================
+===============================================
+Tempest Integration for Cinder
+===============================================
-It contains tempest plugin tests for Cinder.
+This directory contains additional Cinder tempest tests.
-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.
+See the tempest plugin docs for information on using it:
+https://docs.openstack.org/tempest/latest/plugin.html#using-plugins
-* Free software: Apache license
-* Documentation: http://docs.openstack.org/developer/openstack
-* Source: http://git.openstack.org/cgit/cinder-tempest-plugin
-* Bugs: http://bugs.launchpad.net/cinder-tempest-plugin
+To run all tests from this plugin, install cinder into your environment. Then
+from the tempest directory run::
-Features
---------
+ $ tox -e all-plugin -- volume
-* TODO
+
+It is expected that Cinder third party CI's use the all-plugin tox environment
+above for all test runs. Developers can also use this locally to perform more
+extensive testing.
+
+Any typical devstack instance should be able to run all Cinder plugin tests.
+For completeness, here is an example of a devstack local.conf that should
+work. Update backend information to fit your environment.
+
+::
+
+ [[local|localrc]]
+ VIRT_DRIVER=libvirt
+ ADMIN_PASSWORD=secret
+ SERVICE_TOKEN=$ADMIN_PASSWORD
+ MYSQL_PASSWORD=$ADMIN_PASSWORD
+ RABBIT_PASSWORD=$ADMIN_PASSWORD
+ SERVICE_PASSWORD=$ADMIN_PASSWORD
+ LOGFILE=$DEST/logs/stack.sh.log
+ LOGDAYS=2
+ SYSLOG=False
+ LOG_COLOR=False
+ RECLONE=yes
+ ENABLED_SERVICES=c-api,c-sch,c-vol,cinder,dstat,g-api,g-reg,key,mysql,
+ n-api,n-cond,n-cpu,n-crt,n-net,n-sch,rabbit,tempest
+ CINDER_ENABLED_BACKENDS=lvmdriver-1
+ CINDER_DEFAULT_VOLUME_TYPE=lvmdriver-1
+ CINDER_VOLUME_CLEAR=none
+ TEMPEST_ENABLED_BACKENDS=lvmdriver-1
+ TEMPEST_VOLUME_DRIVER=lvmdriver-1
+ TEMPEST_VOLUME_VENDOR="Open Source"
+ TEMPEST_STORAGE_PROTOCOL=iSCSI
+ LIBVIRT_FIREWALL_DRIVER=nova.virt.firewall.NoopFirewallDriver
+ VIRT_DRIVER=libvirt
+ ACTIVE_TIMEOUT=120
+ BOOT_TIMEOUT=120
+ ASSOCIATE_TIMEOUT=120
+ TERMINATE_TIMEOUT=120
+
+
+ [[post-config|$CINDER_CONF]]
+ [DEFAULT]
+ [lvmdriver-1]
+ volume_driver=cinder.volume.drivers.lvm.LVMISCSIDriver
+ volume_group=stack-volumes-1
+ volume_backend_name=lvmdriver-1
+