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
13 OPNFV release documentation is structured with brief platform-level documents referencing
14 more detailed installation instructions and descriptive documentation.
16 Platform documentation
17 ======================
19 * `OPNFV platform overview document <http://artifacts.opnfv.org/opnfvdocs/docs/overview/index.html>`_
20 * `Installation & configuration guide <http://artifacts.opnfv.org/opnfvdocs/docs/installationprocedure/index.html>`_
21 * `The OPNFV user guide <http://artifacts.opnfv.org/opnfvdocs/docs/userguide/index.html>`_
23 Installation instructions
24 =========================
26 * `Apex installation instruction <http://artifacts.opnfv.org/apex/docs/installationprocedure/index.html>`_
27 * `Apex release notes <http://artifacts.opnfv.org/apex/docs/releasenotes/index.html>`_
28 * `Compass installation instruction <http://artifacts.opnfv.org/compass4nfv/docs/installationprocedure/index.html>`_
29 * `Compass release notes <http://artifacts.opnfv.org/compass4nfv/docs/releasenotes/index.html>`_
30 * `Fuel installation instruction <http://artifacts.opnfv.org/fuel/docs/installationprocedure/index.html>`_
31 * `Fuel release notes <http://artifacts.opnfv.org/fuel/docs/releasenotes/index.html>`_
32 * `Joid installation instruction <http://artifacts.opnfv.org/joid/docs/installationprocedure/index.html>`_
33 * `Joid release notes <http://artifacts.opnfv.org/joid/docs/releasenotes/index.html>`_
35 Feature Project documentation
36 =============================
38 ----------------------------------------------
39 Copper, policy features, release documentation
40 ----------------------------------------------
42 * `Copper release documentation <http://artifacts.opnfv.org/copper/docs/design/index.html>`_
44 -----------------------------------------------------
45 Doctor, fault notification, features and capabilities
46 -----------------------------------------------------
48 * `The doctor overview document <http://artifacts.opnfv.org/doctor/docs/platformoverview/index.html>`_
49 * `Doctor user guide <http://artifacts.opnfv.org/doctor/docs/userguide/index.html>`_
51 ----------------------------------------------------------------
52 Domino, template distribution service, features and capabilities
53 ----------------------------------------------------------------
55 * `User guide <http://artifacts.opnfv.org/domino/docs/userguide/index.html>`_
56 * `Configuration guide <http://artifacts.opnfv.org/domino/docs/configguide/index.html>`_
58 -------------------------------------------------
59 FastDataStacks feature and scenario documentation
60 -------------------------------------------------
62 * `Neutron integrated fd.io scenario description <http://artifacts.opnfv.org/fds/docs/scenarios_os-nosdn-fdio-noha/index.html>`_
63 * `OpenDaylight integrated fd.io scenario description <http://artifacts.opnfv.org/fds/docs/scenarios_os-odl_l2-fdio-noha/index.html>`_
65 ---------------------------------------
66 High Availability in the OPNFV platform
67 ---------------------------------------
69 Needs to be confirmed where the HA docs will come from.
71 * `High availability scenarios <https://wiki.opnfv.org/download/attachments/2926157/scenario_analysis_for_high_availability_in_nfv.pdf?version=1&modificationDate=1458849162000&api=v2>`_
72 * `Platform needs for supporting high availability <https://wiki.opnfv.org/download/attachments/2926157/releases_brahmaputra_ha_requirement.pdf?version=1&modificationDate=1458849162000&api=v2>`_
75 ------------------------------------
76 IPv6 platform support and capability
77 ------------------------------------
79 * `IPv6 user guide <http://artifacts.opnfv.org/ipv6/docs/userguide/index.html>`_
80 * `Installation of routing functions <http://artifacts.opnfv.org/ipv6/docs/reldoc/index.html>`_
86 * `Installation guide <http://artifacts.opnfv.org/kvmfornfv/docs/installationprocedure/index.html>`_
87 * `User guide <http://artifacts.opnfv.org/kvmfornfv/docs/userguide/index.html>`_
88 * `Configuration guide <http://artifacts.opnfv.org/kvmfornfv/docs/configurationguide/index.html>`_
89 * `Release notes <http://artifacts.opnfv.org/kvmfornfv/docs/releasenotes/index.html>`_
91 -------------------------
92 Network readiness project
93 -------------------------
95 * `Network readiness report <http://artifacts.opnfv.org/netready/docs/requirements/index.html>`_
97 ----------------------
98 ONOS framework project
99 ----------------------
101 * `Installation guide <http://artifacts.opnfv.org/onosfw/docs/installationprocedure/index.html>`_
102 * `User guide <http://artifacts.opnfv.org/onosfw/docs/userguide/index.html>`_
104 ----------------------------
105 OVSNFV release documentation
106 ----------------------------
108 * `Configuration guide <http://artifacts.opnfv.org/ovsnfv/docs/configguide/index.html>`_
109 * `User guide <http://artifacts.opnfv.org/ovsnfv/docs/userguide/index.html>`_
110 * `Release notes <http://artifacts.opnfv.org/ovsnfv/docs/release/index.html>`_
111 * `OVS for NFV scenario description <http://artifacts.opnfv.org/ovsnfv/docs/scenarios_os-nosdn-ovs/index.html>`_
117 * `Parser release documentation <http://artifacts.opnfv.org/parser/docs/parser_docs/index.html>`_
118 * `Installation guide <http://artifacts.opnfv.org/parser/docs/installationprocedure/index.html>`_
119 * `User guide <http://artifacts.opnfv.org/parser/docs/userguide/index.html>`_
121 Test Project documentation
122 ==========================
124 ----------------------
125 Functest documentation
126 ----------------------
128 * `The Functest configuration guide <http://artifacts.opnfv.org/functest/docs/configguide/index.html>`_
129 * `The Functest user Guide <http://artifacts.opnfv.org/functest/docs/userguide/index.html>`_
130 * `A developer guide for working with functest <http://artifacts.opnfv.org/functest/docs/devguide/index.html>`_
131 * `Functest release Notes <http://artifacts.opnfv.org/functest/docs/release-notes/functest-release.html>`_
133 -----------------------
134 Yardstick documentation
135 -----------------------
137 * `The Yardstick user guide <http://artifacts.opnfv.org/yardstick/docs/userguide/index.html>`_
138 * `A code documentation and developer guide <http://artifacts.opnfv.org/yardstick/docs/apidocs/index.html>`_
139 * `Yardstick release notes <http://artifacts.opnfv.org/yardstick/docs/release/index.html>`_
141 -------------------------
142 vSwitchPerf documentation
143 -------------------------
145 * `Release and development documentation <http://artifacts.opnfv.org/vswitchperf/docs/index.html>`_
147 ------------------------------------------------
148 Software fast-path quality metrics documentation
149 ------------------------------------------------
151 * `Release and development documentation <http://artifacts.opnfv.org/fastpathmetrics/docs/index.html>`_
153 -------------------------
154 Bottlenecks documentation
155 -------------------------
157 * `Installation procedure <http://artifacts.opnfv.org/bottlenecks/docs/installationprocedure/index.html>`_