summaryrefslogtreecommitdiffstats
path: root/networking-odl/rally-jobs/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'networking-odl/rally-jobs/README.rst')
-rw-r--r--networking-odl/rally-jobs/README.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/networking-odl/rally-jobs/README.rst b/networking-odl/rally-jobs/README.rst
new file mode 100644
index 0000000..4b345ed
--- /dev/null
+++ b/networking-odl/rally-jobs/README.rst
@@ -0,0 +1,31 @@
+Rally job related files
+=======================
+
+This directory contains rally tasks and plugins that are run by OpenStack CI.
+
+Structure
+---------
+
+* plugins - directory where you can add rally plugins. Almost everything in
+ Rally is a plugin. Benchmark context, Benchmark scenario, SLA checks, Generic
+ cleanup resources, ....
+
+* extra - all files from this directory will be copy pasted to gates, so you
+ are able to use absolute paths in rally tasks.
+ Files will be located in ~/.rally/extra/*
+
+* odl.yaml is a task that is run in gates against OpenStack with
+ Neutron service configured with ODL plugin
+
+Useful links
+------------
+
+* More about Rally: https://rally.readthedocs.org/en/latest/
+
+* Rally release notes: https://rally.readthedocs.org/en/latest/release_notes.html
+
+* How to add rally-gates: https://rally.readthedocs.org/en/latest/gates.html
+
+* About plugins: https://rally.readthedocs.org/en/latest/plugins.html
+
+* Plugin samples: https://github.com/openstack/rally/tree/master/samples/plugins