diff options
Diffstat (limited to 'docs/release/configguide')
| -rw-r--r-- | docs/release/configguide/feature.configuration.rst | 63 | ||||
| -rw-r--r-- | docs/release/configguide/images/LICENSE | 14 | ||||
| -rwxr-xr-x | docs/release/configguide/images/screenshot_promise.png | bin | 0 -> 101419 bytes | |||
| -rw-r--r-- | docs/release/configguide/images/screenshot_promise_install.png | bin | 0 -> 77709 bytes | |||
| -rw-r--r-- | docs/release/configguide/index.rst | 13 |
5 files changed, 90 insertions, 0 deletions
diff --git a/docs/release/configguide/feature.configuration.rst b/docs/release/configguide/feature.configuration.rst new file mode 100644 index 0000000..10696e0 --- /dev/null +++ b/docs/release/configguide/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://gerrit.opnfv.org/gerrit/promise + cd promise/source + 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/release/configguide/images/LICENSE b/docs/release/configguide/images/LICENSE new file mode 100644 index 0000000..6a84dd4 --- /dev/null +++ b/docs/release/configguide/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 <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/release/configguide/images/screenshot_promise.png b/docs/release/configguide/images/screenshot_promise.png Binary files differnew file mode 100755 index 0000000..4a0cbe3 --- /dev/null +++ b/docs/release/configguide/images/screenshot_promise.png diff --git a/docs/release/configguide/images/screenshot_promise_install.png b/docs/release/configguide/images/screenshot_promise_install.png Binary files differnew file mode 100644 index 0000000..2cb27d9 --- /dev/null +++ b/docs/release/configguide/images/screenshot_promise_install.png diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst new file mode 100644 index 0000000..41bc079 --- /dev/null +++ b/docs/release/configguide/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) <optionally add copywriters name> + +************************************** +Promise installation and configuration +************************************** + +.. toctree:: + :numbered: + :maxdepth: 2 + + feature.configuration.rst |
