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
9 ==============================
10 Colorado Release Documentation
11 ==============================
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/colorado/docs/overview/index.html>`_
20 * `Installation & configuration guide <http://artifacts.opnfv.org/opnfvdocs/colorado/docs/installationprocedure/index.html>`_
21 * `The OPNFV user guide <http://artifacts.opnfv.org/opnfvdocs/colorado/docs/userguide/index.html>`_
23 Installation instructions
24 =========================
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>`_
35 Feature Project documentation
36 =============================
38 ----------------------------------------------
39 Copper, policy features, release documentation
40 ----------------------------------------------
42 * `Copper release documentation <http://artifacts.opnfv.org/copper/colorado/docs/design/index.html>`_
44 -----------------------------------------------------
45 Doctor, fault notification, features and capabilities
46 -----------------------------------------------------
48 * `The doctor overview document <http://artifacts.opnfv.org/doctor/colorado/docs/platformoverview/index.html>`_
49 * `Doctor user guide <http://artifacts.opnfv.org/doctor/colorado/docs/userguide/index.html>`_
51 ----------------------------------------------------------------
52 Domino, template distribution service, features and capabilities
53 ----------------------------------------------------------------
55 * `User guide <http://artifacts.opnfv.org/domino/colorado/docs/userguide/index.html>`_
56 * `Configuration guide <http://artifacts.opnfv.org/domino/colorado/docs/configguide/index.html>`_
58 -------------------------------------------------
59 FastDataStacks feature and scenario documentation
60 -------------------------------------------------
62 * `OpenDaylight integrated fd.io scenario description <http://artifacts.opnfv.org/fds/colorado/docs/scenarios_os-odl_l2-fdio-noha/index.html>`_
64 ------------------------------------
65 IPv6 platform support and capability
66 ------------------------------------
68 * `IPv6 user guide <http://artifacts.opnfv.org/ipv6/colorado/docs/userguide/index.html>`_
69 * `Installation of routing functions <http://artifacts.opnfv.org/ipv6/colorado/docs/reldoc/index.html>`_
75 * `Installation guide <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/installationprocedure/index.html>`_
76 * `User guide <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/userguide/index.html>`_
77 * `Configuration guide <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/configurationguide/index.html>`_
78 * `Release notes <http://artifacts.opnfv.org/kvmfornfv/colorado/docs/releasenotes/index.html>`_
80 -------------------------
81 Network readiness project
82 -------------------------
84 * `Network readiness report <http://artifacts.opnfv.org/netready/colorado/docs/requirements/index.html>`_
86 ----------------------
87 ONOS framework project
88 ----------------------
90 * `Installation guide <http://artifacts.opnfv.org/onosfw/colorado/docs/installationprocedure/index.html>`_
91 * `User guide <http://artifacts.opnfv.org/onosfw/colorado/docs/userguide/index.html>`_
93 ----------------------------
94 OVSNFV release documentation
95 ----------------------------
97 * `Configuration guide <http://artifacts.opnfv.org/ovsnfv/colorado/docs/configguide/index.html>`_
98 * `User guide <http://artifacts.opnfv.org/ovsnfv/colorado/docs/userguide/index.html>`_
99 * `Release notes <http://artifacts.opnfv.org/ovsnfv/colorado/docs/release/index.html>`_
100 * `OVS for NFV scenario description <http://artifacts.opnfv.org/ovsnfv/colorado/docs/scenarios_os-nosdn-ovs/index.html>`_
106 * `Parser release documentation <http://artifacts.opnfv.org/parser/colorado/docs/parser_docs/index.html>`_
107 * `Installation guide <http://artifacts.opnfv.org/parser/colorado/docs/installationprocedure/index.html>`_
108 * `User guide <http://artifacts.opnfv.org/parser/colorado/docs/userguide/index.html>`_
110 Test Project documentation
111 ==========================
113 ----------------------
114 Functest documentation
115 ----------------------
117 * `The Functest configuration guide <http://artifacts.opnfv.org/functest/colorado/docs/configguide/index.html>`_
118 * `The Functest user Guide <http://artifacts.opnfv.org/functest/colorado/docs/userguide/index.html>`_
119 * `A developer guide for working with functest <http://artifacts.opnfv.org/functest/colorado/docs/devguide/index.html>`_
120 * `Functest release Notes <http://artifacts.opnfv.org/functest/colorado/docs/release-notes/functest-release.html>`_
122 -----------------------
123 Yardstick documentation
124 -----------------------
126 * `The Yardstick user guide <http://artifacts.opnfv.org/yardstick/colorado/docs/userguide/index.html>`_
127 * `A code documentation and developer guide <http://artifacts.opnfv.org/yardstick/colorado/docs/apidocs/index.html>`_
128 * `Yardstick release notes <http://artifacts.opnfv.org/yardstick/colorado/docs/release/index.html>`_
130 -------------------------
131 vSwitchPerf documentation
132 -------------------------
134 * `Release and development documentation <http://artifacts.opnfv.org/vswitchperf/colorado/docs/index.html>`_
136 ------------------------------------------------
137 Software fast-path quality metrics documentation
138 ------------------------------------------------
140 * `Release and development documentation <http://artifacts.opnfv.org/fastpathmetrics/colorado/docs/index.html>`_
142 -------------------------
143 Bottlenecks documentation
144 -------------------------
146 * `Installation procedure <http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html>`_