docs/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 ******************
   5 Danube 1.0 Release
   6 ******************
   7
   8 *************************
   9 Overview of Documentation
  10 *************************
  11
  12 .. toctree::
  13    :caption: Overview
  14    :numbered:
  15    :maxdepth: 4
  16
  17    ./overview/kvmfornfv_overview.rst
  18
  19 ********************************
  20 KVMFORNFV Installation Procedure
  21 ********************************
  22
  23 .. toctree::
  24    :caption: Installation Procedure
  25    :numbered:
  26    :maxdepth: 4
  27
  28    ./installationprocedure/abstract.rst
  29    ./installationprocedure/kvm4nfv-cicd.installation.instruction.rst
  30    ./installationprocedure/kvm4nfv-cicd.release.notes.rst
  31
  32 **********************
  33 KVMFORNFV Design Guide
  34 **********************
  35
  36 .. toctree::
  37    :caption: Design Overview and Description
  38    :numbered:
  39    :maxdepth: 4
  40
  41    ./design/kvmfornfv_design.rst
  42
  43 ****************************
  44 KVMFORNFV Requirements Guide
  45 ****************************
  46
  47 .. toctree::
  48    :caption: Requirements
  49    :numbered:
  50    :maxdepth: 4
  51
  52    ./requirements/kvmfornfv_requirements.rst
  53
  54 *****************************
  55 KVMFORNFV Configuration Guide
  56 *****************************
  57
  58 .. toctree::
  59    :caption: Configuration Guide
  60    :numbered:
  61    :maxdepth: 4
  62
  63    ./configurationguide/abstract.rst
  64    ./configurationguide/configuration.options.render.rst
  65    ./configurationguide/scenariomatrix.rst
  66    ./configurationguide/low-latency.feature.configuration.description.rst
  67
  68 ********************************************
  69 KVMFORNFV Scenarios Overview and Description
  70 ********************************************
  71
  72 .. toctree::
  73    :caption: Scenario Overview and Description
  74    :numbered:
  75    :maxdepth: 4
  76
  77    ./scenarios/abstract.rst
  78    ./scenarios/kvmfornfv.scenarios.description.rst
  79
  80 *******************************************************
  81 os-nosdn-kvm_nfv_ovs_dpdk-noha Overview and Description
  82 *******************************************************
  83
  84 .. toctree::
  85    :caption: os-nosdn-kvm_nfv_ovs_dpdk-noha
  86    :numbered:
  87    :maxdepth: 3
  88
  89    ./scenarios/os-nosdn-kvm_nfv_ovs_dpdk-noha/os-nosdn-kvm_nfv_ovs_dpdk-noha.description.rst
  90
  91 *****************************************************
  92 os-nosdn-kvm_nfv_ovs_dpdk-ha Overview and Description
  93 *****************************************************
  94
  95 .. toctree::
  96    :caption: os-nosdn-kvm_nfv_ovs_dpdk-ha
  97    :numbered:
  98    :maxdepth: 3
  99
 100    ./scenarios/os-nosdn-kvm_nfv_ovs_dpdk-ha/os-nosdn-kvm_nfv_ovs_dpdk-ha.description.rst
 101
 102 ***********************************************************
 103 os-nosdn-kvm_nfv_ovs_dpdk_bar-noha Overview and Description
 104 ***********************************************************
 105
 106 .. toctree::
 107    :caption: os-nosdn-kvm_nfv_ovs_dpdk_bar-noha
 108    :numbered:
 109    :maxdepth: 3
 110
 111    ./scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha/os-nosdn-kvm_nfv_ovs_dpdk_bar-noha.description.rst
 112
 113 *********************************************************
 114 os-nosdn-kvm_nfv_ovs_dpdk_bar-ha Overview and Description
 115 *********************************************************
 116
 117 .. toctree::
 118    :caption: os-nosdn-kvm_nfv_ovs_dpdk_bar-ha
 119    :numbered:
 120    :maxdepth: 3
 121
 122    ./scenarios/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha/os-nosdn-kvm_nfv_ovs_dpdk_bar-ha.description.rst
 123
 124 ********************
 125 KVMFORNFV User Guide
 126 ********************
 127
 128 .. toctree::
 129    :caption: User Guide
 130    :numbered:
 131    :maxdepth: 3
 132
 133    ./userguide/abstract.rst
 134    ./userguide/introduction.rst
 135    ./userguide/common.platform.render.rst
 136    ./userguide/feature.userguide.render.rst
 137    ./userguide/Ftrace.debugging.tool.userguide.rst
 138    ./userguide/kvmfornfv.cyclictest-dashboard.userguide.rst
 139    ./userguide/low_latency.userguide.rst
 140    ./userguide/live_migration.userguide.rst
 141    ./userguide/openstack.rst
 142    ./userguide/packet_forwarding.userguide.rst
 143    ./userguide/pcm_utility.userguide.rst
 144    ./userguide/tuning.userguide.rst
 145
 146 **********************
 147 KVMFORNFV Releasenotes
 148 **********************
 149
 150 .. toctree::
 151    :caption: Releasenotes
 152    :numbered:
 153    :maxdepth: 3
 154
 155    ./releasenotes/release-notes.rst
 156
 157 ******************
 158 KVMFORNFV Glossary
 159 ******************
 160
 161 .. toctree::
 162    :caption: Glossary
 163    :numbered:
 164    :maxdepth: 3
 165
 166    ./glossary/kvmfornfv_glossary.rst