diff options
author | Yujun Zhang <zhang.yujunz@zte.com.cn> | 2017-03-21 17:04:31 +0800 |
---|---|---|
committer | Yujun Zhang <zhang.yujunz@zte.com.cn> | 2017-03-25 11:11:17 +0800 |
commit | 511af26c4526550a2e4cf62d4d3689864e387ae3 (patch) | |
tree | 0e03ef7d54927e7b40506e638b6158dde87f49f4 | |
parent | 7cf476a424aa1005eae04ef18c9bf215d3a4685f (diff) |
Cleanup DEVELOP.md
- remove unecessary content
- move CLI develop guide to rst document
Change-Id: I20b6f458aa13f1feb1764e6c4d096ec8a9dddf49
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
-rw-r--r-- | DEVELOP.md | 88 |
1 files changed, 0 insertions, 88 deletions
@@ -102,91 +102,3 @@ If you want to include a new repository of third party code. Use ``` git subrepo clone <remote-url> [<subdir>] ``` - -## 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 <project root> -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 |