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