summaryrefslogtreecommitdiffstats
path: root/docs/userguide/userguide.introduction.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/userguide/userguide.introduction.rst')
-rw-r--r--docs/userguide/userguide.introduction.rst58
1 files changed, 58 insertions, 0 deletions
diff --git a/docs/userguide/userguide.introduction.rst b/docs/userguide/userguide.introduction.rst
new file mode 100644
index 000000000..1ab6b8442
--- /dev/null
+++ b/docs/userguide/userguide.introduction.rst
@@ -0,0 +1,58 @@
+.. 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 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:
+
+- `IPv6 user guide <http://artifacts.opnfv.org/ipv6/colorado/docs/userguide/index.html>`_
+- `Multisite user guide <http://artifacts.opnfv.org/multisite/colorado/docs/userguide/index.html>`_
+- `Domino user guide <http://artifacts.opnfv.org/domino/colorado/docs/userguide.index.html>`_
+- `Moon user guide <http://artifacts.opnfv.org/moon/colorado/docs/userguide.html>`_
+- `SDNVPN user guide <http://artifacts.opnfv.org/sdnvpn/colorado/docs/userguide/index.html>`_