summaryrefslogtreecommitdiffstats
path: root/docs/release/userguide.introduction.rst
diff options
context:
space:
mode:
authorSofia Wallin <sofia.wallin@ericsson.com>2016-11-23 14:49:15 +0100
committerSofia Wallin <sofia.wallin@ericsson.com>2016-11-24 16:21:30 +0100
commitd438301ca7244e66d5082312e3e84fcfb219f11b (patch)
tree858fc757706d451ac52e17ba75e4c0d7b4a2ef6d /docs/release/userguide.introduction.rst
parent978b48ae0117c80d3dc7cced5e09e08e9efe929b (diff)
Adjusted the docs repo structure for D release work
Change-Id: I9befe06c424c726e17d754bc480413b2430549ba Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
Diffstat (limited to 'docs/release/userguide.introduction.rst')
-rw-r--r--docs/release/userguide.introduction.rst85
1 files changed, 85 insertions, 0 deletions
diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst
new file mode 100644
index 000000000..48112e78e
--- /dev/null
+++ b/docs/release/userguide.introduction.rst
@@ -0,0 +1,85 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Sofia Wallin (sofia.wallin@ericssion.com)
+
+========
+Abstract
+========
+
+OPNFV is a collaborative project aimed at providing a variety of virtualization
+deployments intended to host applications serving the networking and carrier
+industry. This document provides guidance and instructions for using platform
+features designed to support these applications, made available in the OPNFV
+Colorado release.
+
+This document is not intended to replace or replicate documentation from other
+open source projects such as OpenStack or OpenDaylight, rather highlight the
+features and capabilities delivered through the OPNFV project.
+
+============
+Introduction
+============
+
+OPNFV provides a suite of scenarios, infrastructure depoyment options, which
+are able to be installed to host virtualized network functions (VNFs).
+This guide intends to help users of the platform leverage the features and
+capabilities delivered by the OPNFV project in support of these applications.
+
+OPNFV Continuous Integration builds, deploys and tests combinations of virtual
+infrastructure components in what are defined as scenarios. A scenario may
+include components such as OpenStack, OpenDaylight, OVS, KVM etc. where each
+scenario will include different source components or configurations. Scenarios
+are designed to enable specific features and capabilities in the platform that
+can be leveraged by the OPNFV user community.
+
+================
+Feature Overview
+================
+
+The following links outline the feature deliveries from the participant OPNFV
+projects in the Colorado release. Each of the participating projects provides
+detailed descriptions about the delivered features. Including use cases,
+implementation and configuration specifics on a per OPNFV project basis.
+
+The following are Configuration Guides and User Guides and assume that the reader has already some
+information about a given projects specifics and deliverables. These guides
+are intended to be used following the installation of a given OPNFV installer
+to allow a user to deploy and implement feature delivered by OPNFV.
+
+If you are unsure about the specifics of a given project, please refer to the
+OPNFV projects home page, found on http://wiki.opnfv.org, for specific details.
+
+You can find project specific usage and configuration information below:
+
+Feature Configuration Guides
+============================
+
+- `Armband configuration guide <http://artifacts.opnfv.org/armband/colorado/2.0/docs/installationprocedure/index.html>`_
+- `Copper configuration guide <http://artifacts.opnfv.org/copper/colorado/2.0/docs/installationprocedure/index.html>`_
+- `Doctor configuration guide <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/installationprocedure/index.html>`_
+- `IPv6 configuration guide <http://artifacts.opnfv.org/ipv6/colorado/2.0/docs/installationprocedure/index.html>`_
+- `KVMforNFV configuration guide <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/installationprocedure/index.html>`_
+- `Moon configuration guide <http://artifacts.opnfv.org/moon/colorado/2.0/docs/installationprocedure/index.html>`_
+- `Multisite configuration guide <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/installationprocedure/index.html>`_
+- `ONOSFW configuration guide <http://artifacts.opnfv.org/onosfw/colorado/2.0/installationprocedure/index.html>`_
+- `OVSNFV configuration guide <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/configguide/index.html>`_
+- `Promise configuration guide <http://artifacts.opnfv.org/promise/colorado/2.0/docs/installationprocedure/index.html>`_
+- `SFC configuration guide <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/installationprocedure/index.html>`_
+
+
+Feature User Guides
+===================
+
+- `Copper user guide <http://artifacts.opnfv.org/copper/colorado/2.0/docs/userguide/index.html>`_
+- `Doctor user guide <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/userguide/index.html>`_
+- `Domino user guide <http://artifacts.opnfv.org/domino/colorado/2.0/docs/userguide/index.html>`_
+- `IPv6 user guide <http://artifacts.opnfv.org/ipv6/colorado/2.0/docs/userguide/index.html>`_
+- `KVMforNFV user guide <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/userguide/index.html>`_
+- `Moon user guide <http://artifacts.opnfv.org/moon/colorado/2.0/docs/userguide/index.html>`_
+- `Multisite user guide <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/userguide/index.html>`_
+- `ONOSFW user guide <http://artifacts.opnfv.org/onosfw/colorado/2.0/docs/userguide/index.html>`_
+- `OVSNFV user guide <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/userguide/index.html>`_
+- `Parser user guide <http://artifacts.opnfv.org/parser/colorado/2.0/docs/userguide/index.html>`_
+- `Promise user guide <http://artifacts.opnfv.org/promise/colorado/2.0/docs/userguide/index.html>`_
+- `SDNVPN user guide <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/userguide/index.html>`_
+- `SFC user guide <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/userguide/index.html>`_