From 2acc1a461fd364c40ac489b9b060c989402ea321 Mon Sep 17 00:00:00 2001 From: Sofia Wallin Date: Tue, 6 Sep 2016 10:49:00 +0200 Subject: Adjusted the docs structure according to directives created subdirectory: docs/installationprocedure/images and copy both screenshots to this subdirectory. Updated according to comment Added a sub directory /installationprocedure and move the feature configuration to here Moved the abstract from the userguide/index.rst to the feature.userguide.rst Added a new index.rst in accordance to the new /installationprocedure Change-Id: Ie2acaddc1746fcee5baaca79713ea253c7d3f1b0 Signed-off-by: Sofia Wallin (cherry picked from commit d6e752f195525b396dad47ab339102120cd550e1) --- .../feature.configuration.rst | 63 +++++++++++++++++++++ docs/installationprocedure/images/LICENSE | 14 +++++ .../images/screenshot_promise.png | Bin 0 -> 101419 bytes .../images/screenshot_promise_install.png | Bin 0 -> 77709 bytes docs/installationprocedure/index.rst | 13 +++++ docs/userguide/feature.configguide.rst | 63 --------------------- docs/userguide/feature.userguide.rst | 7 +++ docs/userguide/images/LICENSE | 14 ----- docs/userguide/images/screenshot_promise.png | Bin 101419 -> 0 bytes .../images/screenshot_promise_install.png | Bin 77709 -> 0 bytes docs/userguide/index.rst | 4 -- 11 files changed, 97 insertions(+), 81 deletions(-) create mode 100644 docs/installationprocedure/feature.configuration.rst create mode 100644 docs/installationprocedure/images/LICENSE create mode 100755 docs/installationprocedure/images/screenshot_promise.png create mode 100644 docs/installationprocedure/images/screenshot_promise_install.png create mode 100644 docs/installationprocedure/index.rst delete mode 100644 docs/userguide/feature.configguide.rst delete mode 100644 docs/userguide/images/LICENSE delete mode 100755 docs/userguide/images/screenshot_promise.png delete mode 100644 docs/userguide/images/screenshot_promise_install.png diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst new file mode 100644 index 0000000..48082c3 --- /dev/null +++ b/docs/installationprocedure/feature.configuration.rst @@ -0,0 +1,63 @@ +.. 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= \ + OS_TEST_FLAVOR= \ + OS_TEST_NETWORK= \ + OS_TEST_IMAGE= \ + 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/installationprocedure/images/LICENSE b/docs/installationprocedure/images/LICENSE new file mode 100644 index 0000000..6a84dd4 --- /dev/null +++ b/docs/installationprocedure/images/LICENSE @@ -0,0 +1,14 @@ +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 . + +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/installationprocedure/images/screenshot_promise.png b/docs/installationprocedure/images/screenshot_promise.png new file mode 100755 index 0000000..4a0cbe3 Binary files /dev/null and b/docs/installationprocedure/images/screenshot_promise.png differ diff --git a/docs/installationprocedure/images/screenshot_promise_install.png b/docs/installationprocedure/images/screenshot_promise_install.png new file mode 100644 index 0000000..2cb27d9 Binary files /dev/null and b/docs/installationprocedure/images/screenshot_promise_install.png differ diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst new file mode 100644 index 0000000..41bc079 --- /dev/null +++ b/docs/installationprocedure/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + .. (c) + +************************************** +Promise installation and configuration +************************************** + +.. toctree:: + :numbered: + :maxdepth: 2 + + feature.configuration.rst 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= \ - OS_TEST_FLAVOR= \ - OS_TEST_NETWORK= \ - OS_TEST_IMAGE= \ - 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 . - -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 deleted file mode 100755 index 4a0cbe3..0000000 Binary files a/docs/userguide/images/screenshot_promise.png and /dev/null differ diff --git a/docs/userguide/images/screenshot_promise_install.png b/docs/userguide/images/screenshot_promise_install.png deleted file mode 100644 index 2cb27d9..0000000 Binary files a/docs/userguide/images/screenshot_promise_install.png and /dev/null differ 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 -- cgit 1.2.3-korg