From: Frank Brockners Date: Thu, 11 Aug 2016 15:10:41 +0000 (-0700) Subject: Proper directory structure for scenario docs X-Git-Tag: colorado.1.0~12 X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=12a05d6f8632b24f6687ba8b820e4889e3dc359d;p=fds.git Proper directory structure for scenario docs Evolving the scenario documentation to meet the directory structure required by the OPNFV tool chain Change-Id: Iab441dff604446ea06d3b928e5c5e03c6c141bfc Signed-off-by: Frank Brockners --- diff --git a/docs/userguide/FDS-nosdn-overview.png b/docs/scenarios/os-nosdn-fdio-noha/FDS-nosdn-overview.png similarity index 100% rename from docs/userguide/FDS-nosdn-overview.png rename to docs/scenarios/os-nosdn-fdio-noha/FDS-nosdn-overview.png diff --git a/docs/scenarios/os-nosdn-fdio-noha/index.rst b/docs/scenarios/os-nosdn-fdio-noha/index.rst new file mode 100644 index 0000000..3a5bb20 --- /dev/null +++ b/docs/scenarios/os-nosdn-fdio-noha/index.rst @@ -0,0 +1,18 @@ +.. OPNFV - Open Platform for Network Function Virtualization +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +********************************************************************** +Fast Data Stacks Scenario: os-nosdn-fdio-noha Overview and Description +********************************************************************** + +Scenario: "OpenStack - FD.io" (apex-os-nosdn-fdio-noha) +is a scenario developed as part of the FastDataStacks +OPNFV project. + +.. toctree:: + :numbered: + :maxdepth: 2 + + scenario.description.rst diff --git a/docs/userguide/scenario-apex-os-nosdn-fdio-noha.rst b/docs/scenarios/os-nosdn-fdio-noha/scenario.description.rst similarity index 100% rename from docs/userguide/scenario-apex-os-nosdn-fdio-noha.rst rename to docs/scenarios/os-nosdn-fdio-noha/scenario.description.rst diff --git a/docs/userguide/FDS-L3-tenant-connectivity.png b/docs/scenarios/os-odl_l2-fdio-noha/FDS-L3-tenant-connectivity.png similarity index 100% rename from docs/userguide/FDS-L3-tenant-connectivity.png rename to docs/scenarios/os-odl_l2-fdio-noha/FDS-L3-tenant-connectivity.png diff --git a/docs/userguide/FDS-basic-callflow.jpg b/docs/scenarios/os-odl_l2-fdio-noha/FDS-basic-callflow.jpg similarity index 100% rename from docs/userguide/FDS-basic-callflow.jpg rename to docs/scenarios/os-odl_l2-fdio-noha/FDS-basic-callflow.jpg diff --git a/docs/userguide/FDS-odl_l2-overview.png b/docs/scenarios/os-odl_l2-fdio-noha/FDS-odl_l2-overview.png similarity index 100% rename from docs/userguide/FDS-odl_l2-overview.png rename to docs/scenarios/os-odl_l2-fdio-noha/FDS-odl_l2-overview.png diff --git a/docs/scenarios/os-odl_l2-fdio-noha/index.rst b/docs/scenarios/os-odl_l2-fdio-noha/index.rst new file mode 100644 index 0000000..cd8f2d8 --- /dev/null +++ b/docs/scenarios/os-odl_l2-fdio-noha/index.rst @@ -0,0 +1,18 @@ +.. OPNFV - Open Platform for Network Function Virtualization +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +*********************************************************************** +Fast Data Stacks Scenario: os-odl_l2-fdio-noha Overview and Description +*********************************************************************** + +Scenario: "OpenStack - Opendaylight (L2) - FD.io" (apex-os-odl_l2-fdio-noha) +is a scenario developed as part of the FastDataStacks +OPNFV project. + +.. toctree:: + :numbered: + :maxdepth: 2 + + scenario.description.rst diff --git a/docs/userguide/scenario-apex-os-odl_l2-fdio-noha.rst b/docs/scenarios/os-odl_l2-fdio-noha/scenario.description.rst similarity index 98% rename from docs/userguide/scenario-apex-os-odl_l2-fdio-noha.rst rename to docs/scenarios/os-odl_l2-fdio-noha/scenario.description.rst index 39c6b47..c2f2fca 100755 --- a/docs/userguide/scenario-apex-os-odl_l2-fdio-noha.rst +++ b/docs/scenarios/os-odl_l2-fdio-noha/scenario.description.rst @@ -166,7 +166,9 @@ store. **Virtual Bridge Domain (VBD) Store and Manager**: The virtual bridge domain manager is responsible for configuring the VxLAN overlay tunnel infrastructure to arrive at a desired bridged topology between multiple (VPP) compute nodes. -VDB configures VXLAN tunnels always into a full-mesh with split-horizon group forwarding applied on any domain facing tunnel interface (i.e. forwarding behavior will be that used for VPLS). +VDB configures VXLAN tunnels always into a full-mesh with split-horizon group +forwarding applied on any domain facing tunnel interface (i.e. forwarding +behavior will be that used for VPLS). **NETCONF Mount Point Service & Connector**: Collectively referred to as Netconf Services, provide the NETCONF interface for accessing VPP configuration diff --git a/docs/userguide/FDS-L3-DVR-example.png b/docs/scenarios/os-odl_l3-fdio-noha/FDS-L3-DVR-example.png similarity index 100% rename from docs/userguide/FDS-L3-DVR-example.png rename to docs/scenarios/os-odl_l3-fdio-noha/FDS-L3-DVR-example.png diff --git a/docs/scenarios/os-odl_l3-fdio-noha/FDS-basic-callflow.jpg b/docs/scenarios/os-odl_l3-fdio-noha/FDS-basic-callflow.jpg new file mode 100755 index 0000000..96464f8 Binary files /dev/null and b/docs/scenarios/os-odl_l3-fdio-noha/FDS-basic-callflow.jpg differ diff --git a/docs/userguide/FDS-odl_l3-overview.png b/docs/scenarios/os-odl_l3-fdio-noha/FDS-odl_l3-overview.png similarity index 100% rename from docs/userguide/FDS-odl_l3-overview.png rename to docs/scenarios/os-odl_l3-fdio-noha/FDS-odl_l3-overview.png diff --git a/docs/scenarios/os-odl_l3-fdio-noha/index.rst b/docs/scenarios/os-odl_l3-fdio-noha/index.rst new file mode 100644 index 0000000..7ae4f83 --- /dev/null +++ b/docs/scenarios/os-odl_l3-fdio-noha/index.rst @@ -0,0 +1,18 @@ +.. OPNFV - Open Platform for Network Function Virtualization +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +*********************************************************************** +Fast Data Stacks Scenario: os-odl_l3-fdio-noha Overview and Description +*********************************************************************** + +Scenario: "OpenStack - Opendaylight (L3) - FD.io" (apex-os-odl_l3-fdio-noha) +is a scenario developed as part of the FastDataStacks +OPNFV project. + +.. toctree:: + :numbered: + :maxdepth: 2 + + scenario.description.rst diff --git a/docs/userguide/scenario-apex-os-odl_l3-fdio-noha.rst b/docs/scenarios/os-odl_l3-fdio-noha/scenario.description.rst similarity index 100% rename from docs/userguide/scenario-apex-os-odl_l3-fdio-noha.rst rename to docs/scenarios/os-odl_l3-fdio-noha/scenario.description.rst diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst deleted file mode 100644 index 54f12ba..0000000 --- a/docs/userguide/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. OPNFV - Open Platform for Network Function Virtualization -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - - -************************** -Fast Data Stacks Scenarios -************************** - -.. toctree:: - :numbered: - :maxdepth: 2 - - scenario-apex-os-nosdn-fdio-noha.rst - scenario-apex-os-odl_l2-fdio-noha.rst - scenario-apex-os-odl_l3-fdio-noha.rst