diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/release/configguide/feature.configuration.rst | 27 | ||||
| -rw-r--r-- | docs/release/configguide/images/screenshot_promise_install.png | bin | 77709 -> 216440 bytes | |||
| -rw-r--r-- | docs/release/release-notes/index.rst | 13 | ||||
| -rw-r--r-- | docs/release/release-notes/releasenotes.rst | 127 | ||||
| -rw-r--r-- | docs/release/userguide/feature.userguide.rst | 29 |
5 files changed, 171 insertions, 25 deletions
diff --git a/docs/release/configguide/feature.configuration.rst b/docs/release/configguide/feature.configuration.rst index ad1df0e..3e66020 100644 --- a/docs/release/configguide/feature.configuration.rst +++ b/docs/release/configguide/feature.configuration.rst @@ -14,8 +14,9 @@ Install nodejs, npm and promise git clone https://gerrit.opnfv.org/gerrit/promise cd promise/source npm install + npm ls -Please note that the last command 'npm install' will install all needed dependencies +Please note that the last command 'npm ls' will list all needed dependencies for promise (including yangforge and mocha) .. figure:: images/screenshot_promise_install.png @@ -29,23 +30,25 @@ 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) +2. Create OpenStack project (e.g. promise) and user (e.g. myuser) in e.g. the + default domain 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): +Once done, the promise test script can be invoked as follows: .. 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> \ + export OS_PROJECT_NAME=promise + export OS_TENANT_NAME=promise + export OS_PROJECT_DOMAIN_NAME=Default + export OS_USERNAME=myuser + export OS_USER_DOMAIN_NAME=Default + export OS_PASSWORD=<user password from Step 2> + export OS_TEST_FLAVOR=<flavor ID from Step 3> + export OS_TEST_NETWORK=<network ID from Step 4> + export 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. @@ -57,4 +60,4 @@ The results can also be seen in the console ("npm run -s test") :width: 90% All 33 tests passing?! -Congratulations, promise has been successfully installed and configured. +Congratulations, Promise has been successfully installed and configured. diff --git a/docs/release/configguide/images/screenshot_promise_install.png b/docs/release/configguide/images/screenshot_promise_install.png Binary files differindex 2cb27d9..ab78994 100644 --- a/docs/release/configguide/images/screenshot_promise_install.png +++ b/docs/release/configguide/images/screenshot_promise_install.png diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst new file mode 100644 index 0000000..972e9dc --- /dev/null +++ b/docs/release/release-notes/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 + +.. _promise-releasenotes: + +********************* +Promise Release Notes +********************* + +.. toctree:: + :maxdepth: 2 + + releasenotes.rst diff --git a/docs/release/release-notes/releasenotes.rst b/docs/release/release-notes/releasenotes.rst new file mode 100644 index 0000000..dba59cf --- /dev/null +++ b/docs/release/release-notes/releasenotes.rst @@ -0,0 +1,127 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +======================================= +OPNFV Promise release notes (Euphrates) +======================================= + +Version history +=============== + ++------------+---------------+-----------------+-------------+ +| **Date** | **Ver.** | **Author** | **Comment** | ++============+===============+=================+=============+ +| 2017-07-13 | Euphrates 1.0 | Gerald Kunzmann | | ++------------+---------------+-----------------+-------------+ + +Important notes +=============== + +**Attention:** Please be aware that the Promise shim-layer implementation is marked as DEPREACTED +in Euphrates and both implementation and related test cases may be removed from next release. + +Abstract +=============== + +This document provides an overview of the Promise project in the OPNFV Euphrates +release. Promise is a resource reservation and management project to identify NFV related +requirements and realize resource reservation for future usage by capacity +management of resource pools regarding compute, network and storage. + + +Features +============ + +The following features are provided by the Promise in the OPNFV Euphrates release: + +* Capacity Management +* Reservation Management +* Allocation Management + +The Euphrates implementation of Promise is built with the YangForge data modeling +framework [#f2]_ , using a shim-layer on top of OpenStack to provide +the Promise features. + +In the OPNFV Euphrates release cycle most efforts have been spent to progress the upstream +implementation of a native resource reservation system for OpenStack as part of the Blazar project +[#f3]_. + +Detailed information about Promise use cases, features, interface +specifications, work flows, and the underlying Promise YANG schema can be found +in the Promise requirement document [#f1]_ . + +.. [#f1]_ http://artifacts.opnfv.org/promise/docs/development_requirements/index.html +.. [#f2]_ https://github.com/corenova/yang-forge +.. [#f3]_ https://launchpad.net/blazar/+milestone/0.3.0 + + +Installer support and verification status +========================================= + +Promise project is integrated in OPNFV through the Functest project (`FUNCTEST`_). + ++-----------+----------------------------------------------+--------------+ +| Installer | CI Job | Status | ++===========+==============================================+==============+ +| Fuel | functest-fuel-baremetal-daily-master | | +| | functest-fuel-virtual-daily-master | | +| | functest-fuel-armband-baremetal-daily-master | | ++-----------+----------------------------------------------+--------------+ +| Joid | functest-joid-baremetal-daily-master | | ++-----------+----------------------------------------------+--------------+ + +.. _FUNCTEST: https://wiki.opnfv.org/display/functest + + +Thereby, the following test cases (`TEST_CASES`_) are executed: + + - Add a new OpenStack provider to the reservation service + - Allocation of resources without prior reservation + - Reservation of a VM for immediate use followed by allocation + - Reservation of a VM for future use + - Update reservation + - Query reservation + - Cancel reservation + - Error case: try to create reservation with a conflict + - Capacity management - increase/decrease available capacity of a provider + - Capacity Management - query for available and used capacity + + +.. _TEST_CASES: https://git.opnfv.org/promise/tree/source/test/promise-intents.coffee + + +Open JIRA tickets +================= + ++------------------+-----------------------------------------------+ +| JIRA | Description | ++==================+===============================================+ +| | | +| | | ++------------------+-----------------------------------------------+ + +All the tickets that are not blocking have been fixed or postponed +the next release. + +Promise Euphrates 1.0 is released without known bugs. + + + +Useful links +============ + + - Promise project page: https://wiki.opnfv.org/display/promise + - Promise requirements: http://artifacts.opnfv.org/promise/docs/development_requirements/index.html + +Related Projects +---------------- + + - OpenStack Blazar (Resource reservation for OpenStack): https://blazar.readthedocs.io/en/latest/ + - YangForge data modeling framework: - https://github.com/opnfv/yangforge + +Related ETSI NFV specifications +------------------------------- + + - ETSI NFV MANO GS: http://www.etsi.org/deliver/etsi_gs/NFV-MAN + - ETSI NFV INF GSs: http://www.etsi.org/deliver/etsi_gs/NFV-INF + - ETSI NFV IFA GSs: http://www.etsi.org/deliver/etsi_gs/NFV-IFA diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst index 7261f4e..bba2aea 100644 --- a/docs/release/userguide/feature.userguide.rst +++ b/docs/release/userguide/feature.userguide.rst @@ -17,7 +17,7 @@ The following sections provide details on the Promise capabilities and its API u Promise capabilities and usage ============================== -The Danube implementation of Promise is built with the YangForge data modeling +The Euphrates implementation of Promise is built with the YangForge data modeling framework [#f2]_ , using a shim-layer on top of OpenStack to provide the Promise features. This approach requires communication between Consumers/Administrators and OpenStack to pass through the shim-layer. The @@ -34,9 +34,12 @@ Detailed information about Promise use cases, features, interface specifications, work flows, and the underlying Promise YANG schema can be found in the Promise requirement document [#f1]_ . +Keystone v3 support has been added during the Euphrates release. + + Promise features and API usage guidelines and examples ------------------------------------------------------ -This section lists the Promise features and API implemented in OPNFV Danube. +This section lists the Promise features and API implemented in OPNFV Euphrates. Note: The listed parameters are optional unless explicitly marked as "mandatory". @@ -151,7 +154,7 @@ The operation takes the following input parameters: * provider-id: identifier of the provider where the instance shall be created * reservation-id: identifier of a resource reservation the *create-instance* -The Danube implementation of Promise has the following limitations: +The Euphrates implementation of Promise has the following limitations: * All create server instance requests shall pass through the Promise shim-layer such that Promise can keep track of all allocation requests. This @@ -258,7 +261,7 @@ The current implementation supports the following filter criteria: This API towards OpenStack allows a Consumer/Administrator to add and remove resource providers to Promise. Note, Promise supports a multi-provider -configuration, however, for Danube, multi-provider support is not yet +configuration, however, for Euphrates, multi-provider support is not yet fully supported. *add-provider* @@ -267,23 +270,23 @@ fully supported. This operation is used to register a new resource provider into the Promise reservation system. -Note, for Danube, the add-provider operation should only be used to +Note, for Euphrates, the add-provider operation should only be used to register one provider with the Promise shim-layer. Further note that currently only OpenStack is supported as a provider. The operation takes the following input parameters: -* provider-type (mandatory) = 'openstack': select a specific resource provider +* provider-type = 'openstack': select a specific resource provider type. -* endpoint (mandatory): target URL endpoint for the resource provider. -* username (mandatory) -* password (mandatory) -* region: specified region for the provider -* tenant.id: id of the OpenStack tenant/project -* tenant.name: name of the OpenStack tenant/project +* endpoint : target URL endpoint for the resource provider. +* username : name of the user +* password : user password +* user-domain-name : domain name of the user +* project.name : name of the OpenStack project +* project.domain-name : domain name of the OpenStack project .. [#f1] Promise requirement document, - http://artifacts.opnfv.org/promise/docs/requirements/index.html + http://artifacts.opnfv.org/promise/docs/development_requirements/index.html .. [#f2] YangForge framework, http://github.com/opnfv/yangforge |
