Table of Contents
OPNFV documentation library
This wiki will provide a guideline for document editorial leading up to the next release, and further provide a reference for the eventual publication of release related documentation.
Please add your project information below and the links to the documents you intend to publish for your project, the opnfvdocs team will help by reviewing your documents and setting consistent editorial structure across our documentation for OPNFV.
Release documents to be published
opnfvdocs documentation
- OPNFV overview document: http://artifacts.opnfv.org/opnfvdocs/docs/platformoverview/index.html PDF
- OPNFV configuration guide: http://artifacts.opnfv.org/opnfvdocs/docs/configguide/index.html PDF
- OPNFV user guide: http://artifacts.opnfv.org/opnfvdocs/docs/userguide/index.html PDF
OPNFV feature project documentation
Feature documentation provides descriptions of the features, architecture and capabilities the OPNFV community has been developing in the next release. Here you will find details on how to use, deploy or develop features delivered in OPNFV.
OPNFV Doctor documentation
OPNFV High Availability Documentation
OPNFV IPv6 documentation
OPNFV ONOSFW documentation
OPNFV Promise documentation
OPNFV SFC documentation
Open vSwitch for NFV documentation
OPNFV testing project documentation
Feature documentation provides descriptions of the features, architecture and capabilities the OPNFV community has been developing in the next release. Here you will find details on how to use, deploy or develop features delivered in OPNFV.
OPNFV FUNCTEST documentation
OPNFV YARDSTICK documentation
OPNFV vSwitchPerf documentation
OPNFV test results documentation
Every scenario and feature in OPNFV has undergone a series of tests and evaluations prior to our release. The test results documentation provides detailed test results for each test tool executed and scenario prepared for deployment.
FuncTest Results
YardStick Results
Platform and deployment documentation
These documents relate to the installation and deployment of the OPNFV Platform.
- OPNFV generic installer requirements: http://artifacts.opnfv.org/genesisreq/docs/requirements/index.html PDF
OPNFV Apex documentation
OPNFV Apex detailed installation instructions: http://artifacts.opnfv.org/apex/docs/installation-instructions/index.html
OPNFV Apex release notes: http://artifacts.opnfv.org/apex/docs/release-notes/index.html
OPNFV Compass documentation
OPNFV Compass detailed installation instructions: http://artifacts.opnfv.org/compass4nfv/docs/Brahmaputra_installation-instructions/index.html
OPNFV Compass release notes: http://artifacts.opnfv.org/compass4nfv/docs/Brahmaputra_release-notes/index.html
OPNFV Compass user guide: http://artifacts.opnfv.org/compass4nfv/docs/how-to-use-compass4nfv/index.html
OPNFV Fuel documentation
OPNFV Fuel build instructions: http://artifacts.opnfv.org/fuel/docs/build-instruction.html
OPNFV Fuel detailed installation instructions: http://artifacts.opnfv.org/fuel/docs/installation-instruction.html
OPNFV Fuel release notes: http://artifacts.opnfv.org/fuel/docs/release-notes.html
OPNFV JOID documentation
OPNFV JOID configuration guide: http://artifacts.opnfv.org/joid/docs/configguide/index.html
OPNFV JOID user guide: http://artifacts.opnfv.org/joid/docs/userguide/index.html
OPNFV JOID release notes: http://artifacts.opnfv.org/joid/docs/release-notes/release-notes.html
