diff options
| -rw-r--r-- | .gitignore | 6 | ||||
| -rw-r--r-- | docs/design/definitions.rst | 53 | ||||
| -rw-r--r-- | docs/design/featureconfig_link.rst | 2 | ||||
| -rw-r--r-- | docs/design/featureusage_link.rst | 2 | ||||
| -rw-r--r-- | docs/design/index.rst | 20 | ||||
| -rw-r--r-- | docs/design/introduction.rst | 22 | ||||
| -rw-r--r-- | docs/design/postinstall_link.rst | 2 | ||||
| -rw-r--r-- | docs/design/releasenotes_link.rst | 2 | ||||
| -rw-r--r-- | docs/design/usecases.rst | 16 | ||||
| -rw-r--r-- | docs/installationprocedure/feature.configuration.rst | 38 | ||||
| -rw-r--r-- | docs/installationprocedure/index.rst | 10 | ||||
| -rw-r--r-- | docs/installationprocedure/installation.instruction.rst | 13 | ||||
| -rw-r--r-- | docs/releasenotes/index.rst | 9 | ||||
| -rw-r--r-- | docs/releasenotes/release.notes.rst | 18 | ||||
| -rw-r--r-- | docs/userguide/feature.usage.rst | 12 | ||||
| -rw-r--r-- | docs/userguide/index.rst | 9 | ||||
| -rw-r--r-- | tests/docs/ves_data_model.json (renamed from docs/ves_data_model.json) | 0 |
17 files changed, 234 insertions, 0 deletions
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..9c5e76c --- /dev/null +++ b/docs/design/introduction.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 + +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 VNF Event Stream (VES) project. + +The `OPNFV VES <https://wiki.opnfv.org/display/ves>`_ project aims to develop OPNFV platform support for VNF event streams, in a common model and format intended for use by NFV Service Providers (SPs), e.g. in managing VNF health and lifecycle. The project’s goal is to enable a significant reduction in the effort to develop and integrate VNF telemetry-related data into automated VNF management systems, by promoting convergence toward a common event stream format and collection system. + +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..5df656c --- /dev/null +++ b/docs/design/usecases.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 + +Use Cases +========= + +Implemented in Current Release +------------------------------ + +VES Hello World Demo +.................... + +Information on and links to the VES Hello World demo can be found on the `VES Demo page <https://wiki.opnfv.org/display/ves/vHello_VES+Demo>`_. + diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst new file mode 100644 index 0000000..9359aaf --- /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 + +VES Configuration +==================== + + +Pre-configuration Activities +---------------------------- +None required. + +Hardware Configuration +---------------------- +There is no specific hardware configuration required for the VES project. + +Feature Configuration +--------------------- + +OPNFV Installer Support +....................... + +There is currently no OPNFV installer support for the components used by the VES project. + + +Manual Installation +................... + +The VES test scripts automatically install VES components. Instructions are included in the following scripts: + + * ves/tests/vHello_VES.sh + +Prerequisites to using vHello_VES: + + * OPFNV installed via JOID or Apex + + 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..de3f45e --- /dev/null +++ b/docs/installationprocedure/installation.instruction.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 + +VES Post Installation Procedures +================================ + +None + + + + 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..f3779b0 --- /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 +============= + +VES Danube Release Scope +--------------------------- + +OPNFV Danube includes: + + * Further enhancements of VES test scripts + + + + diff --git a/docs/userguide/feature.usage.rst b/docs/userguide/feature.usage.rst new file mode 100644 index 0000000..c82b861 --- /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 + +VES Capabilities and Usage +============================= + +Current information on the capabilities of the VES project can be found on the VES `wiki <https://wiki.opnfv.org/display/ves>`_. + +Examples of test usage can be found on the VES `Demo <https://https://wiki.opnfv.org/display/ves/vHello_VES+Demo>`_ 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/docs/ves_data_model.json b/tests/docs/ves_data_model.json index e88a927..e88a927 100644 --- a/docs/ves_data_model.json +++ b/tests/docs/ves_data_model.json |