diff options
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/feature.configguide.rst | 63 | ||||
| -rw-r--r-- | docs/userguide/feature.userguide.rst | 7 | ||||
| -rw-r--r-- | docs/userguide/images/LICENSE | 14 | ||||
| -rwxr-xr-x | docs/userguide/images/screenshot_promise.png | bin | 101419 -> 0 bytes | |||
| -rw-r--r-- | docs/userguide/images/screenshot_promise_install.png | bin | 77709 -> 0 bytes | |||
| -rw-r--r-- | docs/userguide/index.rst | 4 |
6 files changed, 7 insertions, 81 deletions
diff --git a/docs/userguide/feature.configguide.rst b/docs/userguide/feature.configguide.rst deleted file mode 100644 index 48082c3..0000000 --- a/docs/userguide/feature.configguide.rst +++ /dev/null @@ -1,63 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Manual testing -============== - -Promise installation --------------------- - -Install nodejs, npm and promise - -.. code-block:: bash - - curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash - - sudo apt-get install -y nodejs - sudo npm -g install npm@latest - git clone https://github.com/opnfv/promise.git - cd promise - npm install - -Please note that the last command 'npm install' will install all needed dependencies -for promise (including yangforge and mocha) - -.. figure:: images/screenshot_promise_install.png - :name: figure1 - :width: 90% - - -Validation ----------- -Please perform the following preparation steps: - -1. Set OpenStack environment parameters properly (e.g. source openrc admin demo - in DevStack) -2. Create OpenStack tenant (e.g. promise) and tenant user (e.g. promiser) -3. Create a flavor in Nova with 1 vCPU and 512 MB RAM -4. Create a private network, subnet and router in Neutron -5. Create an image in Glance - -Once done, the promise test script can be invoked as follows (as a single line -command): - -.. code-block:: bash - - NODE_ENV=mytest \ - OS_TENANT_NAME=promise \ - OS_USERNAME=promiser \ - OS_PASSWORD=<user password from Step 2> \ - OS_TEST_FLAVOR=<flavor ID from Step 3> \ - OS_TEST_NETWORK=<network ID from Step 4> \ - OS_TEST_IMAGE=<image ID from Step 5> \ - npm run -s test -- --reporter json > promise-results.json - -The results of the tests will be stored in the promise-results.json file. - -The results can also be seen in the console ("npm run -s test") - -.. figure:: images/screenshot_promise.png - :name: figure2 - :width: 90% - -All 33 tests passing?! -Congratulations, promise has been successfully installed and configured. diff --git a/docs/userguide/feature.userguide.rst b/docs/userguide/feature.userguide.rst index ac035f4..5fcae54 100644 --- a/docs/userguide/feature.userguide.rst +++ b/docs/userguide/feature.userguide.rst @@ -1,6 +1,13 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +Abstract +======== +This user guide document provides the users with: + +1. Short description of Promise project and key features implemented in +Colorado. + Promise description =================== Promise is a resource reservation and management project to identify NFV related diff --git a/docs/userguide/images/LICENSE b/docs/userguide/images/LICENSE deleted file mode 100644 index 6a84dd4..0000000 --- a/docs/userguide/images/LICENSE +++ /dev/null @@ -1,14 +0,0 @@ -Copyright 2016 Open Platform for NFV Project, Inc. and its contributors - -Open Platform for NFV Project Documentation Licence -=================================================== -Any documentation developed by the "Open Platform for NFV Project" -is licensed under a Creative Commons Attribution 4.0 International License. -You should have received a copy of the license along with this. If not, -see <http://creativecommons.org/licenses/by/4.0/>. - -Unless required by applicable law or agreed to in writing, documentation -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. diff --git a/docs/userguide/images/screenshot_promise.png b/docs/userguide/images/screenshot_promise.png Binary files differdeleted file mode 100755 index 4a0cbe3..0000000 --- a/docs/userguide/images/screenshot_promise.png +++ /dev/null diff --git a/docs/userguide/images/screenshot_promise_install.png b/docs/userguide/images/screenshot_promise_install.png Binary files differdeleted file mode 100644 index 2cb27d9..0000000 --- a/docs/userguide/images/screenshot_promise_install.png +++ /dev/null diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index 696b341..f6cb21c 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -4,13 +4,9 @@ ================== Promise user guide ================== -This user guide document provides the users with: -1. Short description of Promise project and key features implemented in Colorado -2. Instructions to execute Promise test cases manually .. toctree:: :maxdepth: 3 feature.userguide.rst - feature.configguide.rst |
