From 8590eb83b1bdadb72f428c4749ff9c24209ee5de Mon Sep 17 00:00:00 2001 From: Aimee Ukasick Date: Fri, 3 Feb 2017 18:38:41 -0600 Subject: Docs Update for Danube JIRA: MODELS-2 Change-Id: Ida73d860b68b494d620a7b34aace6a990528582d Signed-off-by: Aimee Ukasick --- .gitignore | 6 +++ 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 ++++++++++++ .../feature.configuration.rst | 38 ++++++++++++++++ docs/installationprocedure/index.rst | 10 ++++ .../installation.instruction.rst | 24 ++++++++++ docs/releasenotes/index.rst | 9 ++++ docs/releasenotes/release.notes.rst | 18 ++++++++ docs/userguide/feature.usage.rst | 12 +++++ docs/userguide/index.rst | 9 ++++ tests/vHello_Tacker.sh | 2 +- 17 files changed, 261 insertions(+), 1 deletion(-) create mode 100644 .gitignore create mode 100644 docs/design/definitions.rst create mode 100644 docs/design/featureconfig_link.rst create mode 100644 docs/design/featureusage_link.rst create mode 100644 docs/design/index.rst create mode 100644 docs/design/introduction.rst create mode 100644 docs/design/postinstall_link.rst create mode 100644 docs/design/releasenotes_link.rst create mode 100644 docs/design/usecases.rst create mode 100644 docs/installationprocedure/feature.configuration.rst create mode 100644 docs/installationprocedure/index.rst create mode 100644 docs/installationprocedure/installation.instruction.rst create mode 100644 docs/releasenotes/index.rst create mode 100644 docs/releasenotes/release.notes.rst create mode 100644 docs/userguide/feature.usage.rst create mode 100644 docs/userguide/index.rst diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2f5ddf9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +*~ +.*.sw? +/build/ +/docs_build/ +/docs_output/ +/releng/ diff --git a/docs/design/definitions.rst b/docs/design/definitions.rst new file mode 100644 index 0000000..426abda --- /dev/null +++ b/docs/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/design/featureconfig_link.rst b/docs/design/featureconfig_link.rst new file mode 100644 index 0000000..6af66f7 --- /dev/null +++ b/docs/design/featureconfig_link.rst @@ -0,0 +1,2 @@ +.. include:: + ../installationprocedure/feature.configuration.rst diff --git a/docs/design/featureusage_link.rst b/docs/design/featureusage_link.rst new file mode 100644 index 0000000..c3ac10b --- /dev/null +++ b/docs/design/featureusage_link.rst @@ -0,0 +1,2 @@ +.. include:: + ../userguide/feature.usage.rst diff --git a/docs/design/index.rst b/docs/design/index.rst new file mode 100644 index 0000000..982f2a6 --- /dev/null +++ b/docs/design/index.rst @@ -0,0 +1,20 @@ +.. 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 new file mode 100644 index 0000000..ee4cee2 --- /dev/null +++ b/docs/design/introduction.rst @@ -0,0 +1,25 @@ +.. 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 new file mode 100644 index 0000000..ca8d99c --- /dev/null +++ b/docs/design/postinstall_link.rst @@ -0,0 +1,2 @@ +.. include:: + ../installationprocedure/installation.instruction.rst diff --git a/docs/design/releasenotes_link.rst b/docs/design/releasenotes_link.rst new file mode 100644 index 0000000..6ee81a3 --- /dev/null +++ b/docs/design/releasenotes_link.rst @@ -0,0 +1,2 @@ +.. include:: + ../releasenotes/release.notes.rst diff --git a/docs/design/usecases.rst b/docs/design/usecases.rst new file mode 100644 index 0000000..4789fa5 --- /dev/null +++ b/docs/design/usecases.rst @@ -0,0 +1,28 @@ +.. 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/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst new file mode 100644 index 0000000..57b490d --- /dev/null +++ b/docs/installationprocedure/feature.configuration.rst @@ -0,0 +1,38 @@ +.. 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 new file mode 100644 index 0000000..2776b88 --- /dev/null +++ b/docs/installationprocedure/index.rst @@ -0,0 +1,10 @@ +*********************************** +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 new file mode 100644 index 0000000..0500738 --- /dev/null +++ b/docs/installationprocedure/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/releasenotes/index.rst b/docs/releasenotes/index.rst new file mode 100644 index 0000000..a999c8e --- /dev/null +++ b/docs/releasenotes/index.rst @@ -0,0 +1,9 @@ +************************** +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 new file mode 100644 index 0000000..410d1cd --- /dev/null +++ b/docs/releasenotes/release.notes.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 + +Release Notes +============= + +Models Danube Release Scope +--------------------------- + +OPNFV Danube includes: + + * Further enhancements of Models test scripts + + + + diff --git a/docs/userguide/feature.usage.rst b/docs/userguide/feature.usage.rst new file mode 100644 index 0000000..ec628bb --- /dev/null +++ b/docs/userguide/feature.usage.rst @@ -0,0 +1,12 @@ +.. 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 new file mode 100644 index 0000000..6e45330 --- /dev/null +++ b/docs/userguide/index.rst @@ -0,0 +1,9 @@ +*********************** +OPNFV Models User Guide +*********************** + +.. toctree:: + :numbered: + :maxdepth: 4 + + feature.usage.rst diff --git a/tests/vHello_Tacker.sh b/tests/vHello_Tacker.sh index 5319092..4ae1575 100644 --- a/tests/vHello_Tacker.sh +++ b/tests/vHello_Tacker.sh @@ -21,7 +21,7 @@ # 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 -# Mitaka. +# Newton. # # Pre-State: # This test can be run in either an OPNFV environment, or an plain OpenStack -- cgit 1.2.3-korg