.. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. (c) Open Platform for NFV Project, Inc. and its contributors ******************* OPNFV Documentation ******************* ============================== Colorado Release Documentation ============================== OPNFV release documentation is structured with brief platform-level documents referencing more detailed installation instructions and descriptive documentation. Platform documentation ====================== * `OPNFV platform overview document <http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/overview/index.html>`_ * `OPNFV Installation instruction <http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/installationprocedure/index.html>`_ * `OPNFV user guide <http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/userguide/index.html>`_ Installation instructions ========================= * `Apex installation instruction <http://artifacts.opnfv.org/apex/colorado/2.0/docs/installationprocedure/index.html>`_ * `Apex release notes <http://artifacts.opnfv.org/apex/colorado/2.0/docs/releasenotes/index.html>`_ * `Compass installation instruction <http://artifacts.opnfv.org/compass4nfv/colorado/2.0/docs/installationprocedure/index.html>`_ * `Compass release notes <http://artifacts.opnfv.org/compass4nfv/colorado/2.0/docs/releasenotes/index.html>`_ * `Fuel installation instruction <http://artifacts.opnfv.org/fuel/colorado/2.0/docs/installationprocedure/index.html>`_ * `Fuel release notes <http://artifacts.opnfv.org/fuel/colorado/2.0/docs/releasenotes/index.html>`_ * `Joid installation instruction <http://artifacts.opnfv.org/joid/colorado/2.0/docs/installationprocedure/index.html>`_ * `Joid release notes <http://artifacts.opnfv.org/joid/colorado/2.0/docs/releasenotes/index.html>`_ Feature project documentation ============================= --------------- ARMband project --------------- * `Installation instruction <http://artifacts.opnfv.org/armband/colorado/2.0/docs/installationprocedure/index.html>`_ * `Release notes <http://artifacts.opnfv.org/armband/colorado/2.0/docs/releasenotes/index.html>`_ ---------------------------------------------- Copper release documentation ---------------------------------------------- * `Design documentation <http://artifacts.opnfv.org/copper/colorado/2.0/docs/design/index.html>`_ * `Installation instruction <http://artifacts.opnfv.org/copper/colorado/2.0/docs/installationprocedure/index.html>`_ * `User guide <http://artifacts.opnfv.org/copper/colorado/2.0/docs/userguide/index.html>`_ * `Release notes <http://artifacts.opnfv.org/copper/colorado/2.0/docs/releasenotes/index.html>`_ ----------------------------------------------------- Doctor features and capabilities ----------------------------------------------------- * `Project overview <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/scenarios/index.html>`_ * `User guide <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/userguide/index.html>`_ * `Release notes <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/releasenotes/index.html>`_ ---------------------------------------------------------------- Domino features and capabilities ---------------------------------------------------------------- * `User guide <http://artifacts.opnfv.org/domino/colorado/2.0/docs/userguide/index.html>`_ ------------------------------------------------- FastDataStacks feature and scenario documentation ------------------------------------------------- * `OpenDaylight integrated fd.io scenario description <http://artifacts.opnfv.org/fds/colorado/2.0/scenarios_os-odl_l2-fdio-noha/index.html>`_ ------------------------------------ IPv6 platform support and capability ------------------------------------ * `Configuration guide <http://artifacts.opnfv.org/ipv6/colorado/2.0/docs/installationprocedure/index.html>`_ * `User guide <http://artifacts.opnfv.org/ipv6/colorado/2.0/docs/userguide/index.html>`_ ----------- KVM for NFV ----------- * `Installation instruction <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/installationprocedure/index.html>`_ * `Configuration guide <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/configurationguide/index.html>`_ * `User guide <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/userguide/index.html>`_ * `Release notes <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/releasenotes/index.html>`_ -------------------------------- MOON security management for NFV -------------------------------- * `Project and Scenario overview <http://artifacts.opnfv.org/moon/colorado/docs/scenarios_os-odl_l2-moon-ha/index.html>`_ * `Installation instruction <http://artifacts.opnfv.org/moon/colorado/2.0/docs/installationprocedure/index.html>`_ * `User guide <http://artifacts.opnfv.org/moon/colorado/2.0/docs/userguide/index.html>`_ * `Release notes <http://artifacts.opnfv.org/moon/colorado/2.0/docs/releasenotes/index.html>`_ ---------------------------- Multisite datacenter project ---------------------------- * `Installation instruction <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/installationprocedure/index.html>`_ * `User guide <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/userguide/index.html>`_ * `Release notes <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/releasenotes/index.html>`_ ------------------------- Network readiness project ------------------------- * `Requirements document <http://artifacts.opnfv.org/netready/colorado/2.0/docs/requirements/index.html>`_ ---------------------- ONOS framework project ---------------------- * `Installation instruction <http://artifacts.opnfv.org/onosfw/colorado/2.0/docs/installationprocedure/index.html>`_ * `User guide <http://artifacts.opnfv.org/onosfw/colorado/2.0/docs/userguide/index.html>`_ ---------------------------- OVSNFV release documentation ---------------------------- * `OVS for NFV scenario description <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/scenarios_os-nosdn-ovs/index.html>`_ * `Configuration guide <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/configguide/index.html>`_ * `User guide <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/userguide/index.html>`_ -------------- Parser project -------------- * `Parser release documentation <http://artifacts.opnfv.org/parser/colorado/2.0/docs/parser_docs/index.html>`_ * `Installation instruction <http://artifacts.opnfv.org/parser/colorado/2.0/docs/installationprocedure/index.html>`_ * `User guide <http://artifacts.opnfv.org/parser/colorado/2.0/docs/userguide/index.html>`_ ------ Pharos ------ * `Pharos specification <http://artifacts.opnfv.org/pharos/colorado/2.0/docs/specification/index.html>`_ * `Configuration guide <http://artifacts.opnfv.org/pharos/colorado/2.0/docs/configguide/index.html>`_ ------- Promise ------- * `Requirement specification <http://artifacts.opnfv.org/promise/colorado/2.0/docs/requirements/index.html>`_ * `Installation and configuration guide <http://artifacts.opnfv.org/promise/colorado/2.0/docs/installationprocedure/index.html>`_ * `User guide <http://artifacts.opnfv.org/promise/colorado/2.0/docs/userguide/index.html>`_ ------ SDNVPN ------ * `BGPVPN scenario description <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/scenarios_os-odl_l2-bgpvpn/index.html>`_ * `User guide <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/userguide/index.html>`_ * `Release notes <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/release-notes/index.html>`_ --- SFC --- * `Design documentation <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/design/index.html>`_ * `SFC scenario description <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/scenarios_os-odl_l2-sfc-noha/index.html>`_ * `High availability SFC scenario description <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/scenarios_os-odl_l2-sfc-ha/index.html>`_ * `Installation instruction <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/installationprocedure/index.html>`_ * `User guide <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/userguide/index.html>`_ * `Release notes <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/releasenotes/index.html>`_ ------------------------------------------------ Software fast-path quality metrics documentation ------------------------------------------------ * `Release and development documentation <http://artifacts.opnfv.org/fastpathmetrics/colorado/2.0/index.html>`_ Test Project documentation ========================== ------------------------- Bottlenecks documentation ------------------------- * `Installation instruction <http://artifacts.opnfv.org/bottlenecks/colorado/2.0/docs/installationprocedure/index.html>`_ * `Release notes <http://artifacts.opnfv.org/bottlenecks/colorado/2.0/docs/releasenotes/index.html>`_ ---------------------- Functest documentation ---------------------- * `Configuration guide <http://artifacts.opnfv.org/functest/colorado/2.0/docs/configguide/index.html>`_ * `User guide <http://artifacts.opnfv.org/functest/colorado/2.0/docs/userguide/index.html>`_ * `Developer guide <http://artifacts.opnfv.org/functest/colorado/2.0/docs/devguide/index.html>`_ * `Release notes <http://artifacts.opnfv.org/functest/colorado/docs/release-notes/index.html>`_ ------------------------- vSwitchPerf documentation ------------------------- * `Release and development documentation <http://artifacts.opnfv.org/vswitchperf/colorado/2.0/docs/index.html>`_ ----------------------- Yardstick documentation ----------------------- * `User guide <http://artifacts.opnfv.org/yardstick/colorado/2.0/docs/userguide/index.html>`_ * `Release notes <http://artifacts.opnfv.org/yardstick/colorado/2.0/docs/release/index.html>`_