diff options
22 files changed, 402 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/development/design/architecture.rst b/docs/development/design/architecture.rst new file mode 100644 index 0000000..0116d1d --- /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 VES Danube Architecture +============================= + +.. contents:: + :depth: 3 + :local: + +Please see the OPNFV VES `wiki <https://wiki.opnfv.org/display/ves>`_ +for an architectural overview. 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..fc1fec5 --- /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 VES 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..cc1c5ac --- /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 VES 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..3d7673a --- /dev/null +++ b/docs/development/overview/overview.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 + +========================= +OPNFV VES Danube Overview +========================= + +.. contents:: + :depth: 3 + :local: + +Introduction +------------ +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. + + + + + diff --git a/docs/development/requirements/index.rst b/docs/development/requirements/index.rst new file mode 100644 index 0000000..4d7e7aa --- /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 VES 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..1da3c90 --- /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 VES Danube Requirements +============================= + +.. contents:: + :depth: 3 + :local: + +Please see the OPNFV Models `wiki <https://wiki.opnfv.org/display/ves>`_ +for details on VES project's development requirements. diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst new file mode 100644 index 0000000..8f36f82 --- /dev/null +++ b/docs/release/configguide/featureconfig.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 VES Configuration +======================= + +.. contents:: + :depth: 3 + :local: + +Hardware configuration +---------------------- +There is currently no OPNFV installer support for the components used by the VES project. + +Feature configuration +--------------------- +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/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..53fd26a --- /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 VES 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..de3f45e --- /dev/null +++ b/docs/release/installation/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/release/release-notes/index.rst b/docs/release/release-notes/index.rst new file mode 100644 index 0000000..b0639bc --- /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 VES 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..34a3796 --- /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 VES Release Notes +======================= + +This document provides the release notes for the Danube Release of VES. + +.. 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 VES 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..d188cb5 --- /dev/null +++ b/docs/release/scenarios/scenario.name/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 VES 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..005d537 --- /dev/null +++ b/docs/release/scenarios/scenario.name/scenario.description.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 VES Scenarios +=================== + +This document provides scenario level details for the Danube release of VES. + +.. contents:: + :depth: 3 + :local: + +Introduction +------------ +There are no formal 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..d9fd787 --- /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 VES User Guide +==================== + +.. contents:: + :depth: 3 + :local: + +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/release/userguide/index.rst b/docs/release/userguide/index.rst new file mode 100644 index 0000000..39def0a --- /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 VES User Guide +==================== + +.. toctree:: + :maxdepth: 1 + + feature.userguide + + + diff --git a/docs/testing/index.rst b/docs/testing/index.rst new file mode 100644 index 0000000..1f5cb52 --- /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 VES Testing +================= + +.. toctree:: + :maxdepth: 1 + + usecases.rst diff --git a/docs/testing/usecases.rst b/docs/testing/usecases.rst new file mode 100644 index 0000000..7c8be06 --- /dev/null +++ b/docs/testing/usecases.rst @@ -0,0 +1,30 @@ +.. 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 VES Use Cases +=================== + +Implemented in Current Release +------------------------------ + +VES Hello World +............... + +The VES Hello World demo runs in a multi-node bare metal or virtual install, +adding VES agents for the hosts (bare metal, VMs) and apps. Data is collected +by `collectd <https://collectd.org/>`_ and sent in JSON format via HTTP to a the +VES collector agent. + +This use case is a basic TOSCA blueprint-based test using Tacker as the VNFM: +a single-node simple python web server, connected to two internal networks (private and admin), +and accessible via a floating IP. This is based upon the OpenStack Tacker project's 'tosca-vnfd-hello-world' blueprint, +as modified/extended for testing of Tacker-supported features as of OpenStack Newton. + + +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/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 |