From 0655e7e09e0e4368c962c96b0db537b4c7a7cd37 Mon Sep 17 00:00:00 2001 From: Aimee Ukasick Date: Thu, 9 Feb 2017 09:54:13 -0600 Subject: Update for Danube doc structure JIRA: VES-1 Change-Id: I4c804f65e485f4d4d539263c6702212015d9c99b Signed-off-by: Aimee Ukasick --- 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 | 25 ++++++++++++ docs/development/requirements/index.rst | 13 +++++++ docs/development/requirements/requirements.rst | 15 ++++++++ 7 files changed, 149 insertions(+) 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 (limited to 'docs/development') 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 `_ +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 `_ 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 `_ +for details on VES project's development requirements. -- cgit 1.2.3-korg