docs/documentation/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 .. (c) Open Platform for NFV Project, Inc. and its contributors
   4
   5 *******************
   6 OPNFV Documentation
   7 *******************
   8
   9 ==============================
  10 Colorado Release Documentation
  11 ==============================
  12
  13 OPNFV release documentation is structured with brief platform-level documents referencing
  14 more detailed installation instructions and descriptive documentation.
  15
  16 Platform documentation
  17 ======================
  18
  19 * `OPNFV platform overview document <http://artifacts.opnfv.org/opnfvdocs/colorado/docs/overview/index.html>`_
  20 * `OPNFV Installation instruction <http://artifacts.opnfv.org/opnfvdocs/colorado/docs/installationprocedure/index.html>`_
  21 * `OPNFV user guide <http://artifacts.opnfv.org/opnfvdocs/colorado/docs/userguide/index.html>`_
  22
  23 Installation instructions
  24 =========================
  25
  26 * `Apex installation instruction <http://artifacts.opnfv.org/apex/colorado/docs/installationprocedure/index.html>`_
  27 * `Apex release notes <http://artifacts.opnfv.org/apex/colorado/docs/releasenotes/index.html>`_
  28 * `Compass installation instruction <http://artifacts.opnfv.org/compass4nfv/colorado/docs/installationprocedure/index.html>`_
  29 * `Compass release notes <http://artifacts.opnfv.org/compass4nfv/colorado/docs/releasenotes/index.html>`_
  30 * `Fuel installation instruction <http://artifacts.opnfv.org/fuel/colorado/docs/installationprocedure/index.html>`_
  31 * `Fuel release notes <http://artifacts.opnfv.org/fuel/colorado/docs/releasenotes/index.html>`_
  32 * `Joid installation instruction <http://artifacts.opnfv.org/joid/colorado/docs/installationprocedure/index.html>`_
  33 * `Joid release notes <http://artifacts.opnfv.org/joid/colorado/docs/releasenotes/index.html>`_
  34
  35 Feature project documentation
  36 =============================
  37
  38 ---------------
  39 ARMband project
  40 ---------------
  41
  42 * `Installation instruction <http://artifacts.opnfv.org/armband/colorado/docs/installationprocedure/index.html>`_
  43 * `Release notes <http://artifacts.opnfv.org/armband/colorado/docs/releasenotes/index.html>`_
  44
  45 ----------------------------------------------
  46 Copper release documentation
  47 ----------------------------------------------
  48
  49 * `Design documentation <http://artifacts.opnfv.org/copper/colorado/docs/design/index.html>`_
  50 * `Installation instruction <http://artifacts.opnfv.org/copper/colorado/docs/installationprocedure/index.html>`_
  51 * `User guide <http://artifacts.opnfv.org/copper/colorado/docs/userguide/index.html>`_
  52 * `Release notes <http://artifacts.opnfv.org/copper/colorado/docs/releasenotes/index.html>`_
  53
  54 -----------------------------------------------------
  55 Doctor features and capabilities
  56 -----------------------------------------------------
  57
  58 * `Project overview <http://artifacts.opnfv.org/doctor/colorado/docs/platformoverview/index.html>`_
  59 * `User guide <http://artifacts.opnfv.org/doctor/colorado/docs/userguide/index.html>`_
  60 * `Release notes <http://artifacts.opnfv.org/doctor/colorado/docs/releasenotes/index.html>`_
  61
  62 ----------------------------------------------------------------
  63 Domino features and capabilities
  64 ----------------------------------------------------------------
  65
  66 * `User guide <http://artifacts.opnfv.org/domino/colorado/docs/userguide/index.html>`_
  67
  68 -------------------------------------------------
  69 FastDataStacks feature and scenario documentation
  70 -------------------------------------------------
  71
  72 * `OpenDaylight integrated fd.io scenario description <http://artifacts.opnfv.org/fds/colorado/scenarios_os-odl_l2-fdio-noha/index.html>`_
  73
  74 ------------------------------------
  75 IPv6 platform support and capability
  76 ------------------------------------
  77
  78 * `Configuration guide <http://artifacts.opnfv.org/ipv6/colorado/docs/installationprocedure/index.html>`_
  79 * `User guide <http://artifacts.opnfv.org/ipv6/colorado/docs/userguide/index.html>`_
  80
  81 -----------
  82 KVM for NFV
  83 -----------
  84
  85 * `Installation instruction <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/installationprocedure/index.html>`_
  86 * `Configuration guide <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/configurationguide/index.html>`_
  87 * `User guide <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/userguide/index.html>`_
  88 * `Release notes <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/releasenotes/index.html>`_
  89
  90 --------------------------------
  91 MOON security management for NFV
  92 --------------------------------
  93
  94 * `Project and Scenario overview <http://artifacts.opnfv.org/moon/colorado/docs/colorado_scenarios_os-odl_l2-moon-ha/index.html>`_
  95 * `Installation instruction <http://artifacts.opnfv.org/moon/colorado/docs/installationprocedure/index.html>`_
  96 * `Configuration guide <http://artifacts.opnfv.org/moon/colorado/docs/configurationguide/index.html>`_
  97 * `User guide <http://artifacts.opnfv.org/moon/colorado/docs/userguide/index.html>`_
  98 * `Release notes <http://artifacts.opnfv.org/moon/colorado/docs/releasenotes/index.html>`_
  99
 100 ----------------------------
 101 Multisite datacenter project
 102 ----------------------------
 103
 104 * `Installation instruction <http://artifacts.opnfv.org/multisite/colorado/installationprocedure/index.html>`_
 105 * `User guide <http://artifacts.opnfv.org/multisite/colorado/userguide/index.html>`_
 106 * `Release notes <http://artifacts.opnfv.org/multisite/colorado/releasenotes/index.html>`_
 107
 108 -------------------------
 109 Network readiness project
 110 -------------------------
 111
 112 * `Requirements document <http://artifacts.opnfv.org/netready/colorado/docs/requirements/index.html>`_
 113
 114 ----------------------
 115 ONOS framework project
 116 ----------------------
 117
 118 * `Installation instruction <http://artifacts.opnfv.org/onosfw/colorado/docs/installationprocedure/index.html>`_
 119 * `User guide <http://artifacts.opnfv.org/onosfw/colorado/docs/userguide/index.html>`_
 120
 121 ----------------------------
 122 OVSNFV release documentation
 123 ----------------------------
 124
 125 * `OVS for NFV scenario description <http://artifacts.opnfv.org/ovsnfv/colorado/docs/scenarios_os-nosdn-ovs/index.html>`_
 126 * `Configuration guide <http://artifacts.opnfv.org/ovsnfv/colorado/docs/configguide/index.html>`_
 127 * `User guide <http://artifacts.opnfv.org/ovsnfv/colorado/docs/userguide/index.html>`_
 128
 129 --------------
 130 Parser project
 131 --------------
 132
 133 * `Parser release documentation <http://artifacts.opnfv.org/parser/colorado/docs/parser_docs/index.html>`_
 134 * `Installation instruction <http://artifacts.opnfv.org/parser/colorado/docs/installationprocedure/index.html>`_
 135 * `User guide <http://artifacts.opnfv.org/parser/colorado/docs/userguide/index.html>`_
 136
 137 ------
 138 Pharos
 139 ------
 140
 141 * `Pharos specification <http://artifacts.opnfv.org/pharos/colorado/docs/specification/index.html>`_
 142 * `Configuration guide <http://artifacts.opnfv.org/pharos/colorado/docs/configguide/index.html>`_
 143
 144 -------
 145 Promise
 146 -------
 147
 148 * `Requirement specification <http://artifacts.opnfv.org/promise/colorado/docs/requirements/index.html>`_
 149 * `Installation and configuration guide <http://artifacts.opnfv.org/promise/colorado/docs/installationprocedure/index.html>`_
 150 * `User guide <http://artifacts.opnfv.org/promise/colorado/docs/userguide/index.html>`_
 151
 152 ------
 153 SDNVPN
 154 ------
 155
 156 * `BGPVPN scenario description <http://artifacts.opnfv.org/sdnvpn/colorado/docs/scenarios_os-odl_l2-bgpvpn/index.html>`_
 157 * `User guide <http://artifacts.opnfv.org/sdnvpn/colorado/docs/userguide/index.html>`_
 158 * `Release notes <http://artifacts.opnfv.org/sdnvpn/colorado/docs/release-notes/index.html>`_
 159
 160 ---
 161 SFC
 162 ---
 163
 164 * `Design documentation <http://artifacts.opnfv.org/sfc/colorado/docs/design/index.html>`_
 165 * `SFC scenario description <http://artifacts.opnfv.org/sfc/colorado/docs/scenarios_os-odl_l2-sfc-noha/index.html>`_
 166 * `High availability SFC scenario description <http://artifacts.opnfv.org/sfc/colorado/docs/scenarios_os-odl_l2-sfc-ha/index.html>`_
 167 * `Installation instruction <http://artifacts.opnfv.org/sfc/colorado/docs/installationprocedure/index.html>`_
 168 * `User guide <http://artifacts.opnfv.org/sfc/colorado/docs/userguide/index.html>`_
 169 * `Release notes <http://artifacts.opnfv.org/sfc/colorado/docs/releasenotes/index.html>`_
 170
 171 ------------------------------------------------
 172 Software fast-path quality metrics documentation
 173 ------------------------------------------------
 174
 175 * `Release and development documentation <http://artifacts.opnfv.org/fastpathmetrics/colorado/index.html>`_
 176
 177
 178 Test Project documentation
 179 ==========================
 180
 181 -------------------------
 182 Bottlenecks documentation
 183 -------------------------
 184
 185 * `Installation instruction <http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html>`_
 186 * `Release notes <http://artifacts.opnfv.org/bottlenecks/docs/releasenotes/index.html>`_
 187
 188 ----------------------
 189 Functest documentation
 190 ----------------------
 191
 192 *  `Configuration guide <http://artifacts.opnfv.org/functest/colorado/docs/configguide/index.html>`_
 193 *  `User guide <http://artifacts.opnfv.org/functest/colorado/docs/userguide/index.html>`_
 194 *  `Developer guide <http://artifacts.opnfv.org/functest/colorado/docs/devguide/index.html>`_
 195 *  `Release notes <http://artifacts.opnfv.org/functest/colorado/docs/release-notes/functest-release.html>`_
 196
 197 -------------------------
 198 vSwitchPerf documentation
 199 -------------------------
 200
 201 * `Release and development documentation  <http://artifacts.opnfv.org/vswitchperf/colorado/docs/index.html>`_
 202
 203 -----------------------
 204 Yardstick documentation
 205 -----------------------
 206
 207 *  `User guide <http://artifacts.opnfv.org/yardstick/colorado/docs/userguide/index.html>`_
 208 *  `Release notes <http://artifacts.opnfv.org/yardstick/colorado/docs/release/index.html>`_
 209