Docs: Add fullstack test guide

Change-Id: Ifb5acb563498a9228417bd56b471a5229d3fb83d
This commit is contained in:
Dongcan Ye 2018-02-09 08:25:13 +00:00
parent 8f39d8d465
commit 56a98cf6cb
3 changed files with 63 additions and 17 deletions

View File

@ -7,9 +7,9 @@ Team and repository tags
.. Change things from this point on
===============================
================
kuryr-libnetwork
===============================
================
.. image:: https://raw.githubusercontent.com/openstack/kuryr/master/doc/images/kuryr_logo.png
:alt: Kuryr mascot
@ -415,21 +415,6 @@ Due to the `Docker --ipv6 tag bug <https://github.com/docker/docker/issues/28055
1.12 and 1.13 have problem to create network only with IPv6.
To test it with tox::
$ tox
You can also run specific test cases using the ``-e`` flag, e.g., to only run
the *fullstack* test case::
$ tox -e fullstack
Also you can run *fullstack* test using credentials from openrc config file,
this requires you source openrc file in your DevStack or production environment.
In DevStack, you can using command "source openrc admin" in your devstack directory.
For production environment, please refer "Create OpenStack client environment scripts"
in OpenStack install guide.
Generating Documentation
------------------------

View File

@ -0,0 +1,60 @@
==============
Fullstack test
==============
This is a guide for developers who want to run Fullstack tests in their local
machine.
Prerequisite
============
You need to deploy kuryr-libnetwork in a DevStack environment.
Clone DevStack::
# Create a root directory for devstack if needed
sudo mkdir -p /opt/stack
sudo chown $USER /opt/stack
git clone https://git.openstack.org/openstack-dev/devstack /opt/stack/devstack
We will run devstack with minimal local.conf settings required. You can use the
sample local.conf as a quick-start::
git clone https://git.openstack.org/openstack/kuryr-libnetwork /opt/stack/kuryr-libnetwork
cp /opt/stack/kuryr-libnetwork/devstack/local.conf.sample /opt/stack/devstack/local.conf
Run DevStack::
cd /opt/stack/devstack
./stack.sh
**NOTE:** This will take a while to setup the dev environment.
Run the Fullstack test
======================
Navigate to kuryr-libnetwork directory::
cd /opt/stack/kuryr-libnetwork
Run this command::
tox -e fullstack
Also you can run *fullstack* test using credentials from openrc config file,
this requires you source openrc file in your DevStack or production environment.
In DevStack, you can using command "source openrc admin" in your devstack directory.
For production environment, please refer "Create OpenStack client environment scripts"
in OpenStack install guide.
Source the credential of 'admin' user::
source /opt/stack/devstack/openrc admin
Then run command::
tox -e fullstack

View File

@ -13,6 +13,7 @@ Contents:
readme
config-sriov.rst
fullstack-test
Design and Developer Docs
==========================