From e8d3e7ce3dcd310f99118ebb7d380898b4738ec8 Mon Sep 17 00:00:00 2001 From: Aimee Ukasick Date: Wed, 8 Feb 2017 12:30:04 -0600 Subject: Update to new OPNFV Docs structure JIRA: MODELS-2 Change-Id: I5d5601849803cf017bab882dc6eba931637b0770 Signed-off-by: Aimee Ukasick --- docs/design/definitions.rst | 53 ---------------------- docs/design/featureconfig_link.rst | 2 - docs/design/featureusage_link.rst | 2 - docs/design/index.rst | 20 -------- docs/design/introduction.rst | 25 ---------- docs/design/postinstall_link.rst | 2 - docs/design/releasenotes_link.rst | 2 - docs/design/usecases.rst | 28 ------------ docs/development/design/architecture.rst | 15 ++++++ docs/development/design/definitions.rst | 53 ++++++++++++++++++++++ docs/development/design/index.rst | 15 ++++++ docs/development/overview/index.rst | 13 ++++++ docs/development/overview/overview.rst | 22 +++++++++ docs/development/requirements/index.rst | 13 ++++++ docs/development/requirements/requirements.rst | 15 ++++++ .../feature.configuration.rst | 38 ---------------- docs/installationprocedure/index.rst | 10 ---- .../installation.instruction.rst | 24 ---------- docs/release/configguide/featureconfig.rst | 27 +++++++++++ docs/release/configguide/index.rst | 14 ++++++ docs/release/configguide/postinstall.rst | 26 +++++++++++ docs/release/installation/index.rst | 13 ++++++ .../installation/installation.instruction.rst | 24 ++++++++++ docs/release/release-notes/index.rst | 13 ++++++ docs/release/release-notes/release-notes.rst | 33 ++++++++++++++ docs/release/scenarios/scenario.name/index.rst | 15 ++++++ .../scenario.name/scenario.description.rst | 19 ++++++++ docs/release/userguide/feature.userguide.rst | 18 ++++++++ docs/release/userguide/index.rst | 16 +++++++ docs/releasenotes/index.rst | 9 ---- docs/releasenotes/release.notes.rst | 18 -------- docs/testing/index.rst | 13 ++++++ docs/testing/usecases.rst | 22 +++++++++ docs/userguide/feature.usage.rst | 12 ----- docs/userguide/index.rst | 9 ---- 35 files changed, 399 insertions(+), 254 deletions(-) delete mode 100644 docs/design/definitions.rst delete mode 100644 docs/design/featureconfig_link.rst delete mode 100644 docs/design/featureusage_link.rst delete mode 100644 docs/design/index.rst delete mode 100644 docs/design/introduction.rst delete mode 100644 docs/design/postinstall_link.rst delete mode 100644 docs/design/releasenotes_link.rst delete mode 100644 docs/design/usecases.rst create mode 100644 docs/development/design/architecture.rst create mode 100644 docs/development/design/definitions.rst create mode 100644 docs/development/design/index.rst create mode 100644 docs/development/overview/index.rst create mode 100644 docs/development/overview/overview.rst create mode 100644 docs/development/requirements/index.rst create mode 100644 docs/development/requirements/requirements.rst delete mode 100644 docs/installationprocedure/feature.configuration.rst delete mode 100644 docs/installationprocedure/index.rst delete mode 100644 docs/installationprocedure/installation.instruction.rst create mode 100644 docs/release/configguide/featureconfig.rst create mode 100644 docs/release/configguide/index.rst create mode 100644 docs/release/configguide/postinstall.rst create mode 100644 docs/release/installation/index.rst create mode 100644 docs/release/installation/installation.instruction.rst create mode 100644 docs/release/release-notes/index.rst create mode 100644 docs/release/release-notes/release-notes.rst create mode 100644 docs/release/scenarios/scenario.name/index.rst create mode 100644 docs/release/scenarios/scenario.name/scenario.description.rst create mode 100644 docs/release/userguide/feature.userguide.rst create mode 100644 docs/release/userguide/index.rst delete mode 100644 docs/releasenotes/index.rst delete mode 100644 docs/releasenotes/release.notes.rst create mode 100644 docs/testing/index.rst create mode 100644 docs/testing/usecases.rst delete mode 100644 docs/userguide/feature.usage.rst delete mode 100644 docs/userguide/index.rst (limited to 'docs') diff --git a/docs/design/definitions.rst b/docs/design/definitions.rst deleted file mode 100644 index 426abda..0000000 --- a/docs/design/definitions.rst +++ /dev/null @@ -1,53 +0,0 @@ -.. 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 - -Definitions -=========== -.. list-table:: Definitions - :widths: 15 85 - :header-rows: 1 - - * - Term - - Meaning - - * - State - - Information that can be used to convey or imply the state of something, e.g. an application, resource, entity, etc. This can include data held inside OPNFV components, "events" that have occurred. - - * - YANG - - A data modeling language used to model configuration and state data manipulated by the Network Configuration Protocol (NETCONF), NETCONF remote procedure calls, and NETCONF notifications. - - -Abbreviations -============= -.. list-table:: Abbreviations - :widths: 15 85 - :header-rows: 1 - - * - Term - - Meaning - - * - CRUD - - Create, Read, Update, Delete (database operation types) - - * - FCAPS - - Fault, Configuration, Accounting, Performance, Security - - * - NF - - Network Function - - * - SFC - - Service Function Chaining - - * - VNF - - Virtual Network Function - - * - NFVI - - Network Function Virtualization Infrastructure - - * - TOSCA - - Topology and Orchestration Specification for Cloud Applications - - * - NETCONF - - Network Configuration Protocol diff --git a/docs/design/featureconfig_link.rst b/docs/design/featureconfig_link.rst deleted file mode 100644 index 6af66f7..0000000 --- a/docs/design/featureconfig_link.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. include:: - ../installationprocedure/feature.configuration.rst diff --git a/docs/design/featureusage_link.rst b/docs/design/featureusage_link.rst deleted file mode 100644 index c3ac10b..0000000 --- a/docs/design/featureusage_link.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. include:: - ../userguide/feature.usage.rst diff --git a/docs/design/index.rst b/docs/design/index.rst deleted file mode 100644 index 982f2a6..0000000 --- a/docs/design/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. 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 Copper Project -******************** - -.. toctree:: - :numbered: - :maxdepth: 4 - - introduction.rst - releasenotes_link.rst - definitions.rst - usecases.rst - featureconfig_link.rst - postinstall_link.rst - featureusage_link.rst diff --git a/docs/design/introduction.rst b/docs/design/introduction.rst deleted file mode 100644 index ee4cee2..0000000 --- a/docs/design/introduction.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. 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 - -Introduction -============ - -.. - This work is licensed under a Creative Commons Attribution 4.0 Unported License. - - http://creativecommons.org/licenses/by/4.0 - -.. NOTE:: - This is the working documentation for the Models project. - -The `OPNFV Models `_ project aims to address -various goals for promoting availability and convergence of information and/or data -models related to NFV service/VNF management, as being defined in Standards (SDOs) -and as developed in Open Source projects. - -The documentation provided here focuses on the specific features supported in the Danube release. - - - diff --git a/docs/design/postinstall_link.rst b/docs/design/postinstall_link.rst deleted file mode 100644 index ca8d99c..0000000 --- a/docs/design/postinstall_link.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. include:: - ../installationprocedure/installation.instruction.rst diff --git a/docs/design/releasenotes_link.rst b/docs/design/releasenotes_link.rst deleted file mode 100644 index 6ee81a3..0000000 --- a/docs/design/releasenotes_link.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. include:: - ../releasenotes/release.notes.rst diff --git a/docs/design/usecases.rst b/docs/design/usecases.rst deleted file mode 100644 index 4789fa5..0000000 --- a/docs/design/usecases.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. 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 - -Use Cases -========= - -Implemented in Current Release ------------------------------- - -Tacker Hello World -.................. - -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. -A single-node simple python web server, connected to two internal networks -(private and admin), and accessible via a floating IP. - - -Cloudify Hello World -.................... - -Deployment test for the Cloudify Hello World blueprint - - -A complete list of use cases is located on the -`Models Testing `_ wiki page. diff --git a/docs/development/design/architecture.rst b/docs/development/design/architecture.rst new file mode 100644 index 0000000..d591082 --- /dev/null +++ b/docs/development/design/architecture.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 Danube Architecture +================================ + +.. contents:: + :depth: 3 + :local: + +Please see the OPNFV Models `wiki `_ +for details on Models project's architecture. diff --git a/docs/development/design/definitions.rst b/docs/development/design/definitions.rst new file mode 100644 index 0000000..426abda --- /dev/null +++ b/docs/development/design/definitions.rst @@ -0,0 +1,53 @@ +.. 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 + +Definitions +=========== +.. list-table:: Definitions + :widths: 15 85 + :header-rows: 1 + + * - Term + - Meaning + + * - State + - Information that can be used to convey or imply the state of something, e.g. an application, resource, entity, etc. This can include data held inside OPNFV components, "events" that have occurred. + + * - YANG + - A data modeling language used to model configuration and state data manipulated by the Network Configuration Protocol (NETCONF), NETCONF remote procedure calls, and NETCONF notifications. + + +Abbreviations +============= +.. list-table:: Abbreviations + :widths: 15 85 + :header-rows: 1 + + * - Term + - Meaning + + * - CRUD + - Create, Read, Update, Delete (database operation types) + + * - FCAPS + - Fault, Configuration, Accounting, Performance, Security + + * - NF + - Network Function + + * - SFC + - Service Function Chaining + + * - VNF + - Virtual Network Function + + * - NFVI + - Network Function Virtualization Infrastructure + + * - TOSCA + - Topology and Orchestration Specification for Cloud Applications + + * - NETCONF + - Network Configuration Protocol diff --git a/docs/development/design/index.rst b/docs/development/design/index.rst new file mode 100644 index 0000000..3fd61ee --- /dev/null +++ b/docs/development/design/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 Danube Design +============================ + +.. toctree:: + :maxdepth: 1 + + definitions + architecture + diff --git a/docs/development/overview/index.rst b/docs/development/overview/index.rst new file mode 100644 index 0000000..07bdc43 --- /dev/null +++ b/docs/development/overview/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 Danube Overview +============================ + +.. toctree:: + :maxdepth: 1 + + overview diff --git a/docs/development/overview/overview.rst b/docs/development/overview/overview.rst new file mode 100644 index 0000000..4b0d31f --- /dev/null +++ b/docs/development/overview/overview.rst @@ -0,0 +1,22 @@ +.. 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 Danube Overview +============================ + +.. contents:: + :depth: 3 + :local: + +Introduction +------------ +The `OPNFV Models `_ project addresses +various goals for promoting availability and convergence of information and/or data +models related to NFV service/VNF management, as being defined in Standards (SDOs) +and as developed in Open Source projects. + + + diff --git a/docs/development/requirements/index.rst b/docs/development/requirements/index.rst new file mode 100644 index 0000000..f6e6b88 --- /dev/null +++ b/docs/development/requirements/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 Danube Requirements +================================ + +.. toctree:: + :maxdepth: 1 + + requirements diff --git a/docs/development/requirements/requirements.rst b/docs/development/requirements/requirements.rst new file mode 100644 index 0000000..375f85d --- /dev/null +++ b/docs/development/requirements/requirements.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 Danube Requirements +================================ + +.. contents:: + :depth: 3 + :local: + +Please see the OPNFV Models `wiki `_ +for details on Models project's development requirements. diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst deleted file mode 100644 index 57b490d..0000000 --- a/docs/installationprocedure/feature.configuration.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. 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 Configuration -==================== - - -Pre-configuration Activities ----------------------------- -None required. - -Hardware Configuration ----------------------- -There is no specific hardware configuration required for the Models project. - -Feature Configuration ---------------------- - -OPNFV Installer Support -....................... - -There is currently no OPNFV installer support for the components used by the Models project. - - -Manual Installation -................... - -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/installationprocedure/index.rst b/docs/installationprocedure/index.rst deleted file mode 100644 index 2776b88..0000000 --- a/docs/installationprocedure/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -*********************************** -OPNFV Copper Installation Procedure -*********************************** - -.. toctree:: - :numbered: - :maxdepth: 4 - - feature.configuration.rst - installation.instruction.rst diff --git a/docs/installationprocedure/installation.instruction.rst b/docs/installationprocedure/installation.instruction.rst deleted file mode 100644 index 0500738..0000000 --- a/docs/installationprocedure/installation.instruction.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. 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/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 `_. + +Examples of test usage can be found on the 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 + + + diff --git a/docs/releasenotes/index.rst b/docs/releasenotes/index.rst deleted file mode 100644 index a999c8e..0000000 --- a/docs/releasenotes/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -************************** -OPNFV Models Release Notes -************************** - -.. toctree:: - :numbered: - :maxdepth: 4 - - release.notes.rst diff --git a/docs/releasenotes/release.notes.rst b/docs/releasenotes/release.notes.rst deleted file mode 100644 index 410d1cd..0000000 --- a/docs/releasenotes/release.notes.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. 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 - -Release Notes -============= - -Models Danube Release Scope ---------------------------- - -OPNFV Danube includes: - - * Further enhancements of Models test scripts - - - - diff --git a/docs/testing/index.rst b/docs/testing/index.rst new file mode 100644 index 0000000..1be820f --- /dev/null +++ b/docs/testing/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 Testing +==================== + +.. toctree:: + :maxdepth: 1 + + usecases.rst diff --git a/docs/testing/usecases.rst b/docs/testing/usecases.rst new file mode 100644 index 0000000..c736ac7 --- /dev/null +++ b/docs/testing/usecases.rst @@ -0,0 +1,22 @@ +.. 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 Use Cases +====================== + +Implemented in Current Release +------------------------------ + +Tacker Hello World +.................. + +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. +A single-node simple python web server, connected to two internal networks +(private and admin), and accessible via a floating IP. + +A complete list of use cases is located on the +`Models Testing `_ wiki page. diff --git a/docs/userguide/feature.usage.rst b/docs/userguide/feature.usage.rst deleted file mode 100644 index ec628bb..0000000 --- a/docs/userguide/feature.usage.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. 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 Capabilities and Usage -============================= - -Current information on the capabilities of the Models project can be found on the Models `wiki `_. - -Examples of test usage can be found on the Models `testing `_ page. - diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst deleted file mode 100644 index 6e45330..0000000 --- a/docs/userguide/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -*********************** -OPNFV Models User Guide -*********************** - -.. toctree:: - :numbered: - :maxdepth: 4 - - feature.usage.rst -- cgit 1.2.3-korg