diff options
| author |   Bryan Sullivan <bryan.sullivan@att.com> | 2017-02-28 17:04:52 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@opnfv.org> | 2017-02-28 17:04:52 +0000 |
| commit | 486c8bf6e381ee6ba4e4151fe7c658245407a1d7 (patch) | |
| tree | b490f0a407e3e5b71490548d6476081b87d57124 /docs/release | |
| parent | ed5d8f79a473ba75e63eccc6a7ecdba434835a66 (diff) | |
| parent | e8d3e7ce3dcd310f99118ebb7d380898b4738ec8 (diff) | |
Merge "Update to new OPNFV Docs structure"
Diffstat (limited to 'docs/release')
| -rw-r--r-- | docs/release/configguide/featureconfig.rst | 27 | ||||
| -rw-r--r-- | docs/release/configguide/index.rst | 14 | ||||
| -rw-r--r-- | docs/release/configguide/postinstall.rst | 26 | ||||
| -rw-r--r-- | docs/release/installation/index.rst | 13 | ||||
| -rw-r--r-- | docs/release/installation/installation.instruction.rst | 24 | ||||
| -rw-r--r-- | docs/release/release-notes/index.rst | 13 | ||||
| -rw-r--r-- | docs/release/release-notes/release-notes.rst | 33 | ||||
| -rw-r--r-- | docs/release/scenarios/scenario.name/index.rst | 15 | ||||
| -rw-r--r-- | docs/release/scenarios/scenario.name/scenario.description.rst | 19 | ||||
| -rw-r--r-- | docs/release/userguide/feature.userguide.rst | 18 | ||||
| -rw-r--r-- | docs/release/userguide/index.rst | 16 |
11 files changed, 218 insertions, 0 deletions
diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst new file mode 100644 index 0000000..1407212 --- /dev/null +++ b/docs/release/configguide/featureconfig.rst @@ -0,0 +1,27 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +========================== +OPNFV Models Configuration +========================== + +.. contents:: + :depth: 3 + :local: + +Hardware configuration +---------------------- +There is currently no OPNFV installer support for the components used by the Models project. + +Feature configuration +--------------------- +The Models test scripts automatically install Models components. Instructions are included in the following scripts: + + * models/tests/vHello_Tacker.sh + +Prerequisites to using vHello_Tacker: + + * OPFNV installed via JOID or Apex + * a plain OpenStack installation such as DevStack diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst new file mode 100644 index 0000000..2336694 --- /dev/null +++ b/docs/release/configguide/index.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +================================ +OPNFV Models Configuration Guide +================================ + +.. toctree:: + :maxdepth: 1 + + featureconfig + postinstall diff --git a/docs/release/configguide/postinstall.rst b/docs/release/configguide/postinstall.rst new file mode 100644 index 0000000..7367a5c --- /dev/null +++ b/docs/release/configguide/postinstall.rst @@ -0,0 +1,26 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +======================================== +OPNFV Models Post Installation Procedure +======================================== + + + +.. contents:: + :depth: 3 + :local: + +Automated post installation activities +-------------------------------------- +None + +Models post configuration procedures +------------------------------------ +None + +Platform components validation +------------------------------ +None diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst new file mode 100644 index 0000000..ed531d3 --- /dev/null +++ b/docs/release/installation/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) 2015-2017 AT&T Intellectual Property, Inc + +========================= +OPNFV Models Installation +========================= + +.. toctree:: + :maxdepth: 1 + + installation.instruction diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst new file mode 100644 index 0000000..0500738 --- /dev/null +++ b/docs/release/installation/installation.instruction.rst @@ -0,0 +1,24 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +Models Post Installation Procedures +=================================== + +None + +Models Functional Tests +----------------------- + +vHello_Tacker: A single-node simple python web server, +connected to two internal networks (private and admin), +and accessible via a floating IP. Based upon the OpenStack Tacker +project's "tosca-vnfd-hello-world" blueprint, as extended for testing +of more Tacker-supported features as of OpenStack Newton. + +Further description of the tests is provided on the Models wiki at +https://wiki.opnfv.org/display/models/Testing. + + + diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst new file mode 100644 index 0000000..7302a7a --- /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 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +========================== +OPNFV Models Release Notes +========================== + +.. toctree:: + :maxdepth: 1 + + release-notes diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst new file mode 100644 index 0000000..d46386b --- /dev/null +++ b/docs/release/release-notes/release-notes.rst @@ -0,0 +1,33 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +========================== +OPNFV Models Release Notes +========================== + +This document provides the release notes for the Danube Release of Models. + +.. contents:: + :depth: 3 + :local: + + +Version history +--------------- + ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2017 8 Feb | 1.0.0 | Bryan Sullivan | | +| | | Aimee Ukasick | | ++--------------------+--------------------+--------------------+--------------------+ + +Summary +------- + +This release includes: + + * Further enhancements of Models test scripts diff --git a/docs/release/scenarios/scenario.name/index.rst b/docs/release/scenarios/scenario.name/index.rst new file mode 100644 index 0000000..c6bf5ff --- /dev/null +++ b/docs/release/scenarios/scenario.name/index.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +====================== +OPNFV Models Scenarios +====================== + + +.. toctree:: + :maxdepth: 1 + + scenario.description + diff --git a/docs/release/scenarios/scenario.name/scenario.description.rst b/docs/release/scenarios/scenario.name/scenario.description.rst new file mode 100644 index 0000000..b690ea8 --- /dev/null +++ b/docs/release/scenarios/scenario.name/scenario.description.rst @@ -0,0 +1,19 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +====================== +OPNFV Models Scenarios +====================== + +This document provides scenario level details for the Danube release of Models. + +.. contents:: + :depth: 3 + :local: + +Introduction +------------ + +There are no scenarios at this time. diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst new file mode 100644 index 0000000..59ecccf --- /dev/null +++ b/docs/release/userguide/feature.userguide.rst @@ -0,0 +1,18 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +======================= +OPNFV Models User Guide +======================= + +.. contents:: + :depth: 3 + :local: + +Current information on the capabilities of the Models project can be found on the Models `wiki <https://wiki.opnfv.org/display/models>`_. + +Examples of test usage can be found on the Models `testing <https://wiki.opnfv.org/display/models/Testing>`_ page. + + diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst new file mode 100644 index 0000000..bd09cb1 --- /dev/null +++ b/docs/release/userguide/index.rst @@ -0,0 +1,16 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2015-2017 AT&T Intellectual Property, Inc + +======================= +OPNFV Models User Guide +======================= + +.. toctree:: + :maxdepth: 1 + + feature.userguide + + + |