diff options
author | Shrenik <shrenik.jain@research.iiit.ac.in> | 2017-09-13 00:49:05 +0530 |
---|---|---|
committer | Shrenik <shrenik.jain@research.iiit.ac.in> | 2017-09-13 00:57:38 +0530 |
commit | 9b2ba68b75ecd50600e6f375aeb4ea410cec0128 (patch) | |
tree | e3bbb315fe7413836b21c0aa55ba1494d6f4abdf /docs/dev/initial.rst | |
parent | a5b902bc5167ab72ab2087355fdc4ec2fdbc0a2c (diff) |
Adds StorPerf developer guide
The wiki for Development Environment has been converted in .rst format.
JIRA: STORPERF-201
Change-Id: I4e2bc792a8704e4f933f0ea61533c1bf5955c64d
Signed-off-by: Shrenik <shrenik.jain@research.iiit.ac.in>
Diffstat (limited to 'docs/dev/initial.rst')
-rw-r--r-- | docs/dev/initial.rst | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/dev/initial.rst b/docs/dev/initial.rst new file mode 100644 index 0000000..04b1c45 --- /dev/null +++ b/docs/dev/initial.rst @@ -0,0 +1,42 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Dell EMC and others. + +================ +Initial Set up +================ + +Getting the Code +================ + +Replace your LFID with your actual Linux Foundation ID. + +.. code-block:: bash + + git clone ssh://YourLFID@gerrit.opnfv.org:29418/storperf + + +Virtual Environment +======================= +It is preferred to use virtualenv for Python dependencies. This way it is known +exactly what libraries are needed, and can restart from a clean state at any +time to ensure any library is not missing. Simply running the script: + +.. code-block:: bash + + ci/verify.sh + +from inside the storperf directory will automatically create a virtualenv in +the home directory called 'storperf_venv'. This will be used as the Python +interpreter for the IDE. + + +Docker Version +======================= +In order to run the full set of StorPerf services, docker and docker-compose +are required to be installed. This requires docker 17.05 at a minimum. + +.. code-block:: bash + + https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/ + |