From c82791004e8a207ef7bbe4567d8c3e54af84a8fd Mon Sep 17 00:00:00 2001 From: Yujun Zhang Date: Tue, 21 Mar 2017 17:04:31 +0800 Subject: Cleanup DEVELOP.md - remove unecessary content - move CLI develop guide to rst document Change-Id: I20b6f458aa13f1feb1764e6c4d096ec8a9dddf49 Signed-off-by: Yujun Zhang --- DEVELOP.md | 88 ----------------------------------- docs/testing/developer/design/cli.rst | 22 +++++++++ 2 files changed, 22 insertions(+), 88 deletions(-) diff --git a/DEVELOP.md b/DEVELOP.md index 8e9545e6..75318192 100644 --- a/DEVELOP.md +++ b/DEVELOP.md @@ -102,91 +102,3 @@ If you want to include a new repository of third party code. Use ``` git subrepo clone [] ``` - -## Architecture - -**TODO**: move to design spec - -QTIP has a flexible architecture to allow different deployment mode - -- **Standalone**: full feature performance benchmark platform. -- **Agent**: minimal agent driven by external test runners. - -### Standalone Mode (Solo) - -QTIP instance deployed in container, VM or host generate benchmark report and -push data to Indices Hub for storage and visualization. - -![solo](https://wiki.opnfv.org/download/attachments/8687017/Standalone.png?api=v2) - -### Agent Mode (Melody) - -QTIP Collector and Reporter driven by external test framework or runner such as -[yardstick](https://wiki.opnfv.org/display/yardstick), -[pytest](http://doc.pytest.org/) and etc. - -![melody](https://wiki.opnfv.org/download/attachments/8687017/Agent.png?api=v2) - -## Core Modules - -TBD - -- loader -- runner -- collector -- reporter - -## Drivers - -TBD - -- ansible -- yardstick - -## Interfaces - -### Agent - -TBD - -### CLI - -Click currently supports Bash completion. The prerequisite for this is that the program -needs to be installed correctly. To install Qtip, execute the following command in root -folder of Qtip: - -``` -cd -pip install -e . -``` - -Once the installation has been completed successfully, the following needs to be added to -the `.bashrc` file: - -``` -eval "$(_QTIP_COMPLETE=source qtip)" -``` - -The above would activate command completion for Qtip. - -### API - -TBD - -## Assets - -**TODO**: move to user guide - -- benchmark plan -- QPI spec -- metric spec - -## Docker Image - -TBD - -## Annex - -### Directories - -TBD diff --git a/docs/testing/developer/design/cli.rst b/docs/testing/developer/design/cli.rst index 7b226e6f..487bdec5 100644 --- a/docs/testing/developer/design/cli.rst +++ b/docs/testing/developer/design/cli.rst @@ -1,2 +1,24 @@ - Which framework has been used and why - How to extend to more commands + +Original content from DEVELOP.md + + ### CLI + + Click currently supports Bash completion. The prerequisite for this is that the program + needs to be installed correctly. To install Qtip, execute the following command in root + folder of Qtip: + + ``` + cd + pip install -e . + ``` + + Once the installation has been completed successfully, the following needs to be added to + the `.bashrc` file: + + ``` + eval "$(_QTIP_COMPLETE=source qtip)" + ``` + + The above would activate command completion for Qtip. -- cgit 1.2.3-korg