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/2.0/docs/overview/index.html>`_
20 * `OPNFV Installation instruction <http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/installationprocedure/index.html>`_
21 * `OPNFV user guide <http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/userguide/index.html>`_
23 Installation instructions
24 =========================
26 * `Apex installation instruction <http://artifacts.opnfv.org/apex/colorado/2.0/docs/installationprocedure/index.html>`_
27 * `Apex release notes <http://artifacts.opnfv.org/apex/colorado/2.0/docs/releasenotes/index.html>`_
28 * `Compass installation instruction <http://artifacts.opnfv.org/compass4nfv/colorado/2.0/docs/installationprocedure/index.html>`_
29 * `Compass release notes <http://artifacts.opnfv.org/compass4nfv/colorado/2.0/docs/releasenotes/index.html>`_
30 * `Fuel installation instruction <http://artifacts.opnfv.org/fuel/colorado/2.0/docs/installationprocedure/index.html>`_
31 * `Fuel release notes <http://artifacts.opnfv.org/fuel/colorado/2.0/docs/releasenotes/index.html>`_
32 * `Joid installation instruction <http://artifacts.opnfv.org/joid/colorado/2.0/docs/installationprocedure/index.html>`_
33 * `Joid release notes <http://artifacts.opnfv.org/joid/colorado/2.0/docs/releasenotes/index.html>`_
35 Feature project documentation
36 =============================
42 * `Installation instruction <http://artifacts.opnfv.org/armband/colorado/2.0/docs/installationprocedure/index.html>`_
43 * `Release notes <http://artifacts.opnfv.org/armband/colorado/2.0/docs/releasenotes/index.html>`_
45 ----------------------------------------------
46 Copper release documentation
47 ----------------------------------------------
49 * `Design documentation <http://artifacts.opnfv.org/copper/colorado/2.0/docs/design/index.html>`_
50 * `Installation instruction <http://artifacts.opnfv.org/copper/colorado/2.0/docs/installationprocedure/index.html>`_
51 * `User guide <http://artifacts.opnfv.org/copper/colorado/2.0/docs/userguide/index.html>`_
52 * `Release notes <http://artifacts.opnfv.org/copper/colorado/2.0/docs/releasenotes/index.html>`_
54 -----------------------------------------------------
55 Doctor features and capabilities
56 -----------------------------------------------------
58 * `Project overview <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/scenarios/index.html>`_
59 * `User guide <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/userguide/index.html>`_
60 * `Release notes <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/releasenotes/index.html>`_
62 ----------------------------------------------------------------
63 Domino features and capabilities
64 ----------------------------------------------------------------
66 * `User guide <http://artifacts.opnfv.org/domino/colorado/2.0/docs/userguide/index.html>`_
68 -------------------------------------------------
69 FastDataStacks feature and scenario documentation
70 -------------------------------------------------
72 * `OpenDaylight integrated fd.io scenario description <http://artifacts.opnfv.org/fds/colorado/2.0/scenarios_os-odl_l2-fdio-noha/index.html>`_
74 ------------------------------------
75 IPv6 platform support and capability
76 ------------------------------------
78 * `Configuration guide <http://artifacts.opnfv.org/ipv6/colorado/2.0/docs/installationprocedure/index.html>`_
79 * `User guide <http://artifacts.opnfv.org/ipv6/colorado/2.0/docs/userguide/index.html>`_
85 * `Installation instruction <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/installationprocedure/index.html>`_
86 * `Configuration guide <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/configurationguide/index.html>`_
87 * `User guide <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/userguide/index.html>`_
88 * `Release notes <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/releasenotes/index.html>`_
90 --------------------------------
91 MOON security management for NFV
92 --------------------------------
94 * `Project and Scenario overview <http://artifacts.opnfv.org/moon/colorado/docs/scenarios_os-odl_l2-moon-ha/index.html>`_
95 * `Installation instruction <http://artifacts.opnfv.org/moon/colorado/2.0/docs/installationprocedure/index.html>`_
96 * `User guide <http://artifacts.opnfv.org/moon/colorado/2.0/docs/userguide/index.html>`_
97 * `Release notes <http://artifacts.opnfv.org/moon/colorado/2.0/docs/releasenotes/index.html>`_
99 ----------------------------
100 Multisite datacenter project
101 ----------------------------
103 * `Installation instruction <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/installationprocedure/index.html>`_
104 * `User guide <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/userguide/index.html>`_
105 * `Release notes <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/releasenotes/index.html>`_
107 -------------------------
108 Network readiness project
109 -------------------------
111 * `Requirements document <http://artifacts.opnfv.org/netready/colorado/2.0/docs/requirements/index.html>`_
113 ----------------------
114 ONOS framework project
115 ----------------------
117 * `Installation instruction <http://artifacts.opnfv.org/onosfw/colorado/2.0/docs/installationprocedure/index.html>`_
118 * `User guide <http://artifacts.opnfv.org/onosfw/colorado/2.0/docs/userguide/index.html>`_
120 ----------------------------
121 OVSNFV release documentation
122 ----------------------------
124 * `OVS for NFV scenario description <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/scenarios_os-nosdn-ovs/index.html>`_
125 * `Configuration guide <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/configguide/index.html>`_
126 * `User guide <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/userguide/index.html>`_
132 * `Parser release documentation <http://artifacts.opnfv.org/parser/colorado/2.0/docs/parser_docs/index.html>`_
133 * `Installation instruction <http://artifacts.opnfv.org/parser/colorado/2.0/docs/installationprocedure/index.html>`_
134 * `User guide <http://artifacts.opnfv.org/parser/colorado/2.0/docs/userguide/index.html>`_
140 * `Pharos specification <http://artifacts.opnfv.org/pharos/colorado/2.0/docs/specification/index.html>`_
141 * `Configuration guide <http://artifacts.opnfv.org/pharos/colorado/2.0/docs/configguide/index.html>`_
147 * `Requirement specification <http://artifacts.opnfv.org/promise/colorado/2.0/docs/requirements/index.html>`_
148 * `Installation and configuration guide <http://artifacts.opnfv.org/promise/colorado/2.0/docs/installationprocedure/index.html>`_
149 * `User guide <http://artifacts.opnfv.org/promise/colorado/2.0/docs/userguide/index.html>`_
155 * `BGPVPN scenario description <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/scenarios_os-odl_l2-bgpvpn/index.html>`_
156 * `User guide <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/userguide/index.html>`_
157 * `Release notes <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/release-notes/index.html>`_
163 * `Design documentation <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/design/index.html>`_
164 * `SFC scenario description <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/scenarios_os-odl_l2-sfc-noha/index.html>`_
165 * `High availability SFC scenario description <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/scenarios_os-odl_l2-sfc-ha/index.html>`_
166 * `Installation instruction <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/installationprocedure/index.html>`_
167 * `User guide <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/userguide/index.html>`_
168 * `Release notes <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/releasenotes/index.html>`_
170 ------------------------------------------------
171 Software fast-path quality metrics documentation
172 ------------------------------------------------
174 * `Release and development documentation <http://artifacts.opnfv.org/fastpathmetrics/colorado/2.0/index.html>`_
177 Test Project documentation
178 ==========================
180 -------------------------
181 Bottlenecks documentation
182 -------------------------
184 * `Installation instruction <http://artifacts.opnfv.org/bottlenecks/colorado/2.0/docs/installationprocedure/index.html>`_
185 * `Release notes <http://artifacts.opnfv.org/bottlenecks/colorado/2.0/docs/releasenotes/index.html>`_
187 ----------------------
188 Functest documentation
189 ----------------------
191 * `Configuration guide <http://artifacts.opnfv.org/functest/colorado/2.0/docs/configguide/index.html>`_
192 * `User guide <http://artifacts.opnfv.org/functest/colorado/2.0/docs/userguide/index.html>`_
193 * `Developer guide <http://artifacts.opnfv.org/functest/colorado/2.0/docs/devguide/index.html>`_
194 * `Release notes <http://artifacts.opnfv.org/functest/colorado/docs/release-notes/index.html>`_
196 -------------------------
197 vSwitchPerf documentation
198 -------------------------
200 * `Release and development documentation <http://artifacts.opnfv.org/vswitchperf/colorado/2.0/docs/index.html>`_
202 -----------------------
203 Yardstick documentation
204 -----------------------
206 * `User guide <http://artifacts.opnfv.org/yardstick/colorado/2.0/docs/userguide/index.html>`_
207 * `Release notes <http://artifacts.opnfv.org/yardstick/colorado/2.0/docs/release/index.html>`_